> 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/eligibility/fetcheligibleclaimrewards.md).

# fetchEligibleClaimRewards

Dry-runs the checks of pox-5 `claim-rewards`, which pays a signer-manager its settled sBTC rewards for one reward cycle, and reports every gate that would fail. Run it before [buildClaimRewards](/reference/stacks.js/stacks-bitcoin-staking/build/buildclaimrewards.md).

***

### Usage

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

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

const result = await fetchEligibleClaimRewards({
  signerManager: 'SP2C2YFP12AJZB4MABJBAJ55XECVS7E4PMMZ89YZR.my-signer-manager',
  rewardCycle: poxInfo.rewardCycleId,
  bondIndices: [0],
  network: 'mainnet',
});

if (!result.ok) console.log(result.reasons); // Pox5ErrorCode values
```

#### Notes

* Mirrors the asserts of [`claim-rewards`](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L2387-L2438). The claimable total is the sum of [`get-earned`](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L2341-L2354) for the STX-only leg and for each entry in `bondIndices`, all at `rewardCycle`.
* `claim-rewards` pays `contract-caller`, so the signer-manager contract itself must make the call.
* `rewardCycle` is a reward cycle ID, not a distribution cycle index.
* The contract takes at most 6 bond indices (`(list 6 uint)`). This function does not check the list length.
* Not checked: the sBTC transfer from pox-5 to the signer-manager.
* Throws if a read returns a non-2xx response.

| Reason               | Contract error                   | Added when                                                                                  |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------- |
| `RewardsPaused`      | `ERR_REWARDS_PAUSED (u53)`       | The `rewards-paused` data-var is `true`. `pause-rewards` sets it, and no function clears it |
| `NoClaimableRewards` | `ERR_NO_CLAIMABLE_REWARDS (u32)` | The claimable total is 0 sats                                                               |

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

***

### Signature

```ts
function fetchEligibleClaimRewards(
  opts: {
    signerManager: string;
    rewardCycle: number;
    bondIndices: number[];
  } & NetworkClientParam
): Promise<EligibilityResult>;
```

`opts` also takes the [NetworkClientParam](/reference/stacks.js/stacks-network/network/networkclientparam.md) fields.

***

### Returns

`Promise<EligibilityResult>`

Resolves to an [EligibilityResult](/reference/stacks.js/stacks-bitcoin-staking/eligibility/eligibilityresult.md): `{ ok: true }`, or `{ ok: false, reasons }` with every failing gate from the Notes table.

***

### Parameters

#### opts.signerManager (required)

* **Type**: `string`

Contract ID of the signer-manager that would claim. It becomes the contract's `contract-caller`.

#### opts.rewardCycle (required)

* **Type**: `number`

Reward cycle to claim, for the STX-only leg and for every bond leg in `bondIndices`.

#### opts.bondIndices (required)

* **Type**: `number[]`

Bonds whose legs to claim. Pass `[]` to claim the STX-only leg alone.

#### opts.network (optional)

* **Type**: `StacksNetworkName | StacksNetwork`

The network to query: a name such as `'mainnet'` or `'testnet'`, or a [StacksNetwork](/reference/stacks.js/stacks-network/network/stacksnetwork.md) 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.


---

# 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/eligibility/fetcheligibleclaimrewards.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.