NextCycleInfo

Summary of the next reward cycle, from the next_cycle object of the node's /v2/pox response. It is the type of PoxInfo nextCycle, returned by fetchPoxInfo. Unlike CycleInfo, it has no isPoxActive field, because next_cycle carries no is_pox_active.

---

Usage

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

const { nextCycle } = await fetchPoxInfo({ network: 'mainnet' });

nextCycle.id; // number
nextCycle.stakedUstx; // bigint, micro-STX staked for the next cycle so far

Reference Link

---

Definition

export interface NextCycleInfo {
  /** Reward cycle id. */
  id: number;
  /** Total micro-STX stacked for the cycle. */
  stakedUstx: bigint;
}

---

Properties

Property	Type	From /v2/pox	Description
id	number	next_cycle.id	Reward cycle ID
stakedUstx	bigint	next_cycle.stacked_ustx	Total micro-STX staked for the cycle so far, converted to bigint