This guide provides an overview of the exrpd CLI (Command-Line Interface) for the XRPL EVM Sidechain. It is intended for newcomers who want to explore and interact with their own node at a deeper level. You will find the main commands and subcommands below, along with short descriptions of what they do and tips on how to use them.
The exrpd CLI is organized into primary commands. Each command may have one or more subcommands. To list subcommands, you can run:
exrpd <command> --helpor, to see the main help, simply run:
exrpd --helpThis displays usage, available commands, and descriptions for each command. The following sections cover each major command category in more detail.
Use the config command to manage node configuration. This is helpful for setting up or inspecting config files.
| Subcommand | Description |
|---|---|
diff | Outputs config values that differ from defaults for a given target version and app.toml path. |
get | Displays the current value of a specific configuration parameter. |
home | Prints the folder used as the binary home directory. (When using confix standalone, no home is set.) |
migrate | Migrates a Cosmos SDK app configuration file to a specified version. |
set | Sets a new value for a given configuration parameter. |
view | Displays the entire configuration file. |
Examples
- Check all deviations from default config:
exrpd config diff <target-version> ~/.exrpd/config/app.toml - Get a specific config value:
exrpd config get <key_name> - Set a config value:
exrpd config set <key_name> <new_value> - Display current config file contents:
exrpd config view app
Use the keys command to manage local keys (private/public key pairs) for your application. This includes creating new keys, importing/exporting existing keys, and more.
Managing your node’s keys is essential. If you plan to operate a production node or validator, make sure to review the advanced key management configurations on the Managing keys page.
| Subcommand | Description |
|---|---|
add | Generate or recover a key, encrypt it locally, and save it under a specified name. |
delete | Delete an existing key from local storage. |
export | Export a private key (either encrypted or unencrypted, depending on flags used). |
import | Import a previously exported private key into the local keybase. |
list | List all locally stored keys. |
list-key-types | List supported key algorithms available for key creation. |
migrate | Migrate keys from Amino to Proto serialization format. |
mnemonic | Generate or compute the BIP39 mnemonic from supplied entropy. |
parse | Convert an address between hex and Bech32 encoding. |
rename | Rename an existing local key. |
show | Show information about a key, including its public address. |
unsafe-export-eth-key | UNSAFE: Export an Ethereum private key. Use with caution. |
unsafe-import-eth-key | UNSAFE: Import an Ethereum private key into the local keybase. Use with caution. |
Examples
- Create a new key:
exrpd keys add myNewKey - List existing keys:
exrpd keys list - List supported key types:
exrpd keys list-key-types - Export a key:
exrpd keys export myNewKey - Delete a key:
exrpd keys delete myNewKey
The query command allows you to query data from various modules, transactions, blocks, or on-chain states. Use exrpd query <subcommand> --help for more on how to craft your queries.
Below is a list of subcommands within query:
| Subcommand | Description |
|---|---|
auth | Query for authentication module data. |
authz | Query for authorization module data. |
bank | Query bank balances and other bank module data. |
block | Query a committed block by height, hash, or matching events. |
block-results | Query the results of a committed block by height. |
blocks | Query paginated blocks that match a set of events. |
comet-validator-set | Query the full CometBFT validator set at a specific block height. |
consensus | Query for consensus parameters. |
distribution | Query for distribution module data (rewards, commissions, etc.). |
erc20 | Query ERC-20 contract-related information. |
evidence | Query evidence of misbehavior. |
evm | Query EVM module data. |
feegrant | Query for fee grant allowances. |
feemarket | Query data from the fee market module. |
gov | Query governance proposals, votes, deposits, and more. |
ibc | Query Inter-Blockchain Communication (IBC) data. |
ibc-transfer | Query for IBC token transfer details. |
interchain-accounts | Query IBC interchain accounts (the host module is disabled on the network). |
params | Query for on-chain parameters. |
poa | Query for Proof-of-Authority module data. |
ratelimit | Query the rate-limit module data. |
slashing | Query data related to slashing, signing info, and parameters. |
staking | Query staking information (validators, delegations, unbonding, etc.). |
tx | Query a single transaction by its hash, "address/seq" combination, or signature. |
txs | Query multiple transactions using events. |
upgrade | Query network upgrade plans. |
wait-tx | Wait for a transaction to be included in a block. |
Examples
- Check an account balance:
exrpd query bank balances <account_address> - Query the latest block:
exrpd query block - Lookup a transaction by hash:
exrpd query tx <tx_hash>
The tx command handles transactions that change the state of the chain. Here, you can create, sign, broadcast, and simulate transactions.
Below is a list of subcommands within tx:
| Subcommand | Description |
|---|---|
auth | Send transactions related to the auth module. |
authz | Authorization transaction subcommands (grant, revoke, etc.). |
bank | Send tokens and manage bank-related transactions. |
broadcast | Broadcast offline-generated transactions to the network. |
consensus | Manage consensus-related transactions. |
crisis | Submit proof that an invariant is broken. |
decode | Decode a binary-encoded transaction string. |
distribution | Manage distribution transactions (withdraw rewards, set commission, etc.). |
encode | Encode offline-generated transactions. |
erc20 | Manage ERC-20-related transactions. |
evidence | Submit evidence of misbehavior. |
evm | Manage EVM-related transactions (deployment, contract calls, etc.). |
feegrant | Feegrant transaction subcommands. |
feemarket | Manage the fee market module transactions. |
gov | Governance transactions (submit proposals, vote, deposit, etc.). |
ibc | IBC transaction subcommands. |
ibc-transfer | IBC fungible token transfer transactions. |
interchain-accounts | IBC interchain accounts subcommands (the host module is disabled). |
multi-sign | Generate multisig signatures for offline-generated transactions. |
multisign-batch | Assemble multisig transactions in batch from batch signatures. |
poa | Proof-of-Authority module transaction commands. |
ratelimit | Ratelimit module transaction commands. |
sign | Sign an offline-generated transaction with a local key. |
sign-batch | Sign multiple transactions in batch. |
simulate | Simulate a transaction to estimate gas usage. |
slashing | Submit slashing-related transactions. |
staking | Staking transactions. Only edit-validator applies under PoA. |
upgrade | Submit upgrade plan transactions. |
validate-signatures | Validate the signatures of a transaction. |
Examples
- Send tokens from one account to another:
exrpd tx bank send <from_address> <to_address> <amount>axrp --gas auto --gas-adjustment 1.2 --gas-prices 571000000axrp - Propose a governance change:
exrpd tx gov submit-proposal <proposal.json> --from <key_name> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrp - Simulate gas usage for a transaction:
exrpd tx simulate /path/to/unsigned-tx.json --from <key_name>
Prints the exrpd application’s binary version information. This can be helpful to ensure you are on the correct version of the XRPL EVM sidechain software.
Example
exrpd versionIn addition to config, keys, query, and tx, the current exrpd binary also includes:
cometdebugexportgenesisindex-eth-txinitprunerollbacksnapshotsstartstatusunsafe-start-local-validator
Use the correct chain ID for your target network from Networks and replace <chain-id> in examples below.
Many commands in this section are state-changing transactions and require:
- a funded wallet,
- a valid
--fromkey in your keyring, - and a reachable RPC endpoint.
Use --help first if you are unsure about required flags.
Since v11, the default keyring backend is os (earlier binaries defaulted to test). If your keys live in another backend, set it with exrpd config set client keyring-backend <backend> or pass --keyring-backend on each command. Otherwise, commands fail with key not found.
The native token denom is axrp, with 18 decimals: 1 XRP = 1000000000000000000axrp. Transactions must pay at least the network minimum gas price of 571000000axrp (0.571 gwei) per unit of gas, so the examples below pass --gas-prices 571000000axrp. Check the current value with exrpd query feemarket params.
This section lists exrpd commands for common tasks: managing wallets, operating a validator and taking part in governance.
Add New Wallet
exrpd keys add $WALLETRestore Wallet from Mnemonic
exrpd keys add $WALLET --recoverList All Wallets
exrpd keys listDelete a Wallet
exrpd keys delete $WALLETCheck Wallet Balance
exrpd query bank balances $WALLET_ADDRESSExport Wallet Key (Save to File)
exrpd keys export $WALLET > wallet.backupView EVM Private Key
exrpd keys unsafe-export-eth-key $WALLETImport Wallet Key (Restore from Backup)
exrpd keys import $WALLET wallet.backupWithdraw All Rewards
exrpd tx distribution withdraw-all-rewards --from $WALLET --chain-id <chain-id> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrpWithdraw Rewards + Commission
exrpd tx distribution withdraw-rewards $VALOPER_ADDRESS --from $WALLET --commission --chain-id <chain-id> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrp -yTransfer Funds (1 XRP)
exrpd tx bank send $WALLET_ADDRESS <TO_WALLET_ADDRESS> 1000000000000000000axrp --chain-id <chain-id> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrp -yThe XRPL EVM uses Proof of Authority: the validator set and voting power are managed by the poa module through governance. delegate, redelegate, unbond, cancel-unbond and create-validator transactions are rejected by the network.
Join the Validator Set
Validators are added by governance with a MsgAddValidator proposal. See Join the Proof of Authority.
Leave the Validator Set
exrpd tx poa self-remove-validator --from $WALLET --chain-id <chain-id> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrp -yEdit Existing Validator Info
exrpd tx staking edit-validator \
--commission-rate 0.1 \
--new-moniker "$MONIKER" \
--identity "" \
--details "I love blockchain" \
--from $WALLET \
--chain-id <chain-id> \
--gas auto --gas-adjustment 1.5 \
--gas-prices 571000000axrp \
-yCheck Validator Status
exrpd status 2>&1 | jqGet Validator Details
exrpd query staking validator $(exrpd keys show $WALLET --bech val -a)Check Jailing Info
exrpd query slashing signing-info $(exrpd comet show-validator)Check Slashing Parameters
exrpd query slashing paramsUnjail Validator
exrpd tx slashing unjail --from $WALLET --chain-id <chain-id> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrp -yList Active Validators
exrpd query staking validators -o json --page-limit 2000 | jq -r '.validators[] | select(.status=="BOND_STATUS_BONDED") | .description.moniker' | sort | nlCheck Validator Key Consistency
[[ $(exrpd query staking validator $VALOPER_ADDRESS -o json | jq -r .validator.consensus_pubkey.value) = $(exrpd status | jq -r .validator_info.pub_key.value) ]] && echo -e "Your key status is ok" || echo -e "Your key status is error"Submit a Proposal
Proposals are submitted as a JSON file. exrpd tx gov draft-proposal generates one interactively. A text proposal has no messages:
{
"messages": [],
"metadata": "",
"deposit": "500000000000000000000axrp",
"title": "<title>",
"summary": "<summary>",
"expedited": false
}exrpd tx gov submit-proposal proposal.json \
--from $WALLET \
--chain-id <chain-id> \
--gas auto --gas-adjustment 1.5 \
--gas-prices 571000000axrp \
-yThe minimum deposit is 500 XRP (500000000000000000000axrp), or 1,000 XRP for an expedited proposal. Check the current governance parameters with exrpd query gov params.
List Proposals
exrpd query gov proposalsView a Proposal
exrpd query gov proposal 1Vote on a Proposal
exrpd tx gov vote 1 yes --from $WALLET --chain-id <chain-id> --gas auto --gas-adjustment 1.5 --gas-prices 571000000axrpIf you want to learn more about exrpd, you can explore the following resources:
- Upgrading your node: learn how to upgrade your node to the latest version.
- Node configuration options: discover configuration options for fine-tuning your node.