RPC Methods

Reference for the Add voting key RPC method.

Returns our validator address.

Returns if our validator is currently elected.

Returns if our validator is currently synced.

Updates the configuration setting to automatically reactivate our validator.

Tries to fetch the account at the given address.

Fetches all accounts in the accounts tree. IMPORTANT: This operation iterates over all accounts in the accounts tree and thus is extremely computationally expensive.

Returns a collection of the currently active validator's addresses and balances.

Returns the batch number for the current head.

Tries to fetch a block given its hash. It has an option to include the transactions in the block, which defaults to false.

Tries to fetch a block given its number. It has an option to include the transactions in the block, which defaults to false. Note that this function will only fetch blocks that are part of the main chain.

Returns the block number for the current head.

Returns information about the currently penalized slots. This includes slots that lost rewards and that were disabled.

Returns the epoch number for the current head.

Returns all the inherents (including reward inherents) for the given batch number. Note that this only considers blocks in the main chain.

Returns all the inherents (including reward inherents) for the given block number. Note that this only considers blocks in the main chain.

Returns the block at the head of the main chain. It has an option to include the transactions in the block, which defaults to false.

Returns the network ID.

Returns information about the penalized slots of the previous batch. This includes slots that lost rewards and that were disabled.

Returns information about the proposer slot at the given block height and offset. The offset is optional, it will default to getting the offset for the existing block at the given height. We only have this information available for the last 2 batches at most.

Tries to fetch a staker information given its address.

Fetches all stakers for a given validator. IMPORTANT: This operation iterates over all stakers of the staking contract and thus is extremely computationally expensive.

Tries to fetch a transaction (including reward transactions) given its hash.

Returns the hashes for the latest transactions for a given address. All the transactions where the given address is listed as a recipient or as a sender are considered. Reward transactions are also returned. It has an option to specify the maximum number of hashes to fetch, it defaults to 500. It has also an option to retrieve transactions before a given transaction hash (exclusive). If this hash is not found or does not belong to this address, it will return an empty list. The transaction hashes are returned in descending order, meaning the latest transaction is the first.

Returns the transactions receipts (similar to get transactions by address)

Returns the latest transactions for a given address. All the transactions where the given address is listed as a recipient or as a sender are considered. Reward transactions are also returned. It has an option to specify the maximum number of transactions to fetch, it defaults to 500. It has also an option to retrieve transactions before a given transaction hash (exclusive). If this hash is not found or does not belong to this address, it will return an empty list. The transactions are returned in descending order, meaning the latest transaction is the first.

Returns all the transactions (including reward transactions) for the given batch number. Note that this only considers blocks in the main chain.

Returns all the transactions (including reward transactions) for the given block number. Note that this only considers blocks in the main chain.

Tries to fetch a validator information given its address.

Fetches all validators in the staking contract. IMPORTANT: This operation iterates over all validators in the staking contract and thus is extremely computationally expensive.

Subscribes to new block events (retrieves the full block).

Subscribes to new block events (only retrieves the block hash).

Subscribes to log events related to a given list of addresses and of any of the log types provided. If addresses is empty it does not filter by address. If log_types is empty it won't filter by log types. Thus the behavior is to assume all addresses or log_types are to be provided if the corresponding vec is empty.

Subscribes to pre epoch validators events.

Returns a serialized basic transaction.

Returns a serialized basic transaction with an arbitrary data field.

Returns a serialized `deactivate_validator` transaction. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Returns a serialized `delete_validator` transaction. The transaction fee will be paid from the validator deposit that is being returned. Note in order for this transaction to be accepted fee + value should be equal to the validator deposit, which is not a fixed value: Failed delete validator transactions can diminish the validator deposit

Returns a serialized transaction creating a new HTLC contract.

Returns a serialized `new_staker` transaction. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Returns a serialized `new_validator` transaction. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee and the validator deposit. Since JSON doesn't have a primitive for Option (it just has the null primitive), we can't have a double Option. So we use the following work-around for the signal data: \"\" = Set the signal data field to None. \"0x29a4b...\" = Set the signal data field to Some(0x29a4b...).

Returns a serialized transaction creating a new vesting contract.

