Ckb Cli

https://github.com/nervosnetwork/ckb-cli
Admin
Ckb Cli is a command line interface for interacting with the CKB blockchain, providing various...
Tokens:62,790
Snippets:715
Trust Score:9.6
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build ckb-cli and example plugin

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Compile the ckb-cli project and the keystore example plugin using cargo.

```shell
# Build ckb-cli
cargo build
# Build example keystore plugin
cd plugin-protocol
cargo build --examples
```

--------------------------------

### Install Ledger plugin

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Installs the Ledger plugin via CLI or manual binary placement.

```bash
# Install Ledger plugin
ckb-cli plugin install ledger

# Or copy plugin binary to ~/.ckb-cli/plugins/
```

--------------------------------

### Example deployment.toml configuration

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Deploy-contracts

Initial template for the deployment configuration file.

```toml
[[cells]]
name = "my_cell"
enable_type_id = true
location = { file = "build/release/my_cell" }

# reference to on-chain cells, this config is referenced by dep_groups.cells
[[cells]]
name = "genesis_cell"
enable_type_id = false
location = { tx_hash = "0xaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", index = 0 }

# Dep group cells
[[dep_groups]]
name = "my_dep_group"
enable_type_id = false
cells = [
  "my_cell",
  "genesis_cell"
]

# The lock script set to output cells
[lock]
code_hash = "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8"
args = "0x0000000000000000000000000000000000000000"
hash_type = "type"

# For unlocking inputs with multisig lock script
[multisig_config]
sighash_addresses = [
  "ckt1qyq111111111111111111111111111111111111111",
  "ckt1qyq222222222222222222222222222222222222222",
  "ckt1qyq333333333333333333333333333333333333333",
]
require_first_n = 1
threshold = 2
```

--------------------------------

### Manage Plugins

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/errors.md

Commands to list installed plugins and install new ones like the Ledger plugin.

```bash
# List available plugins
ckb-cli plugin list

# Install Ledger plugin (example)
ckb-cli plugin install ledger
```

--------------------------------

### Install the keystore plugin

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Register the plugin within the ckb-cli interactive shell.

```shell
./target/debug/ckb-cli
CKB> plugin install --binary-path ./target/debug/examples/keystore
daemon: true
description: "It's a keystore for demo"
name: demo_keystore
```

--------------------------------

### Deployment configuration file

Source: https://github.com/nervosnetwork/ckb-cli/wiki/UDT-(sudt)-Operations-Tutorial

Example deployment.toml configuration for defining cells and dep_groups.

```toml
[[cells]]
name = "cheque_lock"
enable_type_id = true
location = { file = "contracts/ckb-cheque-script" }

[[cells]]
name = "acp_lock"
enable_type_id = true
location = { file = "contracts/anyone_can_pay" }

[[cells]]
name = "simple_udt"
enable_type_id = true
location = { file = "contracts/simple_udt" }


# reference to on-chain cells, this config is referenced by dep_groups.cells
[[cells]]
name = "secp256k1_data"
enable_type_id = false
location = { tx_hash = "<genesis-cellbase-tx-hash>", index = 3 }
 
# Dep group cells
[[dep_groups]]
name = "cheque_lock_dep"
cells = [
  "secp256k1_data",
  "cheque_lock"
]
[[dep_groups]]
name = "acp_lock_dep"
cells = [
  "secp256k1_data",
  "acp_lock"
]

# Replace with your own lock if you want to unlock deployed cells.
# For example the secp256k1 lock
[lock]
code_hash = "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce8"
args = "<sighash-address-lock-args>"
hash_type = "type"

# For unlocking inputs with multisig lock script
[multisig_config]
sighash_addresses = [
  # "ckt1qyq111111111111111111111111111111111111111",
  # "ckt1qyq222222222222222222222222222222222222222",
  # "ckt1qyq333333333333333333333333333333333333333",
]
require_first_n = 1
threshold = 2
```

--------------------------------

### Deployment Recipes File

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Deploy-contracts

Example of the JSON file generated in the migrations directory after deployment.

```json
{
  "cell_recipes": [
    {
      "name": "omni_lock",
      "tx_hash": "0xfc856712001862df1178ea0467cfb459aeecaae3e4ff2f3e3de15bdeec3e36c7",
      "index": 0,
      "occupied_capacity": 11139000000000,
      "data_hash": "0x4386173157083954d5f253f52a21fcf67b3d3c9deb4bb8f093a2b100a45f823d",
      "type_id": "0x52e7f2633597edf383f9046d8e96649def08cb2dbb5b0ad6dd3b0ef3fd7da210"
    },
    {
      "name": "simple_udt",
      "tx_hash": "0xfc856712001862df1178ea0467cfb459aeecaae3e4ff2f3e3de15bdeec3e36c7",
      "index": 1,
      "occupied_capacity": 182200000000,
      "data_hash": "0xe1e354d6d643ad42724d40967e334984534e0367405c5ae42a9d7d63d77df419",
      "type_id": "0x298eb4f6d8bc4bfbba64bfe5bc4621c6e8305969b16038e0d6fe56051507b59d"
    }
  ],
  "dep_group_recipes": [
    {
      "name": "omni_lock_dep_group",
      "tx_hash": "0x3eab12375b95075c79fe6c457e0eaabaa9b41f6796048a0e4b61e57a08c5ab32",
      "index": 0,
      "data_hash": "0x34feb050df0d55af7dadbbe6737ad1769c4d6ce1084647375f91063050254a8e",
      "occupied_capacity": 13700000000
    }
  ]
}
```

