RPC

RPC

class RPC(**kwargs)

Implements the rpc api endpoints.

call_by_name(command: str, parameters: dict | None = None, **kwargs) → int | str | dict

Calls the specified RPC command.

Parameters:

• command (str) – The complete RPC command.

• parameters (dict, optional) – Command parameters

• **kwargs – Extra keyword arguments.

Returns:

The command output.

Return type:

Union[int, str, dict]

Raises:

APIError – Error thrown by node API. See message for details.

list_methods(**kwargs) → List[RPCCommandListModel]

List available RPC call methods on this node.

Parameters:

**kwargs – Extra keyword arguments.

Returns:

A list of valid RPC commands.

Return type:

List[RPCCommandListModel]

Raises:

APIError – Error thrown by node API. See message for details.

RPCCommandListModel

class RPCCommandListModel(*, command: str, description: str)

A pydantic model for a RPC command.

command: str

The RPC command.

description: str

The command description.

RPCCommandResponseModel