nimiqclient.websocket_rpc.NimiqRPCMethods

class nimiqclient.websocket_rpc.NimiqRPCMethods(client)[source]

Bases: RpcMethodsBase

Defines RPC methods that the server can request.

Parameters:

client (NimiqClient) – Nimiq API client.

Methods

subscribeForHeadBlock

Nimiq Websocket RPC method for subscribing for new blocks

subscribeForHeadBlockHash

Nimiq Websocket RPC method for subscribing for new block's hash

subscribeForLogsByAddressesAndTypes

Nimiq Websocket RPC method for subscribing for logs by type and addresses

subscribeForValidatorElectionByAddress

Nimiq Websocket RPC method for subscribing for new validator election

Attributes

channel

async subscribeForHeadBlock(subscription, result)[source]

Nimiq Websocket RPC method for subscribing for new blocks

Parameters:

  • subscription (int) – Subscription ID as provided by the server.

  • result (Block) – Block provided by the server.

async subscribeForHeadBlockHash(subscription, result)[source]

Nimiq Websocket RPC method for subscribing for new block’s hash

Parameters:

  • subscription (int) – Subscription ID as provided by the server.

  • result (str) – Block hash as provided by the server.

async subscribeForLogsByAddressesAndTypes(subscription, result)[source]

Nimiq Websocket RPC method for subscribing for logs by type and addresses

Parameters:

  • subscription (int) – Subscription ID as provided by the server.

  • result (BlockLog) – Log obtained from the Server.

async subscribeForValidatorElectionByAddress(subscription, result)[source]

Nimiq Websocket RPC method for subscribing for new validator election

Parameters:

  • subscription (int) – Subscription ID as provided by the server.

  • result (BlockchainState(Validator)) – Blockchain state of a Validator.