benchmark-bch

This repository is a fork slp-cli-wallet. It is a command-line application used to run benchmark tests against different configurations of the 'Cash Stack'. Additional documentation is available in the docs directory.

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/1.5.0 linux-x64 node-v10.16.3
$ 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
  -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 fund-test-wallet`

Prepares wallet to run benchmark test

USAGE
  $ slp-cli-wallet fund-test-wallet

OPTIONS
  -d, --dest=dest  destination wallet name, to send funds to
  -n, --name=name  source wallet name to source funds

DESCRIPTION
  ...
  This is a long-running command that funds a new wallet and prepares it to run
  a benchmark test of the BCH infrastructure.

See code: src/commands/fund-test-wallet.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
  -t, --token      Generate a simpledger: token address

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 run-indexer-test`

Runs the benchmark indexer-test

USAGE
  $ slp-cli-wallet run-indexer-test

OPTIONS
  -n, --name=name  source wallet name to source funds

DESCRIPTION
  ...
  This command assumes that the wallet has been prepped to run the test by first
  running these commands:
  - fund-test-wallet
  - update-balances

  After running the above commands in that order, the wallet will then be prepared
  to run this command, which executes the benchmark test.

See code: src/commands/run-indexer-test.js

`slp-cli-wallet run-node-test`

Runs the full-node benchmark test

USAGE
  $ slp-cli-wallet run-node-test

OPTIONS
  -n, --name=name  source wallet name to source funds

DESCRIPTION
  ...
  This command assumes that the wallet has been prepped to run the test by first
  running these commands:
  - fund-test-wallet
  - update-balances

  After running the above commands in that order, the wallet will then be prepared
  to run this command, which executes the benchmark test.

See code: src/commands/run-node-test.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-chunk`

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

USAGE
  $ slp-cli-wallet send-chunk

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-chunk.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 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.
  -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 tokenize-test-wallet`

Prepares wallet to run benchmark test

USAGE
  $ slp-cli-wallet tokenize-test-wallet

OPTIONS
  -d, --dest=dest  destination wallet name, to send funds to
  -n, --name=name  source wallet name to source funds

DESCRIPTION
  ...
  This is a long-running command that funds a new wallet and prepares it to run
  a benchmark test of the BCH infrastructure.

See code: src/commands/tokenize-test-wallet.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

`slp-cli-wallet update2`

Poll the network and update the balances of the wallet.

USAGE
  $ slp-cli-wallet update2

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

See code: src/commands/update2.js

Related Projects

aavetrage

Maximize yields on assets across different AAVE markets

16 Jan 2021 11

rn-bitcoinjs-lib

A React Native compatible implementation of bitcoinjs-lib

24 Feb 2018 31

ethereumjs-monorepo

Monorepo for the Ethereum VM TypeScript Implementation

10 Jul 2015 2,476

swap-test

Cross-chain atomic swaps for bcoin and bcash

13 Sep 2018 16

bitcoinjs-lib

A javascript Bitcoin library for node.js and browsers.

04 May 2011 5,678