CLI for ICRC-1 tokens (ckBTC, ckETH, ICP, ckUSDC, ckUSDT) on the Internet Computer
Project description
ICW - ICP Wallet CLI
Simple CLI and Web UI for managing ICRC-1 tokens on the Internet Computer.
Supported tokens: ckBTC, ckETH, ICP, ckUSDC, ckUSDT
⚠️ WARNING: This is experimental software. Do not use with significant amounts of funds. Use at your own risk.
Web UI
pip install internet-computer-wallet[ui]
icw ui # Opens browser at http://localhost:5555
icw ui --port 8080 # Custom port
icw ui --no-browser # Don't auto-open browser
Desktop Launcher (Linux)
icw install-launcher # Adds "ICW Wallet" to your applications menu
Install
pip install internet-computer-wallet
Usage
# Check balance (auto-converts to USD)
icw balance # ckBTC (default)
icw -t cketh balance # ckETH
icw -t icp balance # ICP
icw -t ckusdc balance # ckUSDC
icw -t ckusdt balance # ckUSDT
icw balance -p <principal> -s 1 # specific principal + subaccount
# Subaccounts (integer, hex, or text)
icw balance -s 1 # integer (0-255)
icw balance -s savings # text (max 32 ASCII chars)
icw balance -s 0a1b2c... # hex (64 chars = 32 bytes)
# Transfer tokens
icw transfer <recipient> 0.001
icw transfer <recipient> 0.001 -s 1 -f 2 # to subaccount 1, from subaccount 2
icw transfer <recipient> 0.001 -s savings # to "savings" subaccount
icw transfer <recipient> 0.001 -m invoice_123 # with memo/tag
# Token info + current price
icw info # ckBTC (default)
icw -t icp info # ICP
# Identity management
icw id # current identity + principal
icw id list # list all identities
icw id use <name> # switch identity
icw id new <name> # create new identity
# Version
icw --version
Output
All commands output JSON for easy parsing:
{
"token": "ckBTC",
"balance": 0.001,
"raw": 100000,
"usd": 97.0,
"price": 97000.0,
"principal": "abc-xyz"
}
Options
-t, --token: Token (ckbtc, cketh, icp, ckusdc, ckusdt). Default: ckbtc-n, --network: Network (ic, local). Default: ic--ledger: Override ledger canister ID (for local testing)--fee: Override transfer fee (for local testing)-m, --memo: Transaction memo/tag (max 32 bytes, for tracking payments)
Local Development
To use icw with a local dfx replica:
cd tests
# Download ledger wasm artifacts
./download_artifacts.sh
# Start local replica
dfx start --clean --background
# Deploy test ledger with initial balance
dfx deploy ckbtc_ledger --no-wallet --yes --argument='(variant { Init = record {
minting_account = record { owner = principal "'$(dfx identity get-principal)'"; subaccount = null };
transfer_fee = 0; token_symbol = "ckBTC"; token_name = "ckBTC Test"; decimals = opt 8;
metadata = vec {}; feature_flags = opt record { icrc2 = true };
initial_balances = vec { record { record { owner = principal "'$(dfx identity get-principal)'"; subaccount = null }; 100_000_000_000 } };
archive_options = record { num_blocks_to_archive = 1000; trigger_threshold = 2000; controller_id = principal "'$(dfx identity get-principal)'" }
} })'
# Get ledger ID and use icw
LEDGER=$(dfx canister id ckbtc_ledger)
icw -n local balance --ledger $LEDGER
icw -n local transfer <recipient> 0.01 --ledger $LEDGER --fee 0
Requirements
- Python 3.9+
- dfx (auto-installs if missing)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file internet_computer_wallet-0.2.1.tar.gz.
File metadata
- Download URL: internet_computer_wallet-0.2.1.tar.gz
- Upload date:
- Size: 174.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e0a26d654a014894c52cb11fa5cf46e783b9c4d03a721bbde675b3c1fa2e4c11
|
|
| MD5 |
29646dce8810f697e2efb79381deb864
|
|
| BLAKE2b-256 |
7db072636351f059d3f87396b76646d6f5dd6a4b0b5c273b08120935ecb1c663
|
File details
Details for the file internet_computer_wallet-0.2.1-py3-none-any.whl.
File metadata
- Download URL: internet_computer_wallet-0.2.1-py3-none-any.whl
- Upload date:
- Size: 165.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e88c60172e86761bbdd54febf385d94f802f07e1049809334ee07fe25f9c53fd
|
|
| MD5 |
f5dab2fe23606c024fb0463c34f6794a
|
|
| BLAKE2b-256 |
e54601fc191546b9585b191cf043e3b187da1b342380471dfdef605e7368cd1e
|