Common RPC v0 API Reference
Introduction
The Common RPC API provides a foundational set of methods that are available on all Ixian node types, including DLT, S2, and client-facing nodes. These endpoints allow applications to manage wallets, create transactions, query the network, and perform basic node administration.
All endpoints are accessible via HTTP GET or HTTP POST requests and follow the standard JSON-RPC 2.0 specification.
Node & Network Management
These methods are used to control the node's process and manage its P2P network connections.
| Method | Description |
|---|---|
shutdown | Initiates a graceful shutdown of the node. |
reconnect | Forces the node to disconnect and reconnect to the network. |
connect | Manually instructs the node to establish a connection to a specific peer. |
isolate | Immediately disconnects the node from all peers. |
blacklistPeer | Adds a peer's IP address to the blacklist, preventing future connections. |
clearPeerBlacklist | Clears all entries from the peer blacklist. |
Wallet Management
These methods are used to handle the node's local wallets, including loading, unloading, creating addresses, and performing backups.
| Method | Description |
|---|---|
listWallets | Lists all wallet files available in the node's wallet directory. |
loadWallet | Loads a specified wallet into memory, making it active. |
unloadWallet | Unloads a specified wallet from memory, making it inactive. |
generateNewAddress | Generates a new address for the primary loaded wallet. |
getWalletBackup | Retrieves a Base64-encoded backup of the primary wallet file. |
getViewingWallet | Creates a new wallet file that only has viewing permissions. |
Transaction Handling
These methods are used to create, sign, decode, and broadcast transactions to the network.
| Method | Description |
|---|---|
addTransaction | A high-level method to create, fund, and broadcast a standard transaction. |
calculateTransactionFee | Calculates the required fee for a transaction with a given data size. |
createRawTransaction | Creates an unsigned transaction in its raw, hex-encoded format. |
signRawTransaction | Signs a raw, hex-encoded transaction with the primary wallet's key. |
sendRawTransaction | Broadcasts a signed, raw, hex-encoded transaction to the network. |
decodeRawTransaction | Decodes a raw, hex-encoded transaction into its JSON representation. |
Ixian Name System (IXI-NS)
These methods provide a high-level interface for registering and managing names on the Ixian network.
| Method | Description |
|---|---|
registerName | Registers a new name in the IXI-NS. |
extendName | Extends the registration period for an existing name. |
updateNameCapacity | Changes the data capacity and/or owner of a name. |
updateNameRecord | Adds, updates, or removes data records associated with a name. |
recoverName | Recovers control of a name using its designated recovery address. |
decodeNameData | Decodes the raw data payload from an IXI-NS transaction. |
Information & Queries
These methods are used to get status, balances, and other data from the node and network.
| Method | Description |
|---|---|
status | Retrieves a comprehensive overview of the node's current state. |
blockHeight | Retrieves the block number of the most recent block. |
getTotalBalance | Retrieves the total combined balance of all loaded wallets. |
myWallet | Retrieves the primary address of the loaded wallet. |
myPubKey | Retrieves the full public key of the primary loaded wallet. |
clients | Lists all clients currently connected to the node's server. |
servers | Lists all servers (peers) the node is currently connected to. |
getPresence | Retrieves the presence data for a specific Ixian address. |
getSectorNodes | Retrieves the list of S2 nodes responsible for a given sector. |
activity2 | Retrieves the transaction history for a specific wallet address. |
Cryptographic Utilities
These methods provide access to the node's cryptographic functions for signing messages and validating addresses.
| Method | Description |
|---|---|
sign | Signs an arbitrary message with the primary wallet's private key. |
verify | Verifies a signature against a message and a public key. |
validateAddress | Checks if a given string is a valid Ixian address. |