CLI Setup

Alternative installations

Install via Homebrew Install via Docker Install via Source Install via Standalone Executable

CLI Basics

Set up an account Send a transaction Manage account keys

CLI Advanced

Health of your node Local mining Run your own local network Configure your node Offline transaction signing Bootstrap nodes

Multisig

Trusted Dealer Key Generation Distributed Key Generation (DKG)Sign a transaction with a multisig account

CLI Commands

help start stop status browse faucet reset

wallet

wallet:account wallet:accounts wallet:address wallet:assets wallet:balance wallet:balances wallet:burn wallet:create wallet:decrypt wallet:delete wallet:encrypt wallet:export wallet:import wallet:lock wallet:mint wallet:notes:combine wallet:notes wallet:post wallet:prune wallet:repair wallet:rescan wallet:reset wallet:send wallet:sign wallet:status wallet:transactions wallet:transaction wallet:transaction:add wallet:transaction:watch wallet:transaction:view wallet:unlock wallet:use wallet:which

chainport

wallet:chainport:send

multisig

wallet:multisig:participant:create wallet:multisig:participant wallet:multisig:dealer:create wallet:multisig:commitment:create wallet:multisig:commitment:aggregate wallet:multisig:sign wallet:multisig:signature:create wallet:multisig:signature:aggregate wallet:multisig:account:participants wallet:multisig:participants

dkg

wallet:multisig:dkg:create wallet:multisig:dkg:round1 wallet:multisig:dkg:round2 wallet:multisig:dkg:round3

config

config config:edit config:get config:set

peers

peers peers:show

chain

chain:show chain:repair chain:asset chain:export chain:forks chain:download

blocks

blocks:show

workers

workers:status

miners

miners:start miners:pools:start

Recipes

Creating Transactions Validating Deposits Combining Notes Maximizing Transaction Size Splitting Notes Export Transactions for Accounting

Multisig

Creating Multisig Accounts Creating Multisig Accounts With DKG Signing Transactions with Multisig Accounts

RPC

Usage Protocol

Routes

Response Objects

RpcAccountAssetBalanceDelta RpcAccountStatus RpcAsset RpcBlock RpcBlockHeader RpcBurn RpcEncryptedNote RpcMint RpcPeerResponse RpcSpend RpcTransaction RpcWalletNote RpcWalletTransaction

Chain

broadcastTransaction estimateFeeRate estimateFeeRates exportChainStream followChainStream getAsset getBlock getChainInfo getConsensusParameters getDifficulty getNetworkHashPower getNetworkInfo getNoteWitness getTransaction getTransactionStream showChain isValidPublicAddress

Config

getConfig setConfig unsetConfig uploadConfig

Event

onGossip onReorganizeChain onTransactionGossip

Faucet

getFunds

Mempool

acceptTransaction getStatus getTransactions

Miner

blockTemplateStream submitBlock

Node

getLogStream getStatus stopNode

Peer

addPeer getBannedPeers getPeer getPeers getPeerMessages

RPC

getStatus

Wallet

Multisig

getParticipant getParticipants createParticipant createTrustedDealerKeyPackage createSiginingCommitment createSigningPackage createSignatureShare aggregateSignatureShares

DKG

round1 round2 round3

addTransaction buildTransaction burnAsset create [DEPRECATED]createAccount createTransaction decrypt encrypt estimateFeeRates exportAccount getAccounts getAccountNotesStream getAccountsStatus getAccountStatus getAccountTransaction getAccountTransactions getAsset getAssets getBalance getBalances getDefaultAccount getNodeStatus getUnsignedTransactionNotes getNotes getPublicKey importAccount lock mintAsset postTransaction remove [DEPRECATED]removeAccount rename [DEPRECATED]renameAccount rescan resetAccount sendTransaction setAccountHead setScanning signTransaction unlock useAccount

Worker

getStatus

Contribute To Iron Fish

Lint and Format Release Versioning Hardfork Update Process

chain/getDifficulty

Gets block difficulty from a sequence.

If no sequence is provided, the head will be used

Request

{
  sequence?: number | null
} | undefined

Response

{
  sequence: number;
  hash: string;
  difficulty: string;
}