--------------------------------

### Build ckb-cli from source

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Commands to clone the repository and install the binary using cargo.

```bash
git clone https://github.com/nervosnetwork/ckb-cli.git
cd ckb-cli
cargo install --path . -f --locked
```

--------------------------------

### Start ckb-cli API Server

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/API-Server.md

Displays the help menu and usage instructions for the ckb-cli server command.

```bash
ckb-cli server --help
Start advanced API server

USAGE:
    ckb-cli server [FLAGS] [OPTIONS] --listen <listen>

FLAGS:
        --wait-for-sync    Ensure the index-store synchronizes completely before command being executed

OPTIONS:
        --listen <listen>                  Rpc server listen address (when --privkey-path is given ip MUST be 127.0.0.1)
                                           [default: 127.0.0.1:3000]
        --privkey-path <privkey-path>      Private key file path (only read first line)
```

--------------------------------

### Complete Transaction Flow Example

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/mock-tx-subcommand.md

A full workflow demonstrating building, signing, verifying, and sending a transaction using ckb-cli.

```bash
#!/bin/bash
set -e

TX_FILE="transfer.json"
SIGNED_TX="signed.json"
FROM_ACCOUNT="0x..."
TO_ADDRESS="ckt1..."
PRIVKEY="./private.key"

# 1. Build transaction
echo "Building transaction..."
ckb-cli wallet transfer \
  --from-account "$FROM_ACCOUNT" \
  --to-address "$TO_ADDRESS" \
  --capacity "100" \
  --fee-rate "1000" > "$TX_FILE"

# 2. Sign transaction
echo "Signing transaction..."
ckb-cli tx sign-inputs \
  --tx-file "$TX_FILE" \
  --privkey-path "$PRIVKEY" > "$SIGNED_TX"

# 3. Verify before sending
echo "Verifying transaction..."
ckb-cli mock-tx verify --tx-file "$SIGNED_TX"

# 4. If verification passed, send
echo "Sending transaction..."
ckb-cli rpc send_transaction < "$SIGNED_TX" | jq .

echo "Complete!"
```

--------------------------------

### ckb-cli server

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/API-Server.md

Starts the advanced API server for ckb-cli.

```APIDOC
## Start API Server

### Description
Starts the advanced API server to handle RPC requests.

### Usage
`ckb-cli server [FLAGS] [OPTIONS] --listen <listen>`

### Options
- **--listen** (string) - Required - Rpc server listen address (default: 127.0.0.1:3000)
- **--privkey-path** (string) - Optional - Private key file path

### Flags
- **--wait-for-sync** - Optional - Ensure the index-store synchronizes completely before command being executed
```

--------------------------------

### Configure Output Format Property

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/configuration.md

Example of setting the output format to JSON in the configuration file.

```json
{
  "output_format": "json"
}
```

--------------------------------

### Launch interactive mode

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Start the interactive shell for ckb-cli.

```bash
ckb-cli
```

--------------------------------

### View plugin information

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Retrieve metadata and role information for an installed plugin.

```shell
CKB> plugin info --name demo_keystore
daemon: true
description: "It's a keystore for demo"
is_active: true
name: demo_keystore
roles:
  - require_password: true
    role: key_store
```

--------------------------------

### BIP-44 Derivation Path Examples

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/account-subcommand.md

Common derivation paths for receiving and change addresses.

```text
m/44'/309'/0'/0/0
```

```text
m/44'/309'/0'/1/0
```

```text
m/44'/309'/1'/0/0
```

--------------------------------

### Sign a message with the plugin

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Use the installed keystore plugin to perform a recoverable signature on a message.

```shell
CKB> util sign-message --from-account 0xb39bbc0b3673c7d36450bc14cfcdad2d559c6c64 --message 0xe203d8260a0eb9d0ec8f69976e2108d9e50d0c8fb1920a67d10d61cb9993e284 --recoverable
Password: ***
recoverable: true
signature: 0x0101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101010101
```

--------------------------------

### get(key: Option<&str>)

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Retrieves an environment variable or lists all variables.

```APIDOC
## get(key: Option<&str>)

### Description
Retrieves an environment variable or lists all variables. Supports dot notation for nested fields.

### Parameters
- **key** (Option<&str>) - Optional - Variable name or None for all keys
```

--------------------------------

### Execute ckb-cli commands

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/configuration.md

Examples of running ckb-cli in various environments including mainnet, local development, and Docker.

```bash
export API_URL=https://mainnet-ckb.nervos.org
ckb-cli --json wallet get-capacity --address ckb1...
```

```bash
ckb-cli --url http://127.0.0.1:8114 --debug rpc get_tip_block_number
```

```bash
#!/bin/bash
export API_URL=http://127.0.0.1:8114
ckb-cli --json --local-only wallet get-capacity --address ckb1...
```

```bash
docker run \
  -e API_URL=http://ckb-node:8114 \
  -e CKB_CLI_HOME=/data/.ckb-cli \
  nervosnetwork/ckb-cli \
  rpc get_tip_block_number
```

--------------------------------

### Configure URL Property

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/configuration.md

Example of setting the CKB node JSON-RPC endpoint in the configuration file.

