Struct Client

pub struct Client { /* private fields */ }

The Client.

Implementations

impl Client

pub fn new(sender: RpcChannel) -> Self

Creates a new Client.

pub fn exit(&self) -> impl Future<Output = RpcResult<()>>

Immediately shuts down the RPC server.

This administrative endpoint is typically used during controlled shutdowns of the validator or service exposing the RPC interface. It allows remote administrators to gracefully terminate the process, stopping all RPC activity.

Returns

• [Result<()>] — A unit result indicating successful shutdown, or an error if the call fails.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 42,
  "method": "exit",
  "params": []
}

Notes

• This method is privileged and should only be accessible to trusted clients.
• Use with extreme caution in production environments.
• If successful, the RPC server process will terminate immediately after processing this call.

Security

Access to this method should be tightly restricted. Implement proper authorization mechanisms via the RPC metadata to prevent accidental or malicious use.

pub fn reload_plugin( &self, name: String, config_file: String, ) -> impl Future<Output = RpcResult<()>>

pub fn unload_plugin(&self, name: String) -> impl Future<Output = RpcResult<()>>

Reloads a runtime plugin with new configuration.

This administrative endpoint is used to dynamically reload a plugin without restarting the entire RPC server or validator. It is useful for applying updated configurations to a plugin that supports hot-reloading.

Parameters

• name: The identifier of the plugin to reload.
• config_file: Path to the new configuration file to load for the plugin.

Returns

• [BoxFuture<Result<()>>] — A future resolving to a unit result on success, or an error if reloading fails.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 101,
  "method": "reloadPlugin",
  "params": ["myPlugin", "/etc/plugins/my_plugin_config.toml"]
}

Notes

• The plugin must support reloading in order for this to succeed.
• A failed reload will leave the plugin in its previous state.
• This method is intended for administrators and should be properly secured.

Security

Ensure only trusted clients can invoke this method. Use metadata-based access control to limit exposure.

pub fn load_plugin( &self, config_file: String, ) -> impl Future<Output = RpcResult<String>>

Dynamically loads a new plugin into the runtime from a configuration file.

This administrative endpoint is used to add a new plugin to the system at runtime, based on the configuration provided. It enables extensibility without restarting the validator or RPC server.

Parameters

• config_file: Path to the plugin’s configuration file, which defines its behavior and settings.

Returns

• BoxFuture<Result<String>> — A future resolving to the name or identifier of the loaded plugin, or an error if the plugin could not be loaded.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 102,
  "method": "loadPlugin",
  "params": ["/etc/plugins/my_plugin_config.toml"]
}

Notes

• The plugin system must be initialized and support runtime loading.
• The config file should be well-formed and point to a valid plugin implementation.
• Duplicate plugin names may lead to conflicts or errors.

Security

This method should be restricted to administrators only. Validate inputs and use access control.

pub fn list_plugins(&self) -> impl Future<Output = RpcResult<Vec<String>>>

Returns a list of all currently loaded plugin names.

This administrative RPC method is used to inspect which plugins have been successfully loaded into the runtime. It can be useful for debugging or operational monitoring.

Returns

• Vec<String> — A list of plugin names currently active in the system.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 103,
  "method": "listPlugins",
  "params": []
}

Example Response

{
  "jsonrpc": "2.0",
  "result": ["tx_filter", "custom_logger"],
  "id": 103
}

Notes

• Only plugins that have been successfully loaded will appear in this list.
• This method is read-only and safe to call frequently.

pub fn rpc_addr(&self) -> impl Future<Output = RpcResult<Option<SocketAddr>>>

Returns the address of the RPC server.

This RPC method retrieves the network address (IP and port) the RPC server is currently listening on. It can be useful for service discovery or monitoring the server’s network status.

Returns

• Option<SocketAddr> — The network address of the RPC server, or None if no address is available.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 104,
  "method": "rpcAddress",
  "params": []
}

Example Response

