Guide to Monero RPC

Tech

By Monero Coin August 21, 2024

Monero (XMR) is a privacy-focused cryptocurrency that operates on a decentralized, secure, and anonymous blockchain. To interact with the Monero network programmatically, developers typically use the Monero Remote Procedure Call (RPC) interface. This guide provides an overview of Monero RPC, its core functions, and how to utilize it effectively for various tasks such as querying the blockchain, managing wallets, and sending transactions.

Table of Contents

What is Monero RPC?

Monero RPC (Remote Procedure Call) is an interface that allows developers to communicate with the Monero daemon (`monerod`) and the Monero wallet RPC server (monero-wallet-rpc). By using RPC commands, developers can programmatically interact with the Monero network, automate tasks, and integrate Monero functionalities into applications.

Key Components:

monerod: The Monero daemon responsible for running a full Monero node, synchronizing with the Monero network, and providing access to the blockchain.
monero-wallet-rpc: A wallet server that allows developers to manage Monero wallets, including creating, opening, and managing wallets, as well as sending and receiving transactions.

Setting Up Monero RPC

Before you can start using Monero RPC, you need to set up the Monero daemon and wallet RPC server. Below is a brief overview of the setup process.

1. Running the Monero Daemon (monerod)

The Monero daemon must be running to synchronize with the Monero network and provide access to blockchain data.

./monerod --rpc-bind-ip 0.0.0.0 --rpc-bind-port 18081

–rpc-bind-ip: The IP address to bind the RPC interface (0.0.0.0 binds to all interfaces).
–rpc-bind-port: The port to use for the RPC interface (default is 18081).

2. Running the Monero Wallet RPC (monero-wallet-rpc)

The Monero wallet RPC server allows you to manage wallets and interact with them programmatically.

./monero-wallet-rpc --wallet-file /path/to/wallet --password "your_wallet_password" --rpc-bind-port 18083 --daemon-address http://127.0.0.1:18081

–wallet-file: Path to the wallet file.
–password: Password for the wallet.
–rpc-bind-port: The port for the wallet RPC server (default is 18083).
–daemon-address: The address of the Monero daemon.

Common Monero RPC Commands

Once your setup is complete, you can use various RPC commands to interact with the Monero network. Below are some of the most commonly used commands.

1. Blockchain Commands (monerod)

These commands allow you to query the Monero blockchain for information.

get_block: Retrieve a block by its height or hash.

{
"method": "get_block",
"params": {
"height": 123456
}
}

get_transaction_pool: Get the list of transactions in the transaction pool (mempool).

{
"method": "get_transaction_pool"
}

get_info: Get general information about the daemon’s state.

{
"method": "get_info"
}

get_block_count: Retrieve the current block height of the blockchain.

{
"method": "get_block_count"
}

2. Wallet Commands (monero-wallet-rpc)

These commands help you manage wallets, transactions, and addresses.

get_balance: Get the balance of the wallet.

{
"method": "get_balance"
}

get_address: Retrieve the wallet’s address.

{
"method": "get_address"
}

transfer: Send XMR to a specified address.

{
"method": "transfer",
"params": {
"destinations": [{"amount": 1000000000, "address": "YOUR_MONERO_ADDRESS"}],
"priority": 1
}
}

create_address: Create a new sub-address in the wallet.

{
"method": "create_address",
"params": {
"account_index": 0,
"label": "New Subaddress"
}
}

get_payments: Retrieve incoming payments to the wallet.

{
"method": "get_payments",
"params": {
"payment_id": "your_payment_id"
}
}

sweep_all: Send all unlocked funds in the wallet to a specified address.

{
"method": "sweep_all",
"params": {
"address": "YOUR_MONERO_ADDRESS"
}
}

3. Advanced Commands

Advanced users may need to access more complex functionalities, such as multisig wallets or atomic swaps.

make_multisig: Convert a wallet to a multisig wallet.

{
"method": "make_multisig",
"params": {
"multisig_info": ["multisig_info_from_other_wallets"],
"threshold": 2,
"password": "your_wallet_password"
}
}

exchange_multisig_keys: Exchange multisig keys between wallets to set up a multisig wallet.

{
"method": "exchange_multisig_keys",
"params": {
"password": "your_wallet_password",
"multisig_info": ["multisig_info_from_other_wallets"]
}
}

sign_multisig: Sign a multisig transaction.

{
"method": "sign_multisig",
"params": {
"tx_data_hex": "transaction_hex"
}
}

Security Considerations

When using Monero RPC, it is crucial to ensure the security of your setup:

Secure the RPC Interface: Always bind the RPC interface to a secure, private IP address or localhost, and avoid exposing it directly to the internet.
Authentication: Consider enabling RPC login credentials to prevent unauthorized access.
Encryption: Use SSL/TLS encryption for RPC communication, especially if the interface is accessed remotely.