```json
{
  "url": "http://testnet-ckb.nervos.org"
}
```

--------------------------------

### Diagnose device connectivity issues

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Use these commands to list installed plugins and verify that the hardware device is detected by the operating system.

```bash
# Check plugin
ckb-cli plugin list

# Verify device connection
lsusb  # Linux
system_profiler SPUSBDataType  # macOS

# Try reconnecting device
```

--------------------------------

### Example migration recipe file

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Deploy-contracts

The resulting JSON file generated in the migrations directory after a successful contract update.

```json
{
  "cell_recipes": [
    {
      "name": "omni_lock",
      "tx_hash": "0x1226939511f53f59b928a4f56f417e18230a82bd86d8a2136b18bf25c70f3c58",
      "index": 0,
      "occupied_capacity": 11139400000000,
      "data_hash": "0xeb1411f13f41d7853bb7c40333f5340abebd2ac5da12a8594966ca279d1d091f",
      "type_id": "0x52e7f2633597edf383f9046d8e96649def08cb2dbb5b0ad6dd3b0ef3fd7da210"
    },
    {
      "name": "simple_udt",
      "tx_hash": "0x1226939511f53f59b928a4f56f417e18230a82bd86d8a2136b18bf25c70f3c58",
      "index": 1,
      "occupied_capacity": 182600000000,
      "data_hash": "0x12d7f33ac8b8f5cc5072acdb79595f635c5bb59231cf68b97aae771bbee7bbee",
      "type_id": "0x298eb4f6d8bc4bfbba64bfe5bc4621c6e8305969b16038e0d6fe56051507b59d"
    }
  ],
  "dep_group_recipes": [
    {
      "name": "omni_lock_dep_group",
      "tx_hash": "0x4314bf1d1e734dd17296f4e77ef135379e899a0e27b1138dad37f692be145ca4",
      "index": 0,
      "data_hash": "0xd0888aa5fdd1166a814f7fcf0b78fd77472e045f598a8b85fd6167b59accbe9d",
      "occupied_capacity": 13700000000
    }
  ]
}
```

--------------------------------

### Plugin list output format

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Example of the YAML output structure returned by the plugin list command.

```yaml
plugins:
  - name: keystore
    version: 1.0.0
    accounts:
      - id: 0x...
        name: "Local Account"
        address: ckt1...
  - name: ledger
    version: 1.2.0
    status: available
    accounts: []
```

--------------------------------

### Simulate RPC Connection Failure

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/errors.md

Example of a command failing due to an unreachable RPC endpoint.

```bash
ckb-cli --url http://invalid.example.com rpc get_tip_block_number
# Error: Failed to connect to RPC server
```

--------------------------------

### Transfer Capacity Example

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/wallet-subcommand.md

Example usage of the transfer method with populated TransferArgs.

```rust
let args = TransferArgs {
    privkey_path: Some("./privkey".to_string()),
    from_account: None,
    from_locked_address: None,
    password: Some("my_password".to_string()),
    derive_receiving_address_length: Some("1000".to_string()),
    derive_change_address: None,
    capacity: "100".to_string(),
    fee_rate: "1000".to_string(),
    force_small_change_as_fee: None,
    to_address: "ckt1qzda...".to_string(),
    to_data: None,
    is_type_id: false,
    skip_check_to_address: false,
};

match wallet.transfer(args, false) {
    Ok(tx) => println!("Transfer tx: 0x{:x}", tx.hash()),
    Err(e) => eprintln!("Transfer failed: {}", e),
}
```

--------------------------------

### Parse Method Usage

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/arg-parsers.md

Example demonstrating the use of FromStrParser to convert a string input into a u64 value.

```rust
use utils::arg_parser::{ArgParser, FromStrParser};

let parser = FromStrParser::<u64>::new();
match parser.parse("1000") {
    Ok(value) => println!("Parsed: {}", value),
    Err(e) => eprintln!("Error: {}", e),
}
```

--------------------------------

### Prepare deployment directory

Source: https://github.com/nervosnetwork/ckb-cli/wiki/UDT-(sudt)-Operations-Tutorial

Sets up the directory structure and copies the compiled binaries for deployment.

```shell
mkdir -p deploy-files/{contracts,migrations}
cd deploy-files
cp ckb-production-scripts/build/simple_udt ckb-production-scripts/build/anyone_can_pay ckb-cheque-script/build/release/ckb-cheque-script contracts
touch deployment.toml
```

--------------------------------

### Use EitherParser for multiple input types

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/arg-parsers.md

Example of initializing an EitherParser and matching on the resulting EitherValue enum.

```rust
let parser = EitherParser::new(
    FixedHashParser::<H160>::default(),
    AddressParser::default(),
);
match parser.parse("0x...")? {
    EitherValue::A(hash) => println!("Hash: {:x}", hash),
    EitherValue::B(address) => println!("Address: {}", address),
}
```

--------------------------------

### KeyStore methods

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/types.md

Methods for initializing the keystore and managing accounts.

```rust
pub fn new(dir: PathBuf) -> Result<Self>
pub fn list_accounts(&self) -> Vec<Account>
pub fn new_account(&mut self, password: &str) -> Result<Account>
pub fn import(&mut self, privkey: PrivKey, password: &str) -> Result<Account>
```

--------------------------------

### edit_style()

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Gets the line editor style.