{
  "jsonrpc": "2.0",
  "result": "127.0.0.1:8080",
  "id": 104
}

Notes

• This method is useful for finding the address of a running RPC server, especially in dynamic environments.
• If the server is not configured or is running without network exposure, the result may be None.

pub fn set_log_filter( &self, filter: String, ) -> impl Future<Output = RpcResult<()>>

Sets a filter for log messages in the system.

This RPC method allows the user to configure the logging level or filters applied to the logs generated by the system. It enables fine-grained control over which log messages are captured and how they are displayed or stored.

Parameters

• filter: A string representing the desired log filter. This could be a log level (e.g., info, debug, error), or a more complex filter expression depending on the system’s logging configuration.

Returns

• () — A unit result indicating the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 105,
  "method": "setLogFilter",
  "params": ["debug"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 105
}

Notes

• The filter parameter should be consistent with the logging framework used by the system.
• Valid filter values might include common log levels such as trace, debug, info, warn, error, or other custom filters.
• This method allows dynamic control of the log output, so it should be used cautiously in production environments.

pub fn start_time(&self) -> impl Future<Output = RpcResult<SystemTime>>

Returns the system start time.

This RPC method retrieves the timestamp of when the system was started, represented as a SystemTime. It can be useful for measuring uptime or for tracking the system’s runtime in logs or monitoring systems.

Returns

• SystemTime — The timestamp representing when the system was started.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 106,
  "method": "startTime",
  "params": []
}

Example Response

{
  "jsonrpc": "2.0",
  "result": "2025-04-24T12:34:56Z",
  "id": 106
}

Notes

• The result is a SystemTime in UTC, reflecting the moment the system was initialized.
• This method is useful for monitoring system uptime and verifying system health.

pub fn add_authorized_voter( &self, keypair_file: String, ) -> impl Future<Output = RpcResult<()>>

Adds an authorized voter to the system.

This RPC method allows an authorized user to add a new voter to the list of authorized voters. A voter is typically an entity that can participate in governance actions, such as voting on proposals or other decision-making processes.

Parameters

• keypair_file: A string representing the path to the file containing the keypair of the new voter. The keypair is used to authenticate and authorize the voter to participate in governance.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 107,
  "method": "addAuthorizedVoter",
  "params": ["path/to/voter_keypair.json"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 107
}

Notes

• This method typically requires administrative or elevated permissions to execute.
• The keypair_file should contain a valid keypair for the new voter, formatted according to the system’s expectations.
• Once added, the new voter will be able to participate in governance actions.

pub fn add_authorized_voter_from_bytes( &self, keypair: Vec<u8>, ) -> impl Future<Output = RpcResult<()>>

Adds an authorized voter to the system using a byte-encoded keypair.

This RPC method allows an authorized user to add a new voter by directly providing the keypair in the form of a byte vector (Vec<u8>). This can be useful for systems where keypairs are serialized or passed in a non-file-based format.

Parameters

• keypair: A vector of bytes representing the keypair of the new voter. This keypair will be used to authenticate and authorize the voter to participate in governance actions.

Returns

• () — A unit result indicating the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 108,
  "method": "addAuthorizedVoterFromBytes",
  "params": ["<base64-encoded-keypair>"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 108
}

Notes

• This method allows for adding a voter directly from a byte-encoded keypair, which may be useful for systems that store keypairs in non-traditional formats (e.g., databases, serialized data).
• The keypair should be provided in the correct format expected by the system (typically a base64 or raw binary format).
• This method typically requires administrative or elevated permissions to execute.
• Once added, the new voter will be able to participate in governance actions.

pub fn remove_all_authorized_voters( &self, ) -> impl Future<Output = RpcResult<()>>

Removes all authorized voters from the system.

This RPC method removes all voters from the list of authorized voters. This action is typically an administrative function and may be used to reset or clean up the list of voters in the system.

Parameters

• None.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 109,
  "method": "removeAllAuthorizedVoters",
  "params": []
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 109
}

