> 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/errors/describepox5error.md).

# describePox5Error

Looks up a pox-5 error number and returns its contract constant name and a one-line description. Pure computation over tables in the SDK.

***

### Usage

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

describePox5Error(7);
// { code: 7, name: 'ERR_BOND_NOT_FOUND', description: 'No bond was found for the supplied bond index.' }

describePox5Error(43n)?.name; // 'ERR_BOND_ALREADY_STARTED'
describePox5Error(6); // undefined: no pox-5 constant uses u6
```

#### Notes

* Accepts `number` or `bigint`. The input goes through `Number()` before the lookup.
* Returns `undefined` for any number that is not a [Pox5ErrorCode](/reference/stacks.js/stacks-bitcoin-staking/errors/pox5errorcode.md) value.
* Pair it with [parsePox5Error](/reference/stacks.js/stacks-bitcoin-staking/errors/parsepox5error.md) to describe a failed transaction's `(err uN)`. A number that came from another contract, such as the signer-manager or the sBTC token, returns a pox-5 description that does not apply, if the number is in use in pox-5.

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

***

### Signature

```ts
function describePox5Error(
  code: number | bigint
): { code: number; name: string; description: string } | undefined;
```

***

### Returns

`{ code: number; name: string; description: string } | undefined`

`undefined` for an unknown number, otherwise:

| Field         | Type     | Meaning                                                   |
| ------------- | -------- | --------------------------------------------------------- |
| `code`        | `number` | The error number                                          |
| `name`        | `string` | The contract constant, for example `'ERR_BOND_NOT_FOUND'` |
| `description` | `string` | One-line explanation from the SDK                         |

***

### Parameters

#### code (required)

* **Type**: `number | bigint`

The error number, as from [parsePox5Error](/reference/stacks.js/stacks-bitcoin-staking/errors/parsepox5error.md) or an [EligibilityResult](/reference/stacks.js/stacks-bitcoin-staking/eligibility/eligibilityresult.md) reason.


---

# 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/errors/describepox5error.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.