```APIDOC
## edit_style()

### Description
Gets the line editor style. Default is true.
```

--------------------------------

### Genesis script reference output

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Deploy-contracts

Example output from ckb-cli util genesis-scripts showing secp256k1_data location.

```yaml
dao: ...
secp256k1_blake160_multisig_all: ...
secp256k1_blake160_sighash_all: ...
secp256k1_data:
  out_point:
    index: 3
    tx_hash: 0x549f8043e001717b2e999c5f1238367516f7bd0dc1be502051f639c274ac266d
type_id: ...
```

--------------------------------

### Enable debug logging for plugins

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Start ckb-cli with specific environment variables to view plugin-related debug logs.

```shell
RUST_LOG=ckb_cli::plugin=debug ./target/debug/ckb-cli
```

--------------------------------

### completion_style()

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Gets the current completion style.

```APIDOC
## completion_style()

### Description
Gets the completion style. Default is true (List style).
```

--------------------------------

### Get block by number

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieve a block by its height.

```bash
ckb-cli rpc get_block_by_number --number 100
```

--------------------------------

### get_tip_block_number()

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-client.md

Gets the current chain tip height.

```APIDOC
## get_tip_block_number()

### Description
Gets the current chain tip height.

### Returns
- **Result<u64, String>** - Block height or error
```

--------------------------------

### Initialize temporary accounts

Source: https://github.com/nervosnetwork/ckb-cli/wiki/UDT-(sudt)-Operations-Tutorial

Sets up a temporary CKB_CLI_HOME directory and generates three new accounts for SUDT operations.

```shell
mkdir /tmp/tmp-ckb-cli-home
export CKB_CLI_HOME=/tmp/tmp-ckb-cli-home

# account owner
ckb-cli account new
address:
  testnet: ckt1qyq86vaa6e8tsruv5ngcd5tp7lcvcewxy7cquuksvj

# account 1
ckb-cli account new
address:
  testnet: ckt1qyqfjslcvyaay029vvfxtn80rxnwmlma43xscrqn85

# account 2
ckb-cli account new
address:
  testnet: ckt1qyq9qaekmruccau7u3eff4wsv8v74gxmlptqj2lcte
```

--------------------------------

### Get Plugin Version

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Returns the version string of the plugin.

```rust
fn version(&self) -> &str
```

--------------------------------

### Get Plugin Name

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Returns the identifier string for the plugin.

```rust
fn name(&self) -> &str
```

--------------------------------

### Integrate mock-tx with transaction signing

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/tx-subcommand.md

Demonstrates the workflow of building, verifying, and signing a transaction using mock-tx and tx subcommands.

```bash
# 1. Build mock transaction
ckb-cli mock-tx build ...

# 2. Verify with signatures
ckb-cli mock-tx verify ...

# 3. Once verified, convert to real transaction
ckb-cli tx sign-inputs ...
```

--------------------------------

### Get current epoch

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieve information about the current epoch.

```bash
ckb-cli rpc get_current_epoch
```

--------------------------------

### Initialize deployment configuration

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Deploy-contracts

Initializes a new deployment configuration file named deployment.toml.

```bash
ckb-cli deploy init-config --deployment-config deployment.toml
status: success
```

--------------------------------

### Retrieve Block Hash

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-client.md

Get the block hash at a specific height.

```rust
pub fn get_block_hash(&mut self, number: u64) -> Result<Option<H256>, String>
```

--------------------------------

### Initialize WalletSubCommand

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/wallet-subcommand.md

Constructor for creating a new instance of the wallet subcommand.

```rust
impl<'a> WalletSubCommand<'a> {
    pub fn new(
        rpc_client: &'a mut HttpRpcClient,
        plugin_mgr: &'a mut PluginManager,
        genesis_info: Option<GenesisInfo>,
    ) -> WalletSubCommand<'a>
}
```

--------------------------------

### Hardware Wallet Workflow

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/INDEX.md

Steps to list hardware wallet accounts, import them, and perform transfers requiring device confirmation.

```bash
# Connect device and discover accounts
ckb-cli account list

# Import account if desired
ckb-cli account import-from-plugin --account-id 0x...

# Transfer with device confirmation
ckb-cli wallet transfer \
  --from-account <device-account> \
  --to-address ckt1... \
  --capacity 100

# Device prompts to confirm transaction
```

--------------------------------

### Get tip header

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Retrieve the current tip header from the node.

```bash
ckb-cli rpc get_tip_header
```

--------------------------------

### Copy ckb-cli keystore for Neuron import

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Import-ckb-cli-keystore-from&to-Neuron-wallet

Prepare the keystore file by copying it to a temporary location before editing and importing into Neuron.

```bash
$ cp ~/.ckb-cli/keystore/UTC--2020-11-11T11-11-24.222222222Z--{lock-arg} tmp-keystore.json
```

--------------------------------

### Upgrade Account Format CLI

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/account-subcommand.md

Command to upgrade an account to the latest keystore format.

```bash
ckb-cli account upgrade 0x1234567890abcdef...
```

--------------------------------

### Get tip block number

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieve the current tip block height.

```bash
ckb-cli rpc get_tip_block_number
```

--------------------------------

### Initialize Deployment Configuration

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Deploy-contracts

Generates the initial deployment.toml configuration file required for contract deployment.

