Wondering what’s next for npm?Check out our public roadmap! »

slp-cli-wallet

3.0.1 • Public • Published

Warning: This is an experimental 'hacker-friendly' wallet. It's intended for use by software developers. It has been tested only for the most common use-cases. It has been known to burn SLP tokens. Do not use this wallet for tokens with value.

slp-cli-wallet

This is an npm library and Bitcoin Cash (BCH) wallet that runs on the command line. Add this library to your app to instantly give it the ability to transact on the BCH network! New to Bitcoin Cash? Find educational resources on the FullStack.cash Documenation page.

This project has the following goals:

  • Create a code base for a wallet that is easily forkable and extensible by JavaScript developers.
  • Provide a high-level abstraction to make it easy for new developers to add BCH and SLP wallet functionality into their apps.

If you want a wallet with a graphical user interface, check out wallet.FullStack.cash. For a front-end friendly package, check out minimal-slp-wallet-web. Bitcoin Cash functionality is implemented in all wallets with bch-js, provided by FullStack.cash. The command line interface for this project is built with oclif.

Also, be sure to check out the design decisions and trade-offs that went into the creation of this project in the docs directory

NPM Usage

The npm library can be included in your own app to instantly give it the ability to send and receive BCH transactions, including SLP tokens. Here is an example of how to include it in your own app. This example will generate a new HD wallet.

// Instantiate the Create Wallet class from this library.
const CreateWallet = require('slp-cli-wallet/src/commands/create-wallet')
const createWallet = new CreateWallet()

const walletFile = './wallet.json'

async function makeNewWallet() {
  const wallet = await createWallet.createWallet(walletFile)

  console.log(`wallet: ${JSON.stringify(wallet,null,2)}`)
}
makeNewWallet()

Install Dev Environment

While this npm library can be used globally, the intended audience is developers familiar with the usage of npm and git. Here is how to set up your own developer environment:

  • Clone this repo with git clone.
  • Install npm dependencies with npm install
  • Execute the commands like this: ./bin/run help

Running the wallet this way, you can edit the behavior of the wallet by making changes to the code in the src/commands directory.

Command Line Usage

$ npm install -g slp-cli-wallet
$ slp-cli-wallet COMMAND
running command...
$ slp-cli-wallet (-v|--version|version)
slp-cli-wallet/3.0.1 linux-x64 node-v14.15.0
$ slp-cli-wallet --help [COMMAND]
USAGE
  $ slp-cli-wallet COMMAND
...

Commands

slp-cli-wallet burn-tokens

Burn SLP tokens.

USAGE
  $ slp-cli-wallet burn-tokens

OPTIONS
  -n, --name=name        Name of wallet
  -q, --qty=qty
  -t, --tokenId=tokenId  Token ID

See code: src/commands/burn-tokens.js

slp-cli-wallet create-wallet

Generate a new HD Wallet.

USAGE
  $ slp-cli-wallet create-wallet

OPTIONS
  -d, --description=description  Description of the wallet
  -n, --name=name                Name of wallet
  -t, --testnet                  Create a testnet wallet

See code: src/commands/create-wallet.js

slp-cli-wallet derivation

Display or set the derivation path used by the wallet.

USAGE
  $ slp-cli-wallet derivation

OPTIONS
  -n, --name=name  name to print
  -s, --save=save  save a new derivation path

DESCRIPTION
  This command is used to display the derivation path used by the wallet. The -s
  flag can be used to save a new derivation path.

  Common derivation paths 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

  Wallets use the 245 derivation path by default.

See code: src/commands/derivation.js

slp-cli-wallet get-address

Generate a new address to recieve BCH.

USAGE
  $ slp-cli-wallet get-address

OPTIONS
  -n, --name=name  Name of wallet
  -s, --slp        Generate a simpledger: token address
  -t, --testnet    Create a testnet wallet

See code: src/commands/get-address.js

slp-cli-wallet get-key

Generate a new private/public key pair.

USAGE
  $ slp-cli-wallet get-key

OPTIONS
  -n, --name=name  Name of wallet

See code: src/commands/get-key.js

slp-cli-wallet hello

Example command from oclif

USAGE
  $ slp-cli-wallet hello

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Leaving it here for future reference in development.

See code: src/commands/hello.js

slp-cli-wallet help [COMMAND]

display help for slp-cli-wallet

USAGE
  $ slp-cli-wallet help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

slp-cli-wallet list-wallets

List existing wallets.

USAGE
  $ slp-cli-wallet list-wallets

See code: src/commands/list-wallets.js

slp-cli-wallet remove-wallet

Remove an existing wallet.

USAGE
  $ slp-cli-wallet remove-wallet

OPTIONS
  -n, --name=name  Name of wallet

See code: src/commands/remove-wallet.js

slp-cli-wallet scan-funds

Scans first 20 addresses of each derivation path for

USAGE
  $ slp-cli-wallet scan-funds

OPTIONS
  -m, --mnemonic=mnemonic  mnemonic phrase to generate addresses, wrapped in quotes

DESCRIPTION
  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.

  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/scan-funds.js

slp-cli-wallet send

Send an amount of BCH

USAGE
  $ slp-cli-wallet send

OPTIONS
  -a, --sendAddr=sendAddr  Cash address to send to
  -b, --bch=bch            Quantity in BCH
  -n, --name=name          Name of wallet

See code: src/commands/send.js

slp-cli-wallet send-all

Send all BCH in a wallet to another address. Degrades Privacy

USAGE
  $ slp-cli-wallet send-all

OPTIONS
  -a, --sendAddr=sendAddr  Cash address to send to
  -i, --ignoreTokens       Ignore and burn tokens
  -n, --name=name          Name of wallet

DESCRIPTION
  Send all BCH in a wallet to another address.

  This method has a negative impact on privacy by linking all addresses in a
  wallet. If privacy of a concern, CoinJoin should be used.
  This is a good article describing the privacy concerns:
  https://bit.ly/2TnhdVc

See code: src/commands/send-all.js

slp-cli-wallet send-tokens

Send SLP tokens.

USAGE
  $ slp-cli-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

slp-cli-wallet sign-message

Sign message

USAGE
  $ slp-cli-wallet sign-message

OPTIONS
  -i, --sendAddrIndex=sendAddrIndex  Address index
  -m, --message=message              Message to sign. (Wrap in quotes)
  -n, --name=name                    Name of wallet

See code: src/commands/sign-message.js

slp-cli-wallet sweep

Sweep a private key

USAGE
  $ slp-cli-wallet sweep

OPTIONS
  -a, --address=address  Address to sweep funds to.
  -b, --balanceOnly      Balance only, no claim.
  -i, --tokenId=tokenId  The token ID to sweep when there are multiple tokens
  -t, --testnet          Testnet
  -w, --wif=wif          WIF private key

DESCRIPTION
  ...
  Sweeps a private key in WIF format.
  Supports SLP token sweeping, but only one token class at a time. It will throw
  an error if a WIF contains more than one class of token.

See code: src/commands/sweep.js

slp-cli-wallet update-balances

Poll the network and update the balances of the wallet.

USAGE
  $ slp-cli-wallet update-balances

OPTIONS
  -i, --ignoreTokens  Ignore and burn tokens
  -n, --name=name     Name of wallet

See code: src/commands/update-balances.js

Keywords

Install

npm i slp-cli-wallet

DownloadsWeekly Downloads

48

Version

3.0.1

License

MIT

Unpacked Size

141 kB

Total Files

25

Last publish

Collaborators

  • avatar