Notes

• This method will remove all voters and may not be reversible. It is a critical operation that typically requires elevated administrative permissions.
• Use this method with caution as it will prevent any previously authorized voter from participating in governance actions until they are re-added.

pub fn set_identity( &self, keypair_file: String, require_tower: bool, ) -> impl Future<Output = RpcResult<()>>

Sets the identity for the system using the provided keypair.

This RPC method allows you to set the system’s identity by specifying a keypair file. The identity set here is typically used to authenticate the system and validate its actions in governance or other sensitive operations. The require_tower flag ensures that a specific security feature, called “tower,” is enabled for the identity.

Parameters

• keypair_file: The file path to the keypair that will be used to set the system’s identity.
• require_tower: A boolean flag indicating whether the tower security feature should be enforced for this identity.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 110,
  "method": "setIdentity",
  "params": ["/path/to/keypair.json", true]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 110
}

Notes

• This method allows for setting the identity of the system, which could have security and governance implications. It is typically used when initializing or reconfiguring the system’s identity.
• The require_tower flag is optional but can be used to add an extra layer of security for the identity.
• The method usually requires administrative permissions and a valid keypair to execute.

pub fn set_identity_from_bytes( &self, identity_keypair: Vec<u8>, require_tower: bool, ) -> impl Future<Output = RpcResult<()>>

Sets the identity for the system using a keypair provided as a byte array.

This RPC method allows you to set the system’s identity by directly providing a byte array representing the keypair. The require_tower flag is used to enforce the “tower” security feature for this identity, if needed.

Parameters

• identity_keypair: A byte array representing the keypair to set the system’s identity.
• require_tower: A boolean flag indicating whether the tower security feature should be enforced for this identity.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 111,
  "method": "setIdentityFromBytes",
  "params": [[72, 101, 108, 108, 111], true]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 111
}

Notes

• This method is useful for scenarios where the keypair is not stored in a file but is instead available as a byte array (e.g., for programmatically generated keypairs).
• The require_tower flag, when set to true, enforces additional security for the identity.
• The method typically requires administrative permissions to execute.

pub fn set_staked_nodes_overrides( &self, path: String, ) -> impl Future<Output = RpcResult<()>>

Sets the overrides for staked nodes using a specified path.

This RPC method allows you to configure overrides for staked nodes by specifying the path to a configuration file. This is typically used for adjusting the parameters or behavior of the staked nodes in the system, such as custom settings for node management or staking operations.

Parameters

• path: The file path to the configuration file that contains the staked node overrides. This file should define the necessary settings for overriding the default staked node configuration.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 112,
  "method": "setStakedNodesOverrides",
  "params": ["/path/to/overrides.json"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 112
}

Notes

• This method is used for overriding the configuration of staked nodes in the system. The path parameter should point to a file that contains the necessary overrides.
• It may require administrative permissions to modify the staked node configurations.
• The path file should be in a format understood by the system (e.g., JSON, YAML).

pub fn repair_shred_from_peer( &self, pubkey: Option<Pubkey>, slot: u64, shred_index: u64, ) -> impl Future<Output = RpcResult<()>>

Repairs a shred from a peer node in the network.

This RPC method triggers the repair of a specific shred from a peer node, using the given pubkey (if provided), slot, and shred_index. This is typically used in cases where a shred is missing or corrupted and needs to be retrieved from another node in the network.

Parameters

• pubkey (Optional): The public key of the node from which to request the shred. If None, the system may choose any peer to attempt the repair from.
• slot: The slot number where the shred is located.
• shred_index: The index of the specific shred within the given slot that needs repair.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 113,
  "method": "repairShredFromPeer",
  "params": ["PubkeyHere", 12345, 6789]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 113
}

Notes

• The method may require specific network configurations or permissions to allow for the repair of the shred.
• If the pubkey is provided, the system will attempt to retrieve the shred from the specified peer node. Otherwise, it will attempt the repair from any available node in the network.