Returns a serialized `reactivate_validator` transaction. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Returns a serialized transaction redeeming a HTLC contract using the `EarlyResolve` method.

Returns a serialized transaction redeeming a HTLC contract using the `RegularTransfer` method.

Returns a serialized transaction redeeming a HTLC contract using the `TimeoutResolve` method.

Returns a serialized transaction redeeming a vesting contract.

Returns a serialized `remove_stake` transaction. The transaction fee will be paid from the funds being removed.

Returns a serialized `retire_stake` transaction. You can pay the transaction fee from a basic account (by providing the sender wallet) or from the staker account's balance (by not providing a sender wallet).

Returns a serialized `retire_validator` transaction. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Returns a serialized `set_active_stake` transaction. You can pay the transaction fee from a basic account (by providing the sender wallet) or from the staker account's balance (by not providing a sender wallet).

Returns a serialized `set_signal_data` transaction, signed with the validator's signing (warm) key. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee. The `new_signal_data` field is interpreted as follows: null = Clear the signal data field (set it to None). \"0x29a4b...\" = Set the signal data field to Some(0x29a4b...). Note: this *replaces the entire signal data field*, overwriting any protocol version previously signaled via `create_signal_version_transaction`. Use that method instead if you only want to update the version while preserving the rest of the signal data. This transaction is only valid from protocol version `upgrades::v2::WARM_KEY_SIGNALING` onwards.

Returns a serialized `signal_version` transaction that signals support for the given protocol `version`, signed with the validator's signing (warm) key. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee. Note: this only updates the protocol-version bytes of the signal data and preserves the rest of the field; it cannot clear the field. To replace the entire signal data (including clearing it), use `create_set_signal_data_transaction`. This transaction is only valid from protocol version `upgrades::v2::WARM_KEY_SIGNALING` onwards.

Returns a serialized `stake` transaction. The funds to be staked and the transaction fee will be paid from the `sender_wallet`.

Returns a serialized `update_staker` transaction. You can pay the transaction fee from a basic account (by providing the sender wallet) or from the staker account's balance (by not providing a sender wallet).

Returns a serialized `update_validator` transaction. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee. Since JSON doesn't have a primitive for Option (it just has the null primitive), we can't have a double Option. So we use the following work-around for the signal data: null = No change in the signal data field. \"\" = Change the signal data field to None. \"0x29a4b...\" = Change the signal data field to Some(0x29a4b...).

Given a serialized transaction, it will return the corresponding transaction struct.

Returns the status of the sync process

Returns a boolean specifying if we have established consensus with the network.

Sends a basic transaction to the network.

Sends a basic transaction, with an arbitrary data field, to the network.

Sends a `deactivate_validator` transaction to the network. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Sends a `delete_validator` transaction to the network. The transaction fee will be paid from the validator deposit that is being returned.

Sends a transaction creating a new HTLC contract to the network.

Sends a `new_staker` transaction to the network. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Sends a `new_validator` transaction to the network. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee and the validator deposit. Since JSON doesn't have a primitive for Option (it just has the null primitive), we can't have a double Option. So we use the following work-around for the signal data: \"\" = Set the signal data field to None. \"0x29a4b...\" = Set the signal data field to Some(0x29a4b...).

Sends a transaction creating a new vesting contract to the network.

Sends the given serialized transaction to the network.

Sends a `reactivate_validator` transaction to the network. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Sends a transaction redeeming a HTLC contract, using the `EarlyResolve` method, to the network.

Sends a transaction redeeming a HTLC contract, using the `RegularTransfer` method, to the network.

Sends a transaction redeeming a HTLC contract, using the `TimeoutResolve` method, to the network.

Sends a transaction redeeming a vesting contract to the network.

Sends a `remove_stake` transaction to the network. The transaction fee will be paid from the funds being removed.

Sends a `retire_stake` transaction to the network. You can pay the transaction fee from a basic account (by providing the sender wallet) or from the staker account's balance (by not providing a sender wallet).

Sends a `retire_validator` transaction to the network. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee.

Sends a `set_active_stake` transaction to the network. You can pay the transaction fee from a basic account (by providing the sender wallet) or from the staker account's balance (by not providing a sender wallet).

