alkanes-cli & @alkanes/ts-sdk

The alkanes-cli command-line tool and @alkanes/ts-sdk TypeScript library provide comprehensive access to the Alkanes protocol, Bitcoin blockchain, and SUBFROST APIs.

What is alkanes-cli?

alkanes-cli is a powerful command-line interface for:

Wallet Management

Create, manage, and sign transactions with HD wallets

Alkanes Protocol

Deploy contracts, execute transactions, and query balances

AMM & Liquidity

Initialize pools, execute swaps, and manage liquidity

Bitcoin Operations

Query blocks, transactions, UTXOs, and fee estimates

Ordinals & Runes

Query inscriptions, runes, and sat information

Network Endpoints

The CLI can connect to SUBFROST APIs on different networks:

NetworkJSON-RPCData API
Mainnethttps://mainnet.subfrost.io/v4/jsonrpchttps://mainnet.subfrost.io/v4/api
Signethttps://signet.subfrost.io/v4/jsonrpchttps://signet.subfrost.io/v4/api
Regtesthttps://regtest.subfrost.io/v4/jsonrpchttps://regtest.subfrost.io/v4/api

Command Namespaces

CommandDescription
walletHD wallet creation, addresses, signing, and transactions
alkanesAlkanes protocol operations (execute, simulate, trace, swap)
ordOrdinals protocol queries (inscriptions, runes, sats)
esploraBlock explorer queries (blocks, transactions, addresses)
dataapiHigh-level data queries (alkanes, pools, balances)
metashrewLow-level indexer queries
bitcoindBitcoin Core RPC passthrough
luaServer-side Lua script execution

Global Options

alkanes-cli [OPTIONS] <COMMAND>

Options:
  --wallet-file <PATH>        Path to wallet file (default: ~/.alkanes/wallet.json)
  --passphrase <PASSPHRASE>   Wallet passphrase for signing
  --jsonrpc-url <URL>         JSON-RPC endpoint URL
  --data-api <URL>            Data API endpoint URL
  --subfrost-api-key <KEY>    SUBFROST API key (or use SUBFROST_API_KEY env)
  -p, --provider <PROVIDER>   Network provider [default: regtest]
                              Options: mainnet, signet, regtest
  -h, --help                  Print help
  -V, --version               Print version

TypeScript SDK (@alkanes/ts-sdk)

The same functionality is available in TypeScript:

import {
  createKeystore,
  unlockKeystore,
  createWallet,
  createProvider
} from '@alkanes/ts-sdk';

// Create a provider
const provider = createProvider({
  url: 'https://mainnet.subfrost.io/v4/jsonrpc',
  networkType: 'mainnet',
});

// Get block height
const height = await provider.getBlockHeight();
console.log('Block height:', height);