Skip to main content

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, REALMS

⚠️ WARNING: This is experimental software. Do not use with significant amounts of funds. Use at your own risk.

Web UI

ICW 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

Explorer

ICW Explorer

Browse transaction history and balances for any account at /explorer.

http://localhost:5555/explorer                      # Your account
http://localhost:5555/explorer?account=<principal>  # Any account

Features:

  • Look up balances for any principal across all supported tokens
  • View transaction history (transfers, mints, burns) with timestamps
  • Click any token balance to view its transactions
  • Supports local network with custom ledger/index canister configuration

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 -t realms balance             # REALMS
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, realms). 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

internet_computer_wallet-0.3.1.tar.gz (179.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

internet_computer_wallet-0.3.1-py3-none-any.whl (172.6 kB view details)

Uploaded Python 3

File details

Details for the file internet_computer_wallet-0.3.1.tar.gz.

File metadata

  • Download URL: internet_computer_wallet-0.3.1.tar.gz
  • Upload date:
  • Size: 179.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for internet_computer_wallet-0.3.1.tar.gz
Algorithm Hash digest
SHA256 ed009b4226048061246a803a91ef3e98232895085a27eaa1b7679c6f5c80fbbd
MD5 99271285305e588130d4ccfda0ef085c
BLAKE2b-256 3fb080f796fcc5d4366ecfe233b9c5c5d78b9f2358c536585bcd0e0483eb642c

See more details on using hashes here.

File details

Details for the file internet_computer_wallet-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for internet_computer_wallet-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e9ad93db31f3d203980cdf79cd1b8b481624fa15a61d0869e522e38c58d85e3b
MD5 487712ec194df8345e38fcd8a31b37a7
BLAKE2b-256 fc50473605baaf40123b2f411f6dacea9bf92fcb569fee360ca4be66673a6989

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page