Admin Methods

These are operational methods used by node operators to configure identity, manage plugins, control log output, issue test airdrops, and monitor node-specific metrics. They are generally not relevant for end users or application developers.

exit
Available
Immediately shuts down the RPC server.
Parameters
No parameters required

reloadPlugin
Available
Reloads a runtime plugin with new configuration.
Parameters
configFile
required
string
The path to the new configuration file for the plugin.
name
required
string
The name of the plugin to reload.

unloadPlugin
Available
Unloads a runtime plugin.
Parameters
name
required
string
The name of the plugin to unload.

loadPlugin
Available
Dynamically loads a new plugin into the runtime from a configuration file.
Parameters
configFile
required
string
The path to the configuration file for the new plugin.

listPlugins
Available
Returns a list of all currently loaded plugin names.
Parameters
No parameters required

rpcAddress
Available
Returns the address of the RPC server.
Parameters
No parameters required

setLogFilter
Available
Sets a filter for log messages in the system.
Parameters
filter
required
string
The log filter string to apply.

startTime
Available
Returns the system start time.
Parameters
No parameters required

addAuthorizedVoter
Available
Adds an authorized voter to the system.
Parameters
keypairFile
required
string
Path to the keypair file for the authorized voter.

addAuthorizedVoterFromBytes
Available
Adds an authorized voter to the system using a byte-encoded keypair.
Parameters
keypair
required
array[integer]
Byte array representing the keypair for the authorized voter.

removeAllAuthorizedVoters
Available
Removes all authorized voters from the system.
Parameters
No parameters required

setIdentity
Available
Sets the identity for the system using the provided keypair.
Parameters
keypairFile
required
string
Path to the keypair file to be used as the node's identity.
requireTower
required
boolean
Boolean indicating if a tower is required for this identity.

setIdentityFromBytes
Available
Sets the identity for the system using a keypair provided as a byte array.
Parameters
identityKeypair
required
array[integer]
Byte array representing the identity keypair.
requireTower
required
boolean
Boolean indicating if a tower is required for this identity.

setStakedNodesOverrides
Available
Sets the overrides for staked nodes using a specified path.
Parameters
path
required
string
Path to the file containing staked nodes overrides.

repairShredFromPeer
Available
Repairs a shred from a peer node in the network.
Parameters
pubkey
string (optional)
The public key of the peer to repair from, as a base-58 encoded string.
shredIndex
required
integer
The index of the shred to repair.
slot
required
integer
The slot of the shred to repair.

setRepairWhitelist
Available
Sets the whitelist of nodes allowed to repair shreds.
Parameters
whitelist
required
array[string]
A list of public keys (base-58 encoded strings) to set as the repair whitelist.

getSecondaryIndexKeySize
Available
Retrieves the size of the secondary index key for a given account.
Parameters
pubkeyStr
required
string
The public key of the account to get the secondary index key size for, as a base-58 encoded string.

setPublicTpuAddress
Available
Sets the public TPU (Transaction Processing Unit) address.
Parameters
publicTpuAddr
required
string
The public TPU address as a string.

setPublicTpuForwardsAddress
Available
Sets the public TPU forwards address.
Parameters
publicTpuForwardsAddr
required
string
The public TPU forwards address as a string.