> For the complete documentation index, see [llms.txt](https://docs.stacks.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stacks.co/reference/stacks.js/stacks-bitcoin-staking/cycles/bondstatus.md).

# bondStatus

Classifies a bond at `poxInfo.currentBurnchainBlockHeight`, including bonds that were never set up. Pure computation: you supply whether `setup-bond` has run. [fetchBondStatus](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchbondstatus.md) is the variant that fetches it.

***

### Usage

```ts
import { bondStatus, fetchPoxInfo, fetchProtocolBond } from '@stacks/bitcoin-staking';

const poxInfo = await fetchPoxInfo({ network: 'mainnet' });
const bondIndex = 0;

const bond = await fetchProtocolBond({ bondIndex, network: 'mainnet' });
const status = bondStatus({ bondIndex, poxInfo, isBondSetup: bond !== undefined });
```

#### Notes

* With `start` = [bondPeriodToBurnHeight](/reference/stacks.js/stacks-bitcoin-staking/cycles/bondperiodtoburnheight.md), `end` = `start + 12 * rewardCycleLength` and `height` = `poxInfo.currentBurnchainBlockHeight`:

| `isBondSetup` | Condition                                     | Result        |
| ------------- | --------------------------------------------- | ------------- |
| `false`       | `height < start - 2 * rewardCycleLength`      | `'too-early'` |
| `false`       | `height < start`                              | `'eligible'`  |
| `false`       | otherwise                                     | `'missed'`    |
| `true`        | `height < start - prepareCycleLength`         | `'open'`      |
| `true`        | `height < end - floor(rewardCycleLength / 2)` | `'locked'`    |
| `true`        | `height <= end`                               | `'unlocked'`  |
| `true`        | otherwise                                     | `'finished'`  |

* Set-up results match the ranges from [bondPhaseRanges](/reference/stacks.js/stacks-bitcoin-staking/cycles/bondphaseranges.md), except that `'finished'` has no upper bound.
* `'open'` means bond timing allows registration. The prepare phase of the cycle two before the start falls inside it, and `register-for-bond` fails there with `ERR_STAKE_IN_PREPARE_PHASE (u47)`. Check with [isInPreparePhase](/reference/stacks.js/stacks-bitcoin-staking/cycles/isinpreparephase.md).
* Throws an `Error` whose message starts with `pox-5 not activated yet` if `poxInfo.contractVersions` has no pox-5 entry.

[**Reference Link**](https://github.com/stx-labs/stacks.js/blob/6101c99efe5a9616ce7e16cef68e28fd10676e7e/packages/bitcoin-staking/src/cycles.ts#L342-L389)

***

### Signature

```ts
function bondStatus(opts: {
  bondIndex: number;
  poxInfo: PoxInfo;
  isBondSetup: boolean;
}): BondStatusName;
```

***

### Returns

`BondStatusName`

A [BondStatusName](/reference/stacks.js/stacks-bitcoin-staking/cycles/bondstatusname.md).

***

### Parameters

#### opts.bondIndex (required)

* **Type**: `number`

The bond index.

#### opts.poxInfo (required)

* **Type**: `PoxInfo`

A [PoxInfo](/reference/stacks.js/stacks-bitcoin-staking/types/poxinfo.md), usually from [fetchPoxInfo](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchpoxinfo.md). The status is computed at its `currentBurnchainBlockHeight`.

#### opts.isBondSetup (required)

* **Type**: `boolean`

Whether `setup-bond` has run for this bond: `true` when [fetchProtocolBond](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchprotocolbond.md) returns a bond, `false` when it returns `undefined`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stacks.co/reference/stacks.js/stacks-bitcoin-staking/cycles/bondstatus.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.