Class NodeInternal

ConsensusParameters returns the beacon consensus parameters.

GetBaseEpoch returns the base epoch.

GetBeacon gets the beacon for the provided block height. Calling this method with height consensus.HeightLatest should return the beacon for the latest finalized block.

GetEpoch returns the epoch number at the specified block height. Calling this method with height consensus.HeightLatest, should return the epoch of latest known block.

GetEpochBlock returns the block height at the start of the said epoch.

GetFutureEpoch returns any future epoch that is currently scheduled to occur at a specific height.

Note that this may return a nil state in case no future epoch is currently scheduled.

StateToGenesis returns the genesis state at specified block height.

WaitEpoch waits for a specific epoch.

Note that an epoch is considered reached even if any epoch greater than the one specified is reached (e.g., that the current epoch is already in the future).

WatchEpochs returns a channel that produces a stream of messages on epoch transitions.

Upon subscription the current epoch is sent immediately.

WatchLatestEpoch returns a channel that produces a stream of messages on epoch transitions. If an epoch transition happens before the previous epoch is read from the channel, the old epochs are overwritten.

Upon subscription the current epoch is sent immediately.

EstimateGas calculates the amount of gas required to execute the given transaction.

GetBlock returns a consensus block at a specific height.

GetChainContext returns the chain domain separation context.

GetGenesisDocument returns the original genesis document.

GetLightBlock returns a light version of the consensus layer block that can be used for light client verification.

GetNextBlockState returns the state of the next block being voted on by validators.

GetParameters returns the consensus parameters for a specific height.

GetSignerNonce returns the nonce that should be used by the given signer for transmitting the next transaction.

GetStatus returns the current status overview.

GetTransactions returns a list of all transactions contained within a consensus block at a specific height.

NOTE: Any of these transactions could be invalid.

GetTransactionsWithProofs returns a list of all transactions and their proofs of inclusion contained within a consensus block at a specific height.

GetTransactionsWithResults returns a list of transactions and their execution results, contained within a consensus block at a specific height.

GetUnconfirmedTransactions returns a list of transactions currently in the local node's mempool. These have not yet been included in a block.

MinGasPrice returns the minimum gas price.

SyncGet fetches a single key and returns the corresponding proof.

SyncGetPrefixes fetches all keys under the given prefixes and returns the corresponding proofs.

SyncIterate seeks to a given key and then fetches the specified number of following items based on key iteration order.

StateToGenesis returns the genesis state at the specified block height.

SubmitEvidence submits evidence of misbehavior.

SubmitTx submits a signed consensus transaction and waits for the transaction to be included in a block. Use SubmitTxNoWait if you only need to broadcast the transaction.

SubmitTxNoWait submits a signed consensus transaction, but does not wait for the transaction to be included in a block. Use SubmitTx if you need to wait for execution.

SubmitTxWithProof submits a signed consensus transaction, waits for the transaction to be included in a block and returns a proof of inclusion.

WatchBlocks returns a channel that produces a stream of consensus blocks as they are being finalized.

SetEpoch manually sets the current epoch to the given epoch.

NOTE: This only works with a mock beacon backend and will otherwise return an error.

WaitNodesRegistered waits for the given number of nodes to register.

ActiveProposals returns a list of all proposals that have not yet closed.

ConsensusParameters returns the governance consensus parameters.

GetEvents returns the events at specified block height.

PendingUpgrades returns a list of all pending upgrades.

Proposal looks up a specific proposal.

Proposals returns a list of all proposals.

StateToGenesis returns the genesis state at specified block height.

Votes looks up votes for a specific proposal.

WatchEvents returns a channel that produces a stream of Events.

StateToGenesis returns the genesis state at specified block height.

CancelUpgrade cancels the specific pending upgrade, unless it is already in progress.

GetStatus returns the current status overview of the node.

IsReady checks whether the node is ready to accept runtime work.

IsSynced checks whether the node has finished syncing.

RequestShutdown requests the node to shut down gracefully.

If the wait argument is true then the method will also wait for the shutdown to complete.

UpgradeBinary submits an upgrade descriptor to a running node. The node will wait for the appropriate epoch, then update its binaries and shut down.

WaitReady waits for the node to accept runtime work.

WaitSync waits for the node to finish syncing.

ConsensusParameters returns the registry consensus parameters.

GetEntities gets a list of all registered entities.

GetEntity gets an entity by ID.

GetEvents returns the events at specified block height.

GetNode gets a node by ID.

GetNodeByConsensusAddress looks up a node by its consensus address at the specified block height. The nature and format of the consensus address depends on the specific consensus backend implementation used.

GetNodes gets a list of all registered nodes.

GetNodeStatus returns a node's status.

GetRuntime gets a runtime by ID.

GetRuntimes returns the registered Runtimes at the specified block height.

StateToGenesis returns the genesis state at specified block height.

WatchEntities returns a channel that produces a stream of EntityEvent on entity registration changes.

WatchEvents returns a channel that produces a stream of Events.