```shell
ckb-cli deploy init-config --deployment-config deployment.toml
```

--------------------------------

### Get block hash

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieve the block hash for a specific block height.

```bash
ckb-cli rpc get_block_hash --number 100
```

--------------------------------

### Display help documentation

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Access help information for the top-level tool or specific sub-commands.

```bash
# Top level help doc
ckb-cli --help
# RPC help doc
ckb-cli rpc --help
```

--------------------------------

### Import from Plugin CLI

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/account-subcommand.md

Command to import an account from a hardware wallet plugin using an account ID.

```bash
ckb-cli account import-from-plugin --account-id 0x1234567890abcdef
```

--------------------------------

### Get edit style in Rust

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Retrieves the current line editor style.

```rust
pub fn edit_style(&self) -> bool
```

--------------------------------

### Get completion style in Rust

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Retrieves the current completion style setting.

```rust
pub fn completion_style(&self) -> bool
```

--------------------------------

### List available plugins and accounts

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Displays all currently loaded plugins and their associated accounts.

```bash
ckb-cli plugin list
```

--------------------------------

### HttpRpcClient::new

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-client.md

Initializes a new HttpRpcClient instance with the specified CKB node URL.

```APIDOC
## HttpRpcClient::new(url: String)

### Description
Creates a new instance of the HttpRpcClient to connect to a CKB node.

### Parameters
- **url** (String) - Required - CKB node JSON-RPC endpoint URL (e.g., http://127.0.0.1:8114)

### Returns
- **HttpRpcClient** - An instance of the client.
```

--------------------------------

### Manage File Permissions

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/errors.md

Commands to inspect and correct directory permissions for the keystore.

```bash
# Check permissions
ls -la ~/.ckb-cli/keystore/

# Fix permissions
chmod 700 ~/.ckb-cli/keystore/
```

--------------------------------

### JSON Transaction Format

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/tx-subcommand.md

Example of the expected JSON structure for transaction files in ckb-cli.

```json
{
  "version": "0",
  "cell_deps": [
    {
      "out_point": {
        "tx_hash": "0x...",
        "index": "0x0"
      },
      "dep_type": "code"
    }
  ],
  "header_deps": [],
  "inputs": [
    {
      "previous_output": {
        "tx_hash": "0x...",
        "index": "0x0"
      },
      "since": "0x0"
    }
  ],
  "outputs": [
    {
      "capacity": "0x...",
      "lock": {
        "code_hash": "0x...",
        "hash_type": "type",
        "args": "0x..."
      },
      "type": null
    }
  ],
  "witnesses": [
    "0x"
  ]
}
```

--------------------------------

### Transaction JSON Structure

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/mock-tx-subcommand.md

Example format for a transaction file used by the mock-tx subcommand.

```json
{
  "version": "0",
  "cell_deps": [
    {
      "out_point": {
        "tx_hash": "0x...",
        "index": "0x0"
      },
      "dep_type": "code"
    }
  ],
  "header_deps": [],
  "inputs": [
    {
      "previous_output": {
        "tx_hash": "0x...",
        "index": "0x0"
      },
      "since": "0x0"
    }
  ],
  "outputs": [
    {
      "capacity": "0x...",
      "lock": {
        "code_hash": "0x...",
        "hash_type": "type",
        "args": "0x..."
      }
    }
  ],
  "witnesses": ["0x"]
}
```

--------------------------------

### Deploy binaries

Source: https://github.com/nervosnetwork/ckb-cli/wiki/UDT-(sudt)-Operations-Tutorial

Commands to generate and apply the deployment transactions.

```shell
ckb-cli-deploy deploy gen-txs \
    --deployment-config ./deployment.toml \
    --migration-dir ./migrations \
    --from-address <your-account> \
    --info-file ./info.json \
    --sign-now

ckb-cli-deploy deploy apply-txs --migration-dir ./migrations --info-file ./info.json
```

--------------------------------

### from_matches Method Usage

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/arg-parsers.md

Example of extracting a required u32 argument from clap matches.

```rust
let parser = FromStrParser::<u32>::new();
let value: u32 = parser.from_matches(&matches, "my-arg")?;
```

--------------------------------

### Import Account CLI

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/account-subcommand.md

Commands to import private keys from files.

```bash
# Import simple private key
ckb-cli account import --privkey-path ./privkey.txt

# Import extended private key
ckb-cli account import --extended-privkey-path ./master_key.txt
```

--------------------------------

### Troubleshoot Hardware Wallet Connection

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Use this command to verify if the hardware wallet is detected by the system.

```bash
ckb-cli account list
# Error: Hardware wallet not connected
```

--------------------------------

### Manage plugin accounts via CLI

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Commands for listing, importing, and exporting plugin-based account information.

```bash
# List plugin accounts
ckb-cli account list

# Import plugin account to local keystore
ckb-cli account import-from-plugin --account-id 0x...

# Export plugin account info
ckb-cli account extended-address <imported-lock-arg>
```

--------------------------------

### Get Plugin Configuration

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Retrieve the configuration details of a plugin using the get_config method.

```javascript
{
    "params": [],
    "method": "get_config",
    "id": 0,
    "jsonrpc": "2.0"
}
```

```javascript
{
    "result": {
        "type": "plugin_config",
        "content": {
            "roles": [
                {
                    "role": "key_store",
                    "require_password": true
                }
            ],
            "name": "demo_keystore",
            "description": "It's a keystore for demo",
            "daemon": true
        }
    },
    "id": 0,
    "jsonrpc": "2.0"
}
```

