RPC command reference

Command definitions

All RPC request/response structs are defined in:

src/Rpc/CoreRpcServerCommandsDefinitions.h

Daemon-side RPC commands use COMMAND_RPC_ prefix. Wallet-side commands use WALLET_RPC_COMMAND_ prefix.

Adding a new daemon endpoint

Define command structs

Add COMMAND_RPC_YOUR_ENDPOINT with request and response inner structs to CoreRpcServerCommandsDefinitions.h. Use KV_SERIALIZE / KV_MEMBER macros for JSON serialization.

Declare handler in RpcServer.h

bool on_your_endpoint(
  const COMMAND_RPC_YOUR_ENDPOINT::request& req,
  COMMAND_RPC_YOUR_ENDPOINT::response& res
);

Add to the s_handlers map in RpcServer.cpp:

{"/your_endpoint", {&RpcServer::on_your_endpoint, false}},

The false means the endpoint does not require a running blockchain (set true if it does).

Implement the handler

Follow existing handlers like on_get_fee_pool_info as a model. Access core state via m_core.

Key access patterns

// Fee pool state
m_core.get_blockchain_storage().getFeePoolBalance()
m_core.get_blockchain_storage().getTreasuryBalance()

// Epoch data
m_core.getCommitmentIndex().getEpochCount()
m_core.getCommitmentIndex().getEpochReport(epochN)

// Interest calculation
m_core.currency().calculateCdInterest(
  amount, creationHeight, currentHeight,
  m_core.getCommitmentIndex()
)

// Current height
m_core.get_current_blockchain_height()

Wallet RPC

Wallet-side RPC handlers live in:

src/Wallet/WalletRpcServer.h — declarations
src/Wallet/WalletRpcServer.cpp — implementations

Wallet RPC handlers access the wallet via m_wallet (a WalletGreen reference).

Serialization macros

// In command struct request/response:
BEGIN_KV_SERIALIZE_MAP()
  KV_SERIALIZE(field_name)
  KV_SERIALIZE_OPT(optional_field, default_value)
  KV_MEMBER(field_name)  // alternative syntax
END_KV_SERIALIZE_MAP()

Start

Getting started

Architecture

HEAT

HEAT CDs

Hearth

swapXFG

Tutorials

API reference

Security

Developer

Optional / other

RPC command reference

Command definitions

Adding a new daemon endpoint

Key access patterns

Wallet RPC

Serialization macros

​Command definitions

​Adding a new daemon endpoint

​Key access patterns

​Wallet RPC

​Serialization macros

Command definitions

Adding a new daemon endpoint

Key access patterns

Wallet RPC

Serialization macros