Admin

Administrative controls for managing the Surfnet instance, plugins, and system configuration.

exit

Immediately shuts down the RPC server.

Result

Field	Type	Description
`result`	`null`	exit - Immediately shuts down the RPC server

Example

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

reloadPlugin

Reloads a runtime plugin with new configuration.

Parameters

Name	Type	Description
`name`*	`string`	The name of the plugin to reload.
`configFile`*	`string`	The path to the new configuration file for the plugin.

Result

Field	Type	Description
`configFile`	`string`
`name`	`string`

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "reloadPlugin",
  "params": [
    "<some-name>",
    "<some-configfile>"
  ]
}

unloadPlugin

Unloads a runtime plugin.

Parameters

Name	Type	Description
`name`*	`string`	The name of the plugin to unload.

Result

Field	Type	Description
`name`	`string`

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "unloadPlugin",
  "params": [
    "<some-name>"
  ]
}

loadPlugin

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

Parameters

Name	Type	Description
`configFile`*	`string`	The path to the configuration file for the new plugin.

Result

Field	Type	Description
`configFile`	`string`

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "loadPlugin",
  "params": [
    "<some-configfile>"
  ]
}

listPlugins

Returns a list of all currently loaded plugin names.

Result

Field	Type	Description
`result`	`array<string>`	listPlugins - Lists all loaded plugins

Example

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

rpcAddress

Returns the address of the RPC server.

Result

Field	Type	Description
`ip`	`string`
`port`	`integer`

Example

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

setLogFilter

Sets a filter for log messages in the system.

Parameters

Name	Type	Description
`filter`*	`string`	The log filter string to apply.

Result

Field	Type	Description
`result`	`null`	setLogFilter - Sets log filter

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setLogFilter",
  "params": [
    "<some-filter>"
  ]
}

startTime

Returns the system start time.

Result

Field	Type	Description
`nanos`	`integer`	Nanoseconds
`secsSinceEpoch`	`integer`	Seconds since Unix epoch

Example

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

addAuthorizedVoter

Adds an authorized voter to the system.

Parameters

Name	Type	Description
`keypairFile`*	`string`	Path to the keypair file for the authorized voter.

Result

Field	Type	Description
`result`	`null`	addAuthorizedVoter - Adds authorized voter

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addAuthorizedVoter",
  "params": [
    "<some-keypairfile>"
  ]
}

addAuthorizedVoterFromBytes

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

Parameters

Name	Type	Description
`keypair`*	`array[integer]`	Byte array representing the keypair for the authorized voter.

Result

Field	Type	Description
`result`	`null`	addAuthorizedVoterFromBytes - Adds voter from bytes

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "addAuthorizedVoterFromBytes",
  "params": [
    [
      0
    ]
  ]
}

removeAllAuthorizedVoters

Removes all authorized voters from the system.

Result

Field	Type	Description
`result`	`null`	removeAllAuthorizedVoters - Removes all voters

Example

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

setIdentity

Sets the identity for the system using the provided keypair.

Parameters

Name	Type	Description
`keypairFile`*	`string`	Path to the keypair file to be used as the node's identity.
`requireTower`*	`boolean`	Boolean indicating if a tower is required for this identity.

Result

Field	Type	Description
`result`	`null`	setIdentity - Sets cluster identity

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setIdentity",
  "params": [
    "<some-keypairfile>",
    true
  ]
}

setIdentityFromBytes

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

Parameters

Name	Type	Description
`identityKeypair`*	`array[integer]`	Byte array representing the identity keypair.
`requireTower`*	`boolean`	Boolean indicating if a tower is required for this identity.

Result

Field	Type	Description
`result`	`null`	setIdentityFromBytes - Sets identity from bytes

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setIdentityFromBytes",
  "params": [
    [
      0
    ],
    true
  ]
}

setStakedNodesOverrides

Sets the overrides for staked nodes using a specified path.

Parameters

Name	Type	Description
`path`*	`string`	Path to the file containing staked nodes overrides.

Result

Field	Type	Description
`result`	`null`	setStakedNodesOverrides - Sets staked nodes overrides

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setStakedNodesOverrides",
  "params": [
    "<some-path>"
  ]
}

repairShredFromPeer

Repairs a shred from a peer node in the network.

Parameters

Name	Type	Description
`pubkey`	`string`	The public key of the peer to repair from, as a base-58 encoded string.
`slot`*	`integer`	The slot of the shred to repair.
`shredIndex`*	`integer`	The index of the shred to repair.

Result

Field	Type	Description
`result`	`null`	repairShredFromPeer - Repairs shred from peer

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "repairShredFromPeer",
  "params": [
    "83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri",
    123456789,
    0
  ]
}

setRepairWhitelist

Sets the whitelist of nodes allowed to repair shreds.

Parameters

Name	Type	Description
`whitelist`*	`array[string]`	A list of public keys (base-58 encoded strings) to set as the repair whitelist.

Result

Field	Type	Description
`result`	`null`	setRepairWhitelist - Sets repair whitelist

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setRepairWhitelist",
  "params": [
    [
      "<some-whitelist>"
    ]
  ]
}

getSecondaryIndexKeySize

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

Parameters

Name	Type	Description
`pubkeyStr`*	`string`	The public key of the account to get the secondary index key size for, as a base-58 encoded string.

Result

Field	Type	Description
`result`	`integer`	getSecondaryIndexKeySize - Gets secondary index key size

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "getSecondaryIndexKeySize",
  "params": [
    "83astBRguLMdt2h5U1Tpdq5tjFoJ6noeGwaY3mDLVcri"
  ]
}

setPublicTpuAddress

Sets the public TPU (Transaction Processing Unit) address.

Parameters

Name	Type	Description
`publicTpuAddr`*	`string`	The public TPU address as a string.

Result

Field	Type	Description
`result`	`null`	setPublicTpuAddress - Sets public TPU address

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setPublicTpuAddress",
  "params": [
    "<some-publictpuaddr>"
  ]
}

setPublicTpuForwardsAddress

Sets the public TPU forwards address.

Parameters

Name	Type	Description
`publicTpuForwardsAddr`*	`string`	The public TPU forwards address as a string.

Result

Field	Type	Description
`result`	`null`	setPublicTpuForwardsAddress - Sets public TPU forwards address

Example

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "setPublicTpuForwardsAddress",
  "params": [
    "<some-publictpuforwardsaddr>"
  ]
}

Admin

exit

reloadPlugin

unloadPlugin

loadPlugin

listPlugins

rpcAddress

setLogFilter

startTime

addAuthorizedVoter

addAuthorizedVoterFromBytes

removeAllAuthorizedVoters

setIdentity

setIdentityFromBytes

setStakedNodesOverrides

repairShredFromPeer

setRepairWhitelist

getSecondaryIndexKeySize

setPublicTpuAddress

setPublicTpuForwardsAddress

Table des matières