Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

RPC API

The node speaks Bitcoin-style JSON-RPC. Familiar calls (getblockcount, getrawtransaction, sendrawtransaction…) work as expected; this page lists what is BATHRON-specific.

State and consensus

RPCReturns
getstateglobal settlement state + live check of the monetary invariants
getfinalitystatusfinality height, lag, average delay
getactivemnstatusthis node's masternode status

Bitcoin integration

RPCReturns
getbtcheadersstatusthe in-consensus Bitcoin header chain (tip, work, sync)
getbtcheaderstiptip of the header database
submitburnclaimsubmit an SPV proof of a Bitcoin burn

Settlement

RPCAction
lock <amount>vault M0 → M1 receipt (1:1)
unlock <amount>M1 receipt → M0 (1:1)
transfer_m1 <outpoint> <addr>transfer a receipt
getwalletstate truebalances including receipts

Privacy

RPCAction
getnewshieldaddressnew shielded address
shieldsendmanyshielded payment

Full per-command help is available from the node itself: bathron-cli help <command>.