--------------------------------

### PluginManager::new

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Initializes a new PluginManager instance with the specified plugin directory.

```APIDOC
## PluginManager::new

### Description
Creates a new instance of the PluginManager to handle plugin lifecycle operations.

### Parameters
- **plugin_dir** (PathBuf) - Required - Directory containing plugin binaries.

### Returns
- **Result<PluginManager>** - The manager instance or an error if initialization fails.
```

--------------------------------

### Get block with cycles

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieves block information including cycle consumption for transactions.

```bash
ckb-cli rpc get_block --hash 0x... --with-cycles
# Output:
# block:
#   header: {...}
#   transactions: [...]
# cycles: [100000, 200000, ...]
```

--------------------------------

### Get Tip Block Number

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-client.md

Retrieves the current block height of the chain tip.

```rust
pub fn get_tip_block_number(&mut self) -> Result<u64, String>
```

```rust
match client.get_tip_block_number() {
    Ok(tip) => println!("Tip block number: {}", tip),
    Err(e) => eprintln!("Error: {}", e),
}
```

--------------------------------

### Initialize Transaction File

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Handle-Complex-Transaction

Creates a new tx.json file to store transaction details, multisig configurations, and signatures.

```text
CKB> tx init --tx-file tx.json
ok
```

```javascript
{
  "transaction": {
    "version": "0x0",
    "cell_deps": [],
    "header_deps": [],
    "inputs": [],
    "outputs": [],
    "outputs_data": [],
    "witnesses": []
  },
  "multisig_configs": {},
  "signatures": {}
}
```

--------------------------------

### Get live cell

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Query a specific live cell by transaction hash and index.

```bash
ckb-cli rpc get_live_cell --tx-hash 0x4ec75b5a8de8d180853d5046760a99285c73283a5dc528f81d6ee056f5335172 --index 0
```

--------------------------------

### Initialize HttpRpcClient

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-client.md

Instantiate the client with a CKB node JSON-RPC endpoint URL.

```rust
impl HttpRpcClient {
    pub fn new(url: String) -> HttpRpcClient
}
```

```rust
use utils::rpc::HttpRpcClient;

let mut client = HttpRpcClient::new("http://127.0.0.1:8114".to_string());
```

--------------------------------

### Initialize and use HttpRpcClient in Rust

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-client.md

Demonstrates connecting to a local CKB node and fetching blockchain data like tip block number, specific blocks, and epoch information.

```rust
use utils::rpc::HttpRpcClient;
use ckb_types::H256;
use std::str::FromStr;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create client
    let mut client = HttpRpcClient::new("http://127.0.0.1:8114".to_string());
    
    // Get tip header
    let tip = client.get_tip_block_number()?;
    println!("Current tip: {}", tip);
    
    // Get block at height 100
    if let Ok(Some(block)) = client.get_block_by_number(100) {
        println!("Block 100: {:?}", block.header);
    }
    
    // Get current epoch
    let epoch = client.get_current_epoch()?;
    println!("Epoch: {}, Length: {}", epoch.number, epoch.length);
    
    Ok(())
}
```

--------------------------------

### Show version information

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/configuration.md

Displays the current version of the CLI.

```bash
ckb-cli --version
```

--------------------------------

### Import Keystore CLI

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/account-subcommand.md

Command to import an account from an encrypted JSON keystore file.

```bash
ckb-cli account import-keystore --path ./keystore.json
```

--------------------------------

### Get Capacity by Address via JSON-RPC

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/API-Server.md

Retrieves the total capacity associated with a specific address.

```bash
echo '{
    "id": 2,
    "jsonrpc": "2.0",
    "method": "get_capacity_by_address",
    "params": ["ckt1qyqdfjzl8ju2vfwjtl4mttx6me09hayzfldq8m3a0y"]
}' \
| tr -d '\n' \
| curl -H 'content-type: application/json' -d @- \
http://localhost:3000
```

```json
{
  "jsonrpc": "2.0",
  "result": {
    "dao": 0,
    "immature": 0,
    "total": 3000000009000
  },
  "id": 2
}
```

--------------------------------

### GlobalConfig Programmatic Usage

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Demonstrates initializing the configuration, setting RPC endpoints, output formats, and managing key-value pairs.

```rust
use utils::config::GlobalConfig;
use utils::printer::OutputFormat;

fn main() {
    // Create configuration
    let mut config = GlobalConfig::new(None);
    
    // Configure RPC endpoint
    config.set_url("https://testnet-ckb.nervos.org".to_string());
    
    // Configure output format
    config.set_output_format(OutputFormat::Json);
    
    // Enable color output
    config.set_color(true);
    
    // Set environment variables
    config.set("from_account".to_string(), json!("0x..."));
    config.set("to_address".to_string(), json!("ckt1..."));
    
    // Check configuration
    println!("RPC: {}", config.get_url());
    println!("Format: {}", config.output_format());
    println!("Color: {}", config.color());
    
    // Retrieve variables
    if let KV::Value(Some(val)) = config.get(Some("from_account")) {
        println!("From: {}", val);
    }
}
```

--------------------------------

### Discover multiple hardware wallets

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Lists all connected devices and their associated plugin accounts.