Sends a `set_signal_data` transaction to the network. See `create_set_signal_data_transaction` for the meaning of `new_signal_data`.

Sends a `signal_version` transaction that signals support for the given protocol `version` to the network.

Sends a `stake` transaction to the network. The funds to be staked and the transaction fee will be paid from the `sender_wallet`.

Sends a `update_staker` transaction to the network. You can pay the transaction fee from a basic account (by providing the sender wallet) or from the staker account's balance (by not providing a sender wallet).

Sends a `update_validator` transaction to the network. You need to provide the address of a basic account (the sender wallet) to pay the transaction fee. Since JSON doesn't have a primitive for Option (it just has the null primitive), we can't have a double Option. So we use the following work-around for the signal data: null = No change in the signal data field. \"\" = Change the signal data field to None. \"0x29a4b...\" = Change the signal data field to Some(0x29a4b...).

Returns a serialized signature that can be used to redeem funds from a HTLC contract using the `EarlyResolve` method.

Generates a new account and store it.

Import an account by its private key, in hexadecimal format, and lock it with the passphrase.

Returns if an account has been imported.

Returns if the account currently is unlocked.

Returns the accounts that have been imported.

Locks the account to prevent further usage.

Removes an imported account. IMPORTANT: This action is irreversible, and the account can only be recovered with its private key.

Reference for the Sign RPC method.

Unlocks the account.

Verifies the signature based on the provided public key and message.

Returns the batch number at a given `block_number` (height).

Returns the batch index at a given block number. The batch index is the number of a block relative to the batch it is in. For example, the first block of any batch always has an batch index of 0.

Returns the first block after the collateral lock-up window of a given block number has ended.

Returns the first block after the jail period of a given block number has ended.

**Deprecated**: renamed to `getBlockAfterCollateralLockup`. This window never governed equivocation reporting; it has always been the collateral lock-up window. Kept for API backwards compatibility — prefer `getBlockAfterCollateralLockup` in new clients.

Returns the number (height) of the next election macro block after a given block number (height).

Returns the number block (height) of the preceding election macro block before a given block number (height). If the given block number is an election macro block, it returns the election macro block before it.

Returns the block number of the election macro block of the given epoch (which is always the last block).

Returns the epoch number at a given block number (height).

Returns the epoch index at a given block number. The epoch index is the number of a block relative to the epoch it is in. For example, the first block of any epoch always has an epoch index of 0.

Returns a boolean expressing if the batch at a given block number (height) is the first batch of the epoch.

Returns the block number of the first block of the given epoch (which is always a micro block).

Returns the block number of the first block of the given batch (which is always a micro block).

Returns the block number (height) of the last election macro block at a given block number (height). If the given block number is an election macro block, then it returns that block number.

Returns block the number (height) of the last macro block at a given block number (height). If the given block number is a macro block, then it returns that block number.

Returns the block number (height) of the next macro block after a given block number (height).

Returns the block number (height) of the preceding macro block before a given block number (height). If the given block number is a macro block, it returns the macro block before it.

Returns the block number of the macro block (checkpoint or election) of the given batch (which is always the last block).

Returns a bundle of policy constants.

Returns the supply at a given time (as Unix time) in Lunas (1 NIM = 100,000 Lunas). It is calculated using the following formula: ```text supply(t) = total_supply - (total_supply - genesis_supply) * supply_decay^t ``` Where t is the time in milliseconds since the PoS genesis block and `genesis_supply` is the supply at the genesis of the Nimiq 2.0 chain.

Returns a boolean expressing if the block at a given block number (height) is an election macro block.

Returns a boolean expressing if the block at a given block number (height) is a macro block.

Returns a boolean expressing if the block at a given block number (height) is a micro block.

Obtains the minimum fee per byte as per mempool configuration.

Tries to obtain the given transaction (using its hash) from the mempool.

Obtains the mempool content in fee per byte buckets.

Obtains the list of transactions that are currently in the mempool.

Pushes a raw transaction with a high priority assigned into the mempool and broadcast it to the network.

Pushes a raw transaction with a default priority assigned into the mempool and broadcast it to the network.

Returns the address book

Returns the version of the client the RPC server is running.

Returns the number of peers.

Returns the peer ID for our local peer.

Returns a list with the IDs of all our peers.