WatchNodeList returns a channel that produces a stream of NodeList. Upon subscription, the node list for the current epoch will be sent immediately.

Each node list will be sorted by node ID in lexicographically ascending order.

WatchNodes returns a channel that produces a stream of NodeEvent on node registration changes.

WatchRuntimes returns a stream of Runtime. Upon subscription, all runtimes will be sent immediately.

ConsensusParameters returns the roothash consensus parameters.

GetEvents returns the events at specified block height.

GetGenesisBlock returns the genesis block.

GetIncomingMessageQueue returns the given runtime's queued incoming messages.

GetIncomingMessageQueueMeta returns the given runtime's incoming message queue metadata.

GetLastRoundResults returns the given runtime's last normal round results.

GetLatestBlock returns the latest block.

The metadata contained in this block can be further used to get the latest state from the storage backend.

GetPastRoundRoots returns the stored past state and I/O roots for the given runtime.

GetPastRoundRoots returns the stored state and I/O roots for the given runtime and round.

GetRuntimeState returns the given runtime's state.

StateToGenesis returns the genesis state at specified block height.

WatchBlocks returns a channel that produces a stream of annotated blocks.

The latest block if any will get pushed to the stream immediately. Subsequent blocks will be pushed into the stream as they are confirmed.

WatchEvents returns a stream of protocol events.

WatchExecutorCommitments returns a channel that produces a stream of executor commitments observed in the consensus layer P2P network.

Note that these commitments may not have been processed by consensus, commitments may be received in any order and duplicates are possible.

CheckTx asks the local runtime to check the specified transaction.

GetBlock fetches the given runtime block.

GetEvents returns all events emitted in a given block.

GetGenesisBlock returns the genesis block.

GetLastRetainedBlock returns the last retained block.

GetTransactions fetches all runtime transactions in a given block.

GetTransactionsWithResults fetches all runtime transactions in a given block together with its results (outputs and emitted events).

GetUnconfirmedTransactions fetches all unconfirmed runtime transactions that are currently pending to be included in a block.

Query makes a runtime-specific query.

SubmitTx submits a transaction to the runtime transaction scheduler and waits for transaction execution results.

SubmitTxMeta submits a transaction to the runtime transaction scheduler and waits for transaction execution results.

Response includes transaction metadata - e.g. round at which the transaction was included in a block.

SubmitTxNoWait submits a transaction to the runtime transaction scheduler but does not wait for transaction execution.

WatchBlocks subscribes to blocks for a specific runtimes.

ConsensusParameters returns the scheduler consensus parameters.

GetCommittees returns the vector of committees for a given runtime ID, at the specified block height, and optional callback for querying the beacon for a given epoch/block height.

Iff the callback is nil, beacon.GetBlockBeacon will be used.

GetValidators returns the vector of consensus validators for a given epoch.

StateToGenesis returns the genesis state at specified block height.

WatchCommittees returns a channel that produces a stream of Committee.

Upon subscription, all committees for the current epoch will be sent immediately.

Account returns the account descriptor for the given account.

Addresses returns the addresses of all accounts with a non-zero general or escrow balance.

Allowance looks up the allowance for the given owner/beneficiary combination.

CommissionScheduleAddresses returns the addresses of all accounts with non-empty commission schedule.

CommonPool returns the common pool balance.

ConsensusParameters returns the staking consensus parameters.

DebondingDelegationsInfosFor returns (outgoing) debonding delegations with additional information for the given owner (delegator).

DebondingDelegationsFor returns the list of (outgoing) debonding delegations for the given owner (delegator).

DebondingDelegationsTo returns the list of (incoming) debonding delegations to the given account.

DelegationsInfosFor returns (outgoing) delegations with additional information for the given owner (delegator).

DelegationsFor returns the list of (outgoing) delegations for the given owner (delegator).

DelegationsTo returns the list of (incoming) delegations to the given account.

GetEvents returns the events at specified block height.

GovernanceDeposits returns the governance deposits account balance.

LastBlockFees returns the collected fees for previous block.

StateToGenesis returns the genesis state at specified block height.

Threshold returns the specific staking threshold by kind.

TokenSymbol returns the token's ticker symbol.

TokenValueExponent is the token's value base-10 exponent, i.e. 1 token = 10**TokenValueExponent base units.

TotalSupply returns the total number of base units.

WatchEvents returns a channel that produces a stream of Events.

GetCheckpointChunk fetches a specific chunk from an existing chekpoint.

GetCheckpoints returns a list of checkpoint metadata for all known checkpoints.

GetDiff returns an iterator of write log entries that must be applied to get from the first given root to the second one.

SyncGet fetches a single key and returns the corresponding proof.

SyncGetPrefixes fetches all keys under the given prefixes and returns the corresponding proofs.

SyncIterate seeks to a given key and then fetches the specified number of following items based on key iteration order.

GetLastSyncedRound retrieves the last synced round for the storage worker.

PauseCheckpointer pauses or unpauses the storage worker's checkpointer.