A wallet-agnostic command-line tool for interacting with Citrea, supporting secure Bitcoin deposits and withdrawals without requiring wallet connection.
- Bridge Operations: Deposit to and withdraw from Citrea network
- Airgapped Security: Key generation and signing in secure environments
- Wallet Management: Create, import, and manage Clementine wallets locally
- Wallet-agnostic: No external wallet connection required
- Recovery Support: Built-in fund recovery mechanisms
- Online Device: Bitcoin node or mempool.space API access
- Both Devices: Rust and Clementine CLI installation, secure data transfer method (USB, QR codes)
The provided bridge_cli_config.toml file should not be
modified, apart from .bitcoin_config sections. Some operations might require
Bitcoin RPC connection. For each network you wish to use Clementine Bridge on,
you need to provide correct Bitcoin RPC configuration.
Important
If a protocol-wide change is introduced by Chainway Labs, you will need to update your configuration file with the new settings.
-
Install Rust:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
-
Install Clementine CLI:
cargo install --path . -
Install configuration file by copying your config file to
~/.clementine/:mkdir -p ~/.clementine/ cp ./bridge_cli_config.toml ~/.clementine/
Caution
Please make sure that you did not rename the file, as this will prevent the CLI from detecting the file.
By default, clementine-cli uses bitcoin (mainnet) network. If you wish to
make deposits and withdrawals on other networks, please provide --network flag
every time you invoke clementine-cli.
# Get help
clementine-cli --help
# Create wallet for deposit (airgapped device only)
clementine-cli wallet create my-deposit-wallet deposit # Mainnet
clementine-cli wallet create --network testnet4 my-deposit-wallet deposit
# Monitor deposits (online device)
clementine-cli deposit status <DEPOSIT_ADDRESS> # Mainnet
clementine-cli deposit status --network testnet4 <DEPOSIT_ADDRESS>Clementine CLI requires two devices for maximum security:
- Airgapped Device: All wallet creation, key generation, and signing operations
- Online Device: Status monitoring, address generation, broadcasting
- Never: Connect airgapped device to internet
- Always: Verify the correctness of operations before interacting with Citrea or Bitcoin to prevent loss of funds
See docs/README.md for an overview of how to use this CLI to deposit to and withdraw from Citrea.
- Wallet Guide - Airgapped wallet operations
- Deposit Guide - Deposit Bitcoin to Citrea
- Withdrawal Guide - Withdrawal from Citrea to Bitcoin
MIT