Skip to main content

Wallet RPC: Overview

The Mintlayer wallet exposes a JSON-RPC 2.0 interface that allows programmatic control of the wallet, generating addresses, querying balances, submitting transactions, managing staking pools, and more.

The RPC interface is provided by wallet-rpc-daemon (headless) or by wallet-cli when started with --enable-wallet-rpc-interface.

Connection​

Both HTTP and WebSocket are served on the same port:

NetworkDefault port
Mainnet3034
Testnet13034

WebSocket is a superset of HTTP: it supports all RPC methods plus real-time event subscriptions.

Protocol​

All calls use the JSON-RPC 2.0 format:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "method_name",
  "params": { ... }
}

JavaScript Helper​

The examples throughout this documentation use the following helper:

async function rpc(method, params = {}, { host = '127.0.0.1', port = 3034 } = {}) {
  const res = await fetch(`http://${host}:${port}`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ jsonrpc: '2.0', id: 1, method, params }),
  });
  const json = await res.json();
  if (json.error) throw new Error(`RPC error ${json.error.code}: ${json.error.message}`);
  return json.result;
}

For testnet, pass { port: 13034 } as the third argument. If authentication is enabled, add credentials to the URL: http://user:pass@127.0.0.1:3034.

Example: get node version​

const result = await rpc('node_version');
console.log(result.version);

Value Representations​

TypeFormat
Addresses, pool ids, delegation ids, token idsbech32 string
Account idhex string
Coin / token amountsObject with atoms (integer string) and decimal (decimal string)
Block ids, transaction idshex string

Amounts can be specified as either:

{ "atoms": "100000000000" }

or:

{ "decimal": "1.0" }

Modules​

The RPC is split into two modules:

  • WalletRpc, All methods available in hot wallet mode (node connected).
  • ColdWalletRpc, Subset of methods available in cold wallet mode (no node connection needed). Includes wallet/account management, address generation, signing, and key management.

Authentication​

By default the RPC has no authentication. To enable it, start the daemon with --rpc-username and --rpc-password. Credentials are passed as HTTP Basic Auth in the URL.

Pages in This Section​

  • Wallet Management, Create, open, close wallets; manage accounts, addresses, encryption
  • Transactions, Send, compose, inspect, and list transactions
  • Staking, Create and manage pools and delegations
  • Tokens, Issue and manage fungible tokens and NFTs
  • Events, WebSocket event subscriptions