MAINNET:
Loading...
TESTNET:
Loading...
/
onflow.org
Flow Playground

Staking Scripts

Scripts to read info from the staking contract


Reading Information from the Staking Contract

There are various ways to retrieve information about the current state of the staking contract.

Get the list of proposed nodes for the next epoch:

FlowIDTableStaking.getProposedNodeIDs(): Returns an array of node IDs for proposed nodes. Proposed nodes are nodes that have enough staked and committed for the next epoch to be above the minimum requirement.

You can use the Get Proposed Table(SC.05) script for retrieving this info.

This script requires no arguments.

Get the list of all nodes that are currently staked:

FlowIDTableStaking.getStakedNodeIDs(): Returns an array of nodeIDs that are currently staked. Staked nodes are nodes that currently have staked tokens above the minimum.

You can use the Get Current Table(SC.04) script for retrieving this info.

This script requires no arguments.

Get all of the info associated with a single node staker:

FlowIDTableStaking.NodeInfo(nodeID: String): Returns a NodeInfo struct with all of the metadata associated with the specified node ID. You can see the NodeInfo definition in the FlowIDTableStaking smart contract.

You can use the Get Node Info(SC.08) script with the following arguments:

ArgumentTypeDescription
nodeIDStringThe node ID of the node to search for.

You can also query the info from an address by using the Get Node Info From Address(SC.26) script with the following arguments:

ArgumentTypeDescription
addressAddressThe address of the account that manages the node.

Get the total committed balance of a node (with delegators):

FlowIDTableStaking.NodeID(_ nodeID: String).totalCommittedWithDelegators(): Returns the total committed balance for a node, which is their total tokens staked + committed, plus all of the staked + committed tokens of all their delegators.

You can use the Get Node Total Commitment(SC.09) script with the following argument:

ArgumentTypeDescription
nodeIDStringThe node ID of the node to search for.

Get the total committed balance of a node (without delegators):

FlowIDTableStaking.NodeID(_ nodeID: String).totalCommittedWithoutDelegators(): Returns the total committed balance for a node, which is their total tokens staked + committed, plus all of the staked + committed tokens of all their delegators.

You can use the Get Only Node Total Commitment(SC.09) script with the following argument:

ArgumentTypeDescription
nodeIDStringThe node ID of the node to search for.

Get all the info associated with a single delegator:

FlowIDTableStaking.DelegatorInfo(nodeID: String, delegatorID: UInt32): Returns a DelegatorInfo struct with all of the metadata associated with the specified node ID and delegator ID. You can see the DelegatorInfo definition in the FlowIDTableStaking smart contract.

You can use the Get Delegator Info(SC.10) script with the following arguments:

ArgumentTypeDescription
nodeIDStringThe node ID that the delegator delegates to.
delegatorIDStringThe ID of the delegator to search for.

You can also query the info from an address by using the Get Delegator Info From Address(SC.27) script with the following arguments:

ArgumentTypeDescription
addressAddressThe address of the account that manages the delegator.

Get the delegation cut percentage:

FlowIDTableStaking.getRewardCutPercentage(): UFix64: Returns a UFix64 number for the cut of delegator rewards that each node operator takes.

You can use the Get Cut Percentage(SC.01) script to retrieve this info.

This script requires no arguments.

Get the minimum stake requirements:

FlowIDTableStaking.getMinimumStakeRequirements(): {UInt8: UFix64}: Returns a mapping for the stake requirements for each node type.

You can use the Get stake requirements(SC.02) script to retrieve this info.

This script requires no arguments.

Get the total weekly reward payout:

FlowIDTableStaking.getEpochTokenPayout(): UFix64: Returns a UFix64 value for the total number of FLOW paid out each epoch (week).

You can use the Get weekly payout(SC.03) script to retrieve this info.

This script requires no arguments.

Get the total FLOW staked:

You can use the Get total FLOW staked(SC.06) script to retrieve this info.

This script requires no arguments.

Get the total FLOW staked by a single node type:

You can use the Get total FLOW staked by node type(SC.07) script with the following arguments:

ArgumentTypeDescription
nodeTypeUInt8The type of node to search for.

The source code for the staking contract and more transactions can be found in the Flow Core Contracts GitHub Repository.

Edit on GitHub