Alkanes Commands

The alkanes namespace provides operations for the Alkanes protocol including contract execution, token queries, AMM swaps, and liquidity pool management.

Commands Overview

CommandDescription
executeExecute an alkanes transaction with protostones
simulateSimulate a contract call without broadcasting
traceTrace an alkanes transaction
inspectInspect a contract (disassemble, fuzz, metadata)
getbalanceGet alkane token balances for an address
spendablesGet spendable outpoints for an address
reflect-alkaneGet metadata for an alkane (name, symbol, supply)
getbytecodeGet the bytecode for an alkane contract
wrap-btcWrap BTC to frBTC
unwrapGet pending unwraps
get-all-poolsGet all AMM pools
pool-detailsGet details for a specific pool
init-poolInitialize a new liquidity pool
swapExecute 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 transaction

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

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

alkanes 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: 5050000000

alkanes 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 \
  -y

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

alkanes 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