> 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/types/earnedrewards.md).

# EarnedRewards

The rewards a signer-manager has earned for one reward cycle and one leg, in sats of sBTC. Returned by [fetchEarned](/reference/stacks.js/stacks-bitcoin-staking/fetch/fetchearned.md), which wraps the pox-5 [`get-earned`](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L2341-L2354) read-only.

***

### Usage

```ts
import { fetchEarned } from '@stacks/bitcoin-staking';

// Bond leg of bond 1; omit bondIndex for the STX-only leg
const earnedSats = await fetchEarned({
  signerManager: 'SP2C2YFP12AJZB4MABJBAJ55XECVS7E4PMMZ89YZR.my-signer-manager',
  rewardCycle,
  bondIndex: 1,
  network: 'mainnet',
});
```

#### Notes

* The amount is in sats. pox-5 accrues rewards from its sBTC balance ([`get-rewards`](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L2135-L2145)) and [`claim-rewards`](https://github.com/stacks-network/stacks-core/blob/10474cdec9f9c0bdf05841b58cffc89cdad87a9b/stackslib/src/chainstate/stacks/boot/pox-5.clar#L2387-L2438) pays them out as an sBTC transfer.
* The amount can change between this read and a later `claim-rewards`. A post condition on [buildClaimRewards](/reference/stacks.js/stacks-bitcoin-staking/build/buildclaimrewards.md) built from it can come in low and abort the claim with `abort_by_post_condition`.

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

***

### Definition

```ts
export type EarnedRewards = bigint;
```


---

# 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/types/earnedrewards.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.