bistrot v7.6.14
🍻 Bistrot
A CLI client and also an API library for RumSystem.net.
Install with npm
$ sudo npm config set unsafe-perm true
$ sudo npm install -g bistrot
$ bistrot help
Run a bistrot container
From Docker Hub
$ docker pull pressone/bistrot
$ docker run -it --rm pressone/bistrot bistrot help
Important: If you want to use a keystore file with the docker version, be sure to mount the path to the keystore file.
Instruction
bistrot v7.6.14
usage: bistrot <command> [<args>]
=====================================================================
* `Account` > Check an Account:
--address Quorum account address [STRING / REQUIRED]
> Example:
$ bistrot Account \
--address=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ
=====================================================================
* `Block` > Get block by block id or block number:
--id `block id` or `block number` [STR|NUM / REQUIRED]
┌---------------------------------------------------------------┐
| 1. Please use option `--json` to get complete block data. |
└---------------------------------------------------------------┘
> Example:
$ bistrot Block \
--id=26621512 \
--json
=====================================================================
* `Chain` > Check QUORUM-chain Information:
┌---------------------------------------------------------------┐
| 1. Use the `rpcapi` param to check the specific QUORUM-node. |
└---------------------------------------------------------------┘
> Example of checking global QUORUM-chain Information:
$ bistrot Chain
> Example of checking specific QUORUM-node Information:
$ bistrot Chain \
--rpcapi=http://51.68.201.144:8888
=====================================================================
* `Cmd` > List available commands:
> Example of listing all commands:
$ bistrot Cmd
> Example of searching commands:
$ bistrot Cmd account
=====================================================================
* `Help` > List help info:
> Example of listing all help info:
$ bistrot Help
> Example of listing help info for current command:
$ bistrot account \
--help
> Example of searching help info:
$ bistrot Help account
=====================================================================
* `KeystoreCreate` > Create a new Keystore (can also import keys):
--password Use to encrypt the keystore [STRING / REQUIRED]
--pvtkey Import existing private key [STRING / OPTIONAL]
--dump Save keystore to a JSON file [STRING / OPTIONAL]
> Example of creating a new keystore:
$ bistrot KeystoreCreate \
--password=nopassword \
--dump=keystore.json
> Example of creating a keystore with existing keys:
$ bistrot KeystoreCreate \
--pvtkey=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ \
--dump=keystore.json
=====================================================================
* `KeystoreUnlock` > Unlock a Keystore:
--keystore Path to the keystore JSON file [STRING / REQUIRED]
--password Use to decrypt the keystore [STRING / REQUIRED]
┌---------------------------------------------------------------┐
| This command will decrypt your keystore and display the |
| address and private key. It's for advanced users only. |
| You don't have to do this unless you know what you are doing. |
└---------------------------------------------------------------┘
> Example:
$ bistrot KeystoreUnlock \
--keystore=keystore.json
=====================================================================
* `Tail` > Trace the lastest block of the chain:
--blocknum Initial block num [NUMBER / OPTIONAL]
--grep Match keyword or RegExp [STRING / OPTIONAL]
--detail Show socket channel status [WITH OR WITHOUT ]
┌---------------------------------------------------------------┐
| 1. Start from the latest block while `blocknum` is missing. |
└---------------------------------------------------------------┘
> Example:
$ bistrot Tail \
--blocknum=26621512 \
--json
> Example:
$ bistrot Tail \
--blocknum=26621512 \
--json \
--grep=PIP:2001
=====================================================================
* `Trx` > Get transaction by hash:
--hash Transaction hash [STRING / REQUIRED]
┌---------------------------------------------------------------┐
| 1. Use option `--json` to get complete transaction data. |
└---------------------------------------------------------------┘
> Example:
$ bistrot Trx \
--hash=0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ \
--json
=====================================================================
* `Version` > List version info:
┌---------------------------------------------------------------┐
| 1. Please use option `--debug` to get verbose information. |
| 2. Please use option `--json` to get structured data. |
└---------------------------------------------------------------┘
> Example of getting package version:
$ bistrot Version
> Example of exporting info as json:
$ bistrot Version \
--json
=====================================================================
* Advanced:
--help List help info for current cmd [WITH OR WITHOUT ]
--json Printing the result as JSON [WITH OR WITHOUT ]
--compact Printing JSON in compact style [WITH OR WITHOUT ]
--force Force overwrite existing file [WITH OR WITHOUT ]
--debug Enable or disable debug mode [WITH OR WITHOUT ]
--rpcapi Customize PRS RPC-API endpoint [STRING / OPTIONAL]
--chainapi Customize PRS Chain-API endpoint [STRING / OPTIONAL]
--mvm Use MVM RPC-API endpoint [STRING / OPTIONAL]
┌---------------------------------------------------------------┐
| 1. Using param `force` will increase the risk of losing data. |
└---------------------------------------------------------------┘
* Security:
Using passwords or private keys on the command line interface can
be insecure.
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago