Skip to main content

CLI for ICRC-1 tokens (ckBTC, ckETH, ICP) on the Internet Computer

Project description

ICW - ICP Wallet CLI

Simple CLI for managing ICRC-1 tokens (ckBTC, ckETH, ICP) on the Internet Computer.

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

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

# 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). Default: ckbtc
  • -n, --network: Network (ic, local). Default: ic
  • --ledger: Override ledger canister ID (for local testing)
  • --fee: Override transfer fee (for local testing)

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.1.5.tar.gz (8.0 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.1.5-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for internet_computer_wallet-0.1.5.tar.gz
Algorithm Hash digest
SHA256 ad96e578a47e5f4c9245edf445545276c3ae2bc962b34f2b90e8c009fc1ba21e
MD5 40d5d3d740b91601b5da95418dfc3acd
BLAKE2b-256 5fa8f9bacb23c6068e00c51c5677f90a67fe5ceacfb28a728383379de96b2d6c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for internet_computer_wallet-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 437c165426be04c257eb739d5fc37d810b29149d015a81ca7fa828b9e2b838c9
MD5 1640eae882ba13b2a7c2411eddaac92f
BLAKE2b-256 f687f0755d63ea375b67f9ffd7186a6faea7020ce85348a04898ac92c753d227

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