fetchSignerRewardsPerTokenForCycle

Reads the rewards-per-token value pox-5 recorded for a signer-manager's share of one tranche, which its stakers' rewards accrue against. Wraps the pox-5 read-only get-signer-rewards-per-token-for-cycle, which reads the signer-rewards-per-token-for-cycle map.

---

Usage

import { fetchSignerRewardsPerTokenForCycle, fetchPoxInfo, fetchSignerSetFirstItem } from '@stacks/bitcoin-staking';

const { rewardCycleId: rewardCycle } = await fetchPoxInfo({ network: 'mainnet' });
// Any signer-manager in this cycle's signer set
const signerManager = await fetchSignerSetFirstItem({ rewardCycle, network: 'mainnet' });

if (signerManager) {
  // STX-only staking tranche. Add bondIndex to read a protocol bond.
  const value = await fetchSignerRewardsPerTokenForCycle({ signerManager, rewardCycle, network: 'mainnet' });
}

Notes

• settle-rewards copies the tranche's current fetchRewardsPerTokenForCycle value into it, and only when the signer-manager's shares are above 0 (settle-rewards). Between settlements it lags the contract-wide accumulator.

• get-earned-staker-rewards uses this value as the current rewards-per-token for every staker of the signer-manager (get-earned-staker-rewards). A staker's fetchEarnedStakerRewards result grows only when the signer-manager's tranche is settled, for example by claim-rewards.

• The value is scaled by 10^18 (PRECISION): sats of sBTC per share, times 10^18. A share is one sat in the protocol bond tranche and one micro-STX in the STX-only staking tranche.

• Returns 0n when the contract has no entry for the inputs.

• A non-2xx response throws an Error whose message starts with Error calling read-only function. and includes the status code and URL. If the node reports that the call failed, the Error message is the node's cause.

Reference Link

---

Signature

function fetchSignerRewardsPerTokenForCycle(
  opts: {
    signerManager: string;
    rewardCycle: number;
    bondIndex?: number;
  } & NetworkClientParam
): Promise<bigint>;

opts is a NetworkClientParam plus signerManager, rewardCycle and bondIndex.

---

Returns

Promise<bigint>

Resolves to the recorded rewards-per-token value, scaled by 10^18.

---

Parameters

opts.signerManager (required)

• Type: string

Contract principal of the signer-manager, in the form <address>.<contract-name>. pox-5 keys signer state by this principal.

opts.rewardCycle (required)

• Type: number

Reward cycle to read.

opts.bondIndex (optional)

• Type: number

Protocol bond index. Set it to read that bond in the protocol bond tranche. Omit it to read the STX-only staking tranche.

opts.network (optional)

• Type: StacksNetworkName | StacksNetwork

The network to query: a name such as 'mainnet' or 'testnet', or a StacksNetwork object. Defaults to 'mainnet'.

opts.client (optional)

• Type: { baseUrl?: string; fetch?: FetchFn }

Overrides the API base URL or the fetch function, for example to query your own node. Fields you set replace the network's defaults.