This is a command-line (CLI) app for working with the Bitcoin Cash (BCH) blockchain, and SLP tokens.
This app connects to a ipfs-bch-wallet-service over IPFS, using the ipfs-coord library. This app uses the oclif CLI framework.
This app is intended for developers who want to work with the BCH blockchain. It's an integral part of the Cash Stack.
git clonethis repository.npm installdependencies../bin/run helpto see a list of available commands../bin/run wallet-createto create a wallet. Wallet files are stored in the.walletsdirectory.
By default, this app uses free-bch.fullstack.cash as its back end service for working with the BCH blockchain. That back-end service is simply a copy of ipfs-bch-wallet-consumer. By running your own copy of ipfs-bch-wallet-consumer, you can have greater reliability and can use this app to switch between different global back ends. If free-bch.fullstack.cash goes down for some reason, running your own instance of ipfs-bch-wallet-consumer allows you to easily switch to any functional back end on the internet.
Switch to a local instance of ipfs-bch-wallet-consumer:
./bin/run conf -k restURL -v http:https://localhost:5005./bin/run conf -k interface -v consumer-api
Switch back to free-bch.fullstack.cash:
./bin/run conf -k restURL -v https://free-bch.fullstack.cash
Switch to using the web2 infrastructure with FullStack.cash:
./bin/run conf -k restURL -v http:https://api.fullstack.cash/v5/./bin/run conf -k interface -v rest-api
Explore the other configuration settings:
./bin/run conf
- js-ipfs - The IPFS node software.
- ipfs-coord - IPFS subnet coordination library.
- bch-js - BCH toolkit.
- oclif - CLI framework.
- conf-cli - oclif config plugin.
$ npm install
$ ./bin/run [COMMAND] --help
$ ./bin/run COMMANDIn the commands below, replace psf-bch-wallet with ./bin/run.
psf-bch-wallet conf [KEY] [VALUE]psf-bch-wallet help [COMMAND]psf-bch-wallet ipfs-peerspsf-bch-wallet ipfs-relayspsf-bch-wallet ipfs-statuspsf-bch-wallet msg-checkpsf-bch-wallet msg-readpsf-bch-wallet msg-sendpsf-bch-wallet msg-signpsf-bch-wallet msg-verifypsf-bch-wallet p2wdb-readpsf-bch-wallet p2wdb-writepsf-bch-wallet send-bchpsf-bch-wallet send-tokenspsf-bch-wallet token-burnpsf-bch-wallet token-create-fungiblepsf-bch-wallet token-create-grouppsf-bch-wallet token-create-nftpsf-bch-wallet token-mintpsf-bch-wallet wallet-addrspsf-bch-wallet wallet-balancespsf-bch-wallet wallet-createpsf-bch-wallet wallet-listpsf-bch-wallet wallet-removepsf-bch-wallet wallet-scanpsf-bch-wallet wallet-servicepsf-bch-wallet wallet-service-testpsf-bch-wallet wallet-sweep
manage configuration
USAGE
$ psf-bch-wallet conf [KEY] [VALUE]
ARGUMENTS
KEY key of the config
VALUE value of the config
OPTIONS
-d, --cwd=cwd config file location
-d, --delete delete?
-h, --help show CLI help
-k, --key=key key of the config
-n, --name=name config file name
-p, --project=project project name
-v, --value=value value of the config
See code: conf-cli
display help for psf-bch-wallet
USAGE
$ psf-bch-wallet help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
Query the state of subnet peers
USAGE
$ psf-bch-wallet ipfs-peers
OPTIONS
-a, --all Display all data about peers
See code: src/commands/ipfs-peers.js
Query the state of circuit relays
USAGE
$ psf-bch-wallet ipfs-relays
See code: src/commands/ipfs-relays.js
Query the state of the IPFS node
USAGE
$ psf-bch-wallet ipfs-status
See code: src/commands/ipfs-status.js
Check signed messages
USAGE
$ psf-bch-wallet msg-check
OPTIONS
-n, --name=name Name of wallet
See code: src/commands/msg-check.js
Read signed messages
USAGE
$ psf-bch-wallet msg-read
OPTIONS
-n, --name=name Name of wallet
-t, --txid=txid Transaction ID
See code: src/commands/msg-read.js
Send encrypted messages
USAGE
$ psf-bch-wallet msg-send
OPTIONS
-b, --bchAddress=bchAddress BCH Address
-m, --message=message Message to send
-n, --name=name Name of wallet
-s, --subject=subject Message Subject
See code: src/commands/msg-send.js
Cryptographically sign a message.
USAGE
$ psf-bch-wallet msg-sign
OPTIONS
-m, --msg=msg Cleartext message to sign
-n, --name=name Name of wallet
DESCRIPTION
Generate a signature from a clear-text message and the private key of your wallet.
The system verifying the signature will also need the BCH address of the walllet.
See code: src/commands/msg-sign.js
Verify a signed message
USAGE
$ psf-bch-wallet msg-verify
OPTIONS
-b, --bchAddr=bchAddr BCH address of signer.
-m, --msg=msg Cleartext message used to generate the signature.
-s, --sig=sig Signature to verify.
DESCRIPTION
Verify the authenticity of a signed message.
See code: src/commands/msg-verify.js
Read an entry from the P2WDB
USAGE
$ psf-bch-wallet p2wdb-read
OPTIONS
-h, --hash=hash Hash CID representing P2WDB entry
See code: src/commands/p2wdb-read.js
Write an entry to the pay-to-write database (P2WDB)
USAGE
$ psf-bch-wallet p2wdb-write
OPTIONS
-a, --appId=appId appId string to categorize data
-d, --data=data String of data to write to the P2WDB
-n, --name=name Name of wallet
DESCRIPTION
In order to execute this command, the wallet must contain some BCH and some PSF
token, in order to pay for the write to the P2WDB.
See code: src/commands/p2wdb-write.js
Send BCH
USAGE
$ psf-bch-wallet send-bch
OPTIONS
-a, --sendAddr=sendAddr Cash address to send to
-n, --name=name Name of wallet
-q, --qty=qty Quantity in BCH
See code: src/commands/send-bch.js
Send Tokens
USAGE
$ psf-bch-wallet send-tokens
OPTIONS
-a, --sendAddr=sendAddr Cash or SimpleLedger address to send to
-n, --name=name Name of wallet
-q, --qty=qty
-t, --tokenId=tokenId Token ID
See code: src/commands/send-tokens.js
Burn a specific quantity of SLP tokens.
USAGE
$ psf-bch-wallet token-burn
OPTIONS
-n, --name=name Name of wallet
-q, --qty=qty Quantity of tokens to burn. If quantity is 0, all tokens will be burned.
-t, --tokenId=tokenId tokenId of token to burn
See code: src/commands/token-burn.js
Create a new SLP Type1 fugible token.
USAGE
$ psf-bch-wallet token-create-fungible
OPTIONS
-b, --baton (optional) create a minting baton
-d, --decimals=decimals Decimals used by the token
-h, --hash=hash (optional) Document hash of the group
-m, --tokenName=tokenName Name of token
-n, --walletName=walletName Name of wallet to pay for transaction
-q, --qty=qty Quantity of tokens to create
-t, --ticker=ticker Ticker of the group
-u, --url=url (optional) Document URL of the group
DESCRIPTION
Creating a minting baton is optional. If a baton address is not specified, then the
baton is burned and makes the it a 'fixed supply' token.
See code: src/commands/token-create-fungible.js
Create a new SLP Group token.
USAGE
$ psf-bch-wallet token-create-group
OPTIONS
-h, --hash=hash (optional) Document hash of the group
-m, --tokenName=tokenName Name of token
-n, --walletName=walletName Name of wallet to pay for transaction
-q, --qty=qty (optional) Quantity of tokens to create. Defaults to 1
-t, --ticker=ticker Ticker of the group
-u, --url=url (optional) Document URL of the group
DESCRIPTION
Group tokens are used to generate NFTs. Read more about the relationship:
https://github.com/Permissionless-Software-Foundation/bch-js-examples/tree/master/bch/applications/slp/nft
See code: src/commands/token-create-group.js
Create a new SLP Group token.
USAGE
$ psf-bch-wallet token-create-nft
OPTIONS
-h, --hash=hash (optional) Document hash of the group
-i, --tokenId=tokenId Token ID of Group token to burn, to generate the NFT
-m, --tokenName=tokenName Name of token
-n, --walletName=walletName Name of wallet to pay for transaction
-t, --ticker=ticker Ticker of the group
-u, --url=url (optional) Document URL of the group
DESCRIPTION
Group tokens are used to generate NFTs. Read more about the relationship:
https://github.com/Permissionless-Software-Foundation/bch-js-examples/tree/master/bch/applications/slp/nft
See code: src/commands/token-create-nft.js
Mint new Fungible (Type 1) or Group tokens
USAGE
$ psf-bch-wallet token-mint
OPTIONS
-n, --name=name Name of wallet to pay for transaction
-q, --qty=qty Quantity of tokens to create
-r, --receiver=receiver (optional) Receiver of new baton. Defaults to same wallet. null burns baton.
-t, --tokenId=tokenId Token ID
DESCRIPTION
If the wallet contains a minting baton from creating a Fungible or Group token,
this command can be used to mint new tokens into existence.
The '-r' flag is optional. By default the minting baton will be sent back to the
origionating wallet. A different address can be specified by the -r flag. Passing
a value of 'null' will burn the minting baton, removing the ability to mint
new tokens.
See code: src/commands/token-mint.js
List the different addresses for a wallet.
USAGE
$ psf-bch-wallet wallet-addrs
OPTIONS
-n, --name=name Name of wallet
See code: src/commands/wallet-addrs.js
Display the balances of the wallet
USAGE
$ psf-bch-wallet wallet-balances
OPTIONS
-n, --name=name Name of wallet
-v, --verbose Show verbose UTXO information
See code: src/commands/wallet-balances.js
Generate a new HD Wallet.
USAGE
$ psf-bch-wallet wallet-create
OPTIONS
-d, --description=description Description of the wallet
-n, --name=name Name of wallet
See code: src/commands/wallet-create.js
List existing wallets.
USAGE
$ psf-bch-wallet wallet-list
See code: src/commands/wallet-list.js
Remove an existing wallet.
USAGE
$ psf-bch-wallet wallet-remove
OPTIONS
-n, --name=name Name of wallet
See code: src/commands/wallet-remove.js
Scan different derivation paths of a 12 word mnemonic for tx history.
USAGE
$ psf-bch-wallet wallet-scan
OPTIONS
-m, --mnemonic=mnemonic mnemonic phrase to generate addresses, wrapped in quotes
DESCRIPTION
Scans the first 20 addresses of each derivation path for
history and balance of the given mnemonic. If any of them had a history, scans
the next 20, until it reaches a batch of 20 addresses with no history. The -m
flag is used to pass it a mnemonic phrase. Be sure to enclose the words in
quotes.
This command is handy for people who maintain multiple wallets. This allows easy
scanning to see if a mnemonic holds any funds on any of the commonly used
derivation paths.
Derivation pathes used:
145 - BIP44 standard path for Bitcoin Cash
245 - BIP44 standard path for SLP tokens
0 - Used by common software like the Bitcoin.com wallet and Honest.cash
See code: src/commands/wallet-scan.js
List and/or select a wallet service provider.
USAGE
$ psf-bch-wallet wallet-service
OPTIONS
-s, --select=select Switch to a given IPFS ID for wallet service.
See code: src/commands/wallet-service.js
Run end-to-end tests on the selected wallet service.
USAGE
$ psf-bch-wallet wallet-service-test
DESCRIPTION
This command will run a series of end-to-end (e2e) tests on a current global
back end selected with the 'wallet-service' command. It will test that the
selected service if fully function, and this app can adaquately communicate
with that service.
See code: src/commands/wallet-service-test.js
Sweep funds from one wallet into another
USAGE
$ psf-bch-wallet wallet-sweep
OPTIONS
-d, --derivation=derivation Derivation path. Will default to 245 if not specified. Common values are 245, 145, and 0
-m, --mnemonic=mnemonic 12-word mnemonic phrase, wrapped in quotes
-n, --name=name name of receiving wallet
-w, --wif=wif WIF private key controlling funds of a single address
DESCRIPTION
Sweep funds from a single private key (WIF) or a whole HD wallet (mnemonic)
into another wallet. Works for both BCH and tokens.
If the target wallet does not have enough funds to pay transaction fees, fees
are paid from the receiving wallet. In the case of a mnemonic, a derivation path
can be specified.
Either a WIF or a mnemonic must be specified.
See code: src/commands/wallet-sweep.js