```bash
# Discover all devices
ckb-cli account list

# All plugin accounts shown with their device info
# Select specific device when signing
```

--------------------------------

### Get transaction proof

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieves the transaction proof for specified transaction hashes within a block.

```bash
ckb-cli rpc get_transaction_proof \
  --tx-hash 0x... \
  --tx-hash 0x... \
  --block-hash 0x...
```

--------------------------------

### Get chain tip block number

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieves the current tip block number from the chain.

```bash
ckb-cli rpc get_tip_block_number
# Output: 1000000
```

--------------------------------

### Indexer get transactions

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Retrieve transactions based on a search key provided in a JSON file.

```json
{
    "script": {
        "code_hash": "0xbbad126377d45f90a8ee120da988a2d7332c78ba8fd679aab478a19d6c133494",
        "hash_type": "data1",
        "args": "0x"
    },
    "script_type": "type",
    "script_search_mode": "prefix",
    "with_data": false
}
```

```bash
ckb-cli rpc get_transactions --json-path ./searchkey.json --order asc --limit 3
```

--------------------------------

### Indexer get cells

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/README.md

Retrieve cells based on a search key provided in a JSON file.

```json
{
    "script": {
        "code_hash": "0xbbad126377d45f90a8ee120da988a2d7332c78ba8fd679aab478a19d6c133494",
        "hash_type": "data1",
        "args": "0x"
    },
    "script_type": "type",
    "script_search_mode": "prefix",
    "filter": {
        "output_data": "0xa58618a553",
        "output_data_filter_mode": "partial"
    },
    "with_data": false
}
```

```bash
ckb-cli rpc get_cells --json-path ./searchkey.json --order asc --limit 1
```

--------------------------------

### Initialize AccountSubCommand

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/account-subcommand.md

Constructor for the AccountSubCommand struct requiring a plugin manager and key store.

```rust
impl<'a> AccountSubCommand<'a> {
    pub fn new(
        plugin_mgr: &'a mut PluginManager,
        key_store: &'a mut KeyStore,
    ) -> AccountSubCommand<'a>
}
```

--------------------------------

### Transfer insufficient capacity error

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/errors.md

Example of a command triggering an insufficient capacity error when transferring funds.

```bash
ckb-cli wallet transfer \
  --from-account 0x... \
  --to-address ckt1... \
  --capacity 1000000000000000  # 10M CKB
# Error: Insufficient capacity
```

--------------------------------

### Initialize GlobalConfig

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/global-config.md

Create a new instance of GlobalConfig with an optional RPC URL.

```rust
impl GlobalConfig {
    pub fn new(url: Option<String>) -> Self
}
```

```rust
use utils::config::GlobalConfig;

let config = GlobalConfig::new(Some("http://127.0.0.1:8114".to_string()));
```

--------------------------------

### Import Neuron keystore to ckb-cli

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Import-ckb-cli-keystore-from&to-Neuron-wallet

Use the ckb-cli command line interface to import an existing Neuron wallet keystore file.

```bash
$ ckb-cli account import-keystore --path "Wallet x.json"
```

--------------------------------

### Handle Invalid Address Error

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/errors.md

Example of triggering an invalid address error when performing a wallet transfer.

```bash
ckb-cli wallet transfer --to-address "invalid" --capacity 100
# Error: Invalid address
```

--------------------------------

### Initialize TxSubCommand

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/tx-subcommand.md

Constructor for the TxSubCommand struct, requiring an RPC client and plugin manager.

```rust
impl<'a> TxSubCommand<'a> {
    pub fn new(
        rpc_client: &'a mut HttpRpcClient,
        plugin_mgr: &'a mut PluginManager,
        genesis_info: Option<GenesisInfo>,
    ) -> TxSubCommand<'a>
}
```

--------------------------------

### Override Output Format

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/configuration.md

Example of overriding the global output format using the --json flag.

```bash
# Global: yaml
# Override: json
ckb-cli --json rpc get_block --hash 0x...
```

--------------------------------

### Initialize PluginManager

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Instantiate the manager by providing the directory path where plugin binaries are stored.

```rust
impl PluginManager {
    pub fn new(plugin_dir: PathBuf) -> Result<Self>
}
```

```rust
let plugin_dir = dirs::home_dir()
    .unwrap()
    .join(".ckb-cli")
    .join("plugins");
let mut manager = PluginManager::new(plugin_dir)?;
```

--------------------------------

### List Available Plugins

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Retrieve a list of all plugins and iterate through their metadata.

```rust
pub fn list(&self) -> Result<Vec<PluginInfo>>
```

```rust
match manager.list() {
    Ok(plugins) => {
        for plugin in plugins {
            println!("{}: {}", plugin.name, plugin.version);
        }
    }
    Err(e) => eprintln!("Error: {}", e),
}
```

--------------------------------

### View Cycle Estimation Output

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/mock-tx-subcommand.md

Example of the YAML output returned after a successful mock transaction verification.

```yaml
verify_result:
  cycles: 1234567
  status: success
```

--------------------------------

### Create Keystore Account

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Create a new account in the keystore, optionally providing a password for encryption.

```javascript
{
    "params": [
        // (optional) The password to encrypt the account
        "123"
    ],
    "method": "keystore_create_account",
    "id": 0,
    "jsonrpc": "2.0"
}
```