pub fn set_repair_whitelist( &self, whitelist: Vec<Pubkey>, ) -> impl Future<Output = RpcResult<()>>

Sets the whitelist of nodes allowed to repair shreds.

This RPC method sets a list of nodes (identified by their public keys) that are permitted to repair shreds in the network. The whitelist controls which nodes have the authority to perform repairs. Any node not included in the whitelist will be restricted from initiating shred repair operations.

Parameters

• whitelist: A vector of Pubkey values representing the public keys of the nodes that are authorized to repair shreds.

Returns

• () — A unit result indicating that the operation was successful.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 114,
  "method": "setRepairWhitelist",
  "params": [["Pubkey1", "Pubkey2", "Pubkey3"]]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 114
}

Notes

• This method is generally used by network administrators to control which nodes are trusted to perform repairs on the network.
• The whitelist ensures that only authorized nodes can engage in potentially sensitive network repair actions.

pub fn get_secondary_index_key_size( &self, pubkey_str: String, ) -> impl Future<Output = RpcResult<HashMap<RpcAccountIndex, usize>>>

Retrieves the size of the secondary index key for a given account.

This RPC method returns the size of the secondary index key associated with a specific account, identified by its public key. The secondary index key is used in the indexing mechanism to quickly access account-related data.

Parameters

• pubkey_str: A string representing the public key of the account for which the secondary index key size is being queried.

Returns

• HashMap<RpcAccountIndex, usize>: A mapping of account indices to their respective key sizes.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 115,
  "method": "getSecondaryIndexKeySize",
  "params": ["PubkeyString"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": {
    "programId": 128,
    "splTokenMint": 256,
    "splTokenOwner": 192
  },
  "id": 115
}

Notes

• The returned HashMap will contain index types as keys, and the size of each key

pub fn set_public_tpu_address( &self, public_tpu_addr: SocketAddr, ) -> impl Future<Output = RpcResult<()>>

Sets the public TPU (Transaction Processing Unit) address.

This RPC method is used to configure the public TPU address of the node. The TPU address is used for communication between the validator and the network, allowing the node to send and receive transactions.

Parameters

• public_tpu_addr: A SocketAddr representing the public TPU address to be set.

Returns

• Result<()>: Returns Ok(()) if the operation was successful, or an error if there was an issue setting the TPU address.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 118,
  "method": "setPublicTpuAddress",
  "params": ["127.0.0.1:8000"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 118
}

Notes

• The TPU address is important for a validator node to participate in transaction processing and communication with the rest of the Solana network.
• This method is typically used to configure the node’s external-facing address, allowing it to communicate with clients or other validators.

Errors

• If the provided address is invalid or there is a failure when setting the address, an error will be returned.

pub fn set_public_tpu_forwards_address( &self, public_tpu_forwards_addr: SocketAddr, ) -> impl Future<Output = RpcResult<()>>

Sets the public TPU forwards address.

This RPC method configures the public address for TPU forwarding. It is used to specify a separate address for forwarding transactions to a different destination, often used for specialized network configurations or load balancing.

Parameters

• public_tpu_forwards_addr: A SocketAddr representing the public TPU forwards address to be set.

Returns

• Result<()>: Returns Ok(()) if the operation was successful, or an error if there was an issue setting the TPU forwards address.

Example Request (JSON-RPC)

{
  "jsonrpc": "2.0",
  "id": 118,
  "method": "setPublicTpuForwardsAddress",
  "params": ["127.0.0.1:9000"]
}

Example Response

{
  "jsonrpc": "2.0",
  "result": null,
  "id": 118
}

Notes

• This method is typically used for advanced network configurations, where a node might want to forward its transaction processing requests to another address.
• The provided SocketAddr should be valid and reachable.

Errors

• If the provided address is invalid or there is a failure when setting the address, an error will be returned.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<RpcChannel> for Client

fn from(channel: RpcChannel) -> Self

Converts to this type from the input type.