# SDK reference

> This tree is generated by `site/scripts/gen-sdk-reference.ts` from the [bitbadgesjs SDK source](https://github.com/BitBadges/bitbadgesjs/tree/master/packages/bitbadgesjs-sdk). Do not hand-edit these pages — run `bun run gen:sdk` from `site/` instead.

Every symbol the [`bitbadges`](https://www.npmjs.com/package/bitbadges) npm package exports, one page each — 1666 pages carrying the signatures, fields, type parameters and source comments TypeDoc reads out of the SDK. This tree is the lookup surface. For task-first prose — install, query, sign, broadcast — read [the SDK guide](https://docs.bitbadges.io/sdk) first, then come here for the exact shape of a symbol.

## Start here

The handful of exports almost every integration touches.

| Symbol | What it is |
| --- | --- |
| [`BitBadgesAPI`](https://docs.bitbadges.io/sdk/reference/classes/bit-badges-api) | The REST API client. Every indexer route hangs off this class. |
| [`BitBadgesSigningClient`](https://docs.bitbadges.io/sdk/reference/classes/bit-badges-signing-client) | Signs and broadcasts transactions: gas simulation, sequence retry, Cosmos and EVM paths. |
| [`WalletAdapter`](https://docs.bitbadges.io/sdk/reference/interfaces/wallet-adapter) | The signer contract the signing client takes. Implement it to plug in your own wallet. |
| [`GenericCosmosAdapter`](https://docs.bitbadges.io/sdk/reference/classes/generic-cosmos-adapter) | Cosmos-side adapter: Keplr, Leap, or a mnemonic. |
| [`GenericEvmAdapter`](https://docs.bitbadges.io/sdk/reference/classes/generic-evm-adapter) | EVM-side adapter: MetaMask, an ethers signer, or a mnemonic. |
| [`MsgCreateCollection`](https://docs.bitbadges.io/sdk/reference/classes/msg-create-collection) | Create a collection. |
| [`MsgUpdateCollection`](https://docs.bitbadges.io/sdk/reference/classes/msg-update-collection) | Update a collection you manage. |
| [`MsgTransferTokens`](https://docs.bitbadges.io/sdk/reference/classes/msg-transfer-tokens) | Move tokens — the message behind mints, transfers and burns. |
| [`Balance`](https://docs.bitbadges.io/sdk/reference/classes/balance) | An amount over a set of token ids for a set of ownership times. |
| [`UintRange`](https://docs.bitbadges.io/sdk/reference/classes/uint-range) | An inclusive `start`–`end` range. Token ids, times and ids are all expressed with it. |
| [`Transfer`](https://docs.bitbadges.io/sdk/reference/classes/transfer) | One `from` -> `toAddresses` movement inside a transfer message. |
| [`CollectionApproval`](https://docs.bitbadges.io/sdk/reference/classes/collection-approval) | A collection-level approval and its criteria. |
| [`NumberType`](https://docs.bitbadges.io/sdk/reference/type-aliases/number-type) | `bigint \| number \| string` — the numeric layer every type is generic over. |
| [`BigIntify`](https://docs.bitbadges.io/sdk/reference/functions/big-intify) | The converter to pass everywhere; keeps chain-scale numbers exact. |
| [`convertToBitBadgesAddress`](https://docs.bitbadges.io/sdk/reference/functions/convert-to-bit-badges-address) | Normalise any supported chain address to its `bb1…` form. |

## Browse everything

| Group | Pages | What is in it |
| --- | --- | --- |
| [Classes](https://docs.bitbadges.io/sdk/reference/classes) | 437 | Everything with behaviour: the API client, the signing client, wallet adapters, message builders, and the core value types. |
| [Interfaces](https://docs.bitbadges.io/sdk/reference/interfaces) | 737 | The `iFoo` shapes each class accepts and returns — what you annotate parameters and responses with. |
| [Functions](https://docs.bitbadges.io/sdk/reference/functions) | 365 | Standalone helpers: number conversion, address conversion and validation, range and balance maths. |
| [Type aliases](https://docs.bitbadges.io/sdk/reference/type-aliases) | 59 | Named unions and generics — `NumberType`, view keys, payload aliases. |
| [Variables](https://docs.bitbadges.io/sdk/reference/variables) | 51 | Exported constants: network presets, well-known ids, default configs. |
| [Enumerations](https://docs.bitbadges.io/sdk/reference/enumerations) | 9 | Closed sets the chain and API accept. |

Or read [every export on one page](https://docs.bitbadges.io/sdk/reference/globals) — the flat index TypeDoc emits, grouped by kind.

## How this tree is generated

`bun run gen:sdk` from `site/` runs TypeDoc over `packages/bitbadgesjs-sdk/src` in a bitbadgesjs checkout and rewrites the markdown into this corpus: one H1 per page, a `description` in frontmatter, and every intra-tree link pointed at its site route. The vendored `proto.cosmos` / `proto.google` / `proto.tendermint` namespaces are dropped — another ~1600 pages of third-party scaffolding with no BitBadges-specific content. Symbols the SDK exports at top level are kept, protobuf-generated ones included.

CI keeps it current: `.github/workflows/sync-sdk-reference.yml` regenerates the tree when bitbadgesjs publishes a change and opens a PR. See `_docs/runbooks/docs-sync.md`.