Alkanes Commands
The alkanes namespace provides operations for the Alkanes protocol including contract execution, token queries, AMM swaps, and liquidity pool management.
Commands Overview
| Command | Description |
|---|---|
| execute | Execute an alkanes transaction with protostones |
| simulate | Simulate a contract call without broadcasting |
| trace | Trace an alkanes transaction |
| inspect | Inspect a contract (disassemble, fuzz, metadata) |
| getbalance | Get alkane token balances for an address |
| spendables | Get spendable outpoints for an address |
| reflect-alkane | Get metadata for an alkane (name, symbol, supply) |
| getbytecode | Get the bytecode for an alkane contract |
| wrap-btc | Wrap BTC to frBTC |
| unwrap | Get pending unwraps |
| get-all-pools | Get all AMM pools |
| pool-details | Get details for a specific pool |
| init-pool | Initialize a new liquidity pool |
| swap | Execute a swap on the AMM |
alkanes execute
Execute an alkanes transaction with one or more protostones.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
--wallet-file ~/.alkanes/wallet.json \
--passphrase "your-passphrase" \
alkanes execute <PROTOSTONES> \
--to <RECIPIENT> \
--fee-rate 10 \
-y
# Options:
# --inputs <INPUTS> Input requirements (B:amount, block:tx:amount)
# --to <TO> Recipient addresses
# --from <FROM> Source addresses for UTXOs
# --fee-rate <RATE> Fee rate in sat/vB
# --envelope <PATH> Path to envelope file (for contract deployment)
# --trace Enable transaction tracing
# -y, --auto-confirm Auto-confirm the transactionalkanes simulate
Simulate an alkanes contract call without broadcasting.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
alkanes simulate 2:0:99 \
--inputs "2:1:1000,32:0:5000"
# Arguments:
# <ALKANE_ID> Alkane ID with opcode (format: block:tx:opcode)
# Options:
# --inputs <INPUTS> Input alkanes as comma-separated triplets
# --height <HEIGHT> Block height for simulation
# --envelope <PATH> Path to WASM file
# --raw Show raw JSON outputalkanes trace
Trace an alkanes transaction to see execution details.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
alkanes trace <TXID>:<VOUT>alkanes inspect
Inspect an alkanes contract for debugging and analysis.
# Disassemble bytecode
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
alkanes inspect 2:0 --disasm
# Show metadata
alkanes-cli alkanes inspect 2:0 --meta
# Fuzz contract with opcode range
alkanes-cli alkanes inspect 2:0 --fuzz --fuzz-ranges "99-110"
# Get code hash
alkanes-cli alkanes inspect 2:0 --codehashalkanes reflect-alkane
Get metadata for an alkane token by calling standard view opcodes.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
alkanes reflect-alkane 2:0
# Output:
# Alkane Metadata for 2:0
# ═══════════════════════
# Name: DIESEL
# Symbol: DIESEL
# Total Supply: 5050000000alkanes getbalance
Get alkane token balances for an address.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
alkanes getbalance bc1p...alkanes wrap-btc
Wrap BTC to frBTC (wrapped Bitcoin).
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
--wallet-file ~/.alkanes/wallet.json \
--passphrase "your-passphrase" \
alkanes wrap-btc <AMOUNT_SATS> \
--fee-rate 10 \
-yalkanes get-all-pools
Get all AMM pools from the factory contract.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
alkanes get-all-poolsalkanes swap
Execute a swap on the AMM.
alkanes-cli -p mainnet \
--jsonrpc-url https://mainnet.subfrost.io/v4/jsonrpc \
--wallet-file ~/.alkanes/wallet.json \
--passphrase "your-passphrase" \
alkanes swap \
--pool <POOL_ID> \
--token-in <TOKEN_ID> \
--amount-in <AMOUNT> \
--min-out <MIN_AMOUNT> \
--fee-rate 10 \
-y