```javascript
{
    "result": {
        "type": "h160",
        "content": "0xb39bbc0b3673c7d36450bc14cfcdad2d559c6c64"
    },
    "id": 0,
    "jsonrpc": "2.0"
}
```

--------------------------------

### Create a new account

Source: https://github.com/nervosnetwork/ckb-cli/wiki/Tutorials

Generates a new account stored in Web3 keystore format, requiring a password for encryption.

```shell
ckb-cli account new
Your new account is locked with a password. Please give a password. Do not forget this password.
Password:
Repeat password:
address:
  mainnet: ckb1qyqrq6m2spk7rz8mksz70dp92lcmnrre03dsaxhjnt
  testnet: ckt1qyqrq6m2spk7rz8mksz70dp92lcmnrre03dsqrfdlh
lock_arg: 0x306b6a806de188fbb405e7b42557f1b98c797c5b
lock_hash: 0x4ae174831f903f5ae138ae6e25c07fc189df30c61761a78e6baa59fb57080b7a
```

--------------------------------

### keystore_create_account

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Creates a new account in the keystore.

```APIDOC
## keystore_create_account

### Description
Creates a new account. Optionally accepts a password to encrypt the account.

### Request Example
{
    "params": ["123"],
    "method": "keystore_create_account",
    "id": 0,
    "jsonrpc": "2.0"
}
```

--------------------------------

### CLI Key Information

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/util-subcommand.md

Displays lock arguments, public key, and network addresses for a given private key file.

```bash
ckb-cli util key-info --privkey-path ./privkey.txt
```

```yaml
lock_arg: 0x1234567890abcdef1234567890abcdef12345678
public_key: 0x...
address:
  mainnet: ckb1qzda...
  testnet: ckt1qzda...
```

--------------------------------

### Get extended public key

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/docs/Plugin.md

Retrieves the extended public key for a given account identifier and derivation path.

```javascript
{
    "params": [
        // The blake160 hash of the public key (account identifier)
        "0xb39bbc0b3673c7d36450bc14cfcdad2d559c6c64",
        // A derivation key path ("m" for master key)
        "m/44'/309'/0'/0/19",
        // (optional) The password to decrypt the account
        "123"
    ],
    "method": "keystore_extended_pubkey",
    "id": 0,
    "jsonrpc": "2.0"
}
```

```javascript
{
    "result": {
        "type": "bytes",
        "content": "0x02531fe6068134503d2723133227c867ac8fa6c83c537e9a44c3c5bdbdcb1fe337"
    },
    "id": 0,
    "jsonrpc": "2.0"
}
```

--------------------------------

### Project File Structure

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/README.md

Displays the directory layout of the generated documentation files.

```text
output/
├── README.md                          # This file
├── INDEX.md                           # Complete navigation
├── types.md                           # Type definitions
├── configuration.md                   # Configuration reference
├── errors.md                          # Error reference
└── api-reference/
    ├── rpc-client.md                 # HttpRpcClient
    ├── wallet-subcommand.md          # Wallet operations
    ├── account-subcommand.md         # Account management
    ├── arg-parsers.md                # Argument parsing
    ├── global-config.md              # Configuration
    ├── rpc-subcommand.md             # RPC commands
    ├── tx-subcommand.md              # Transaction operations
    ├── mock-tx-subcommand.md         # Transaction verification
    ├── util-subcommand.md            # Utilities
    └── plugin-system.md              # Plugin system
```

--------------------------------

### Get Cells via RPC

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Searches for cells matching the criteria defined in a JSON search key file.

```bash
ckb-cli rpc get_cells --json-path searchkey.json --limit 100 --order asc
```

--------------------------------

### Get Live Cell via RPC

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieves an unspent cell using its transaction hash and output index.

```bash
ckb-cli rpc get_live_cell --tx-hash 0x... --index 0 --with-data
```

--------------------------------

### Troubleshoot Plugin Load Failure

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/plugin-system.md

Use this command to identify issues when a plugin fails to load correctly.

```bash
ckb-cli plugin load ledger
# Error: Failed to load plugin: ledger
```

--------------------------------

### Get block by hash

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/rpc-subcommand.md

Retrieve a block using its hash, with optional flags for cycle usage and packed format.

```bash
ckb-cli rpc get_block --hash 0x...
ckb-cli rpc get_block --hash 0x... --with-cycles
```

--------------------------------

### Create Account and Transfer Capacity

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/INDEX.md

Commands to generate a new account, check balance, and perform a capacity transfer.

```bash
# Create account
ckb-cli account new

# Check balance
ckb-cli wallet get-capacity --address ckt1...

# Transfer capacity
ckb-cli wallet transfer \
  --from-account 0x... \
  --to-address ckt1... \
  --capacity 100 \
  --fee-rate 1000
```

--------------------------------

### Initialize MockTxSubCommand

Source: https://github.com/nervosnetwork/ckb-cli/blob/develop/_autodocs/api-reference/mock-tx-subcommand.md

Constructor for the MockTxSubCommand struct requiring an RPC client, plugin manager, and optional genesis information.

```rust
impl<'a> MockTxSubCommand<'a> {
    pub fn new(
        rpc_client: &'a mut HttpRpcClient,
        plugin_mgr: &'a mut PluginManager,
        genesis_info: Option<GenesisInfo>,
    ) -> MockTxSubCommand<'a>
}
```
Tokens:
Raw