SDK reference
Every symbol the BitBadges TypeScript SDK exports — 1710 generated reference pages across classes, interfaces, functions, type aliases, variables, enumerations.
This tree is generated by
site/scripts/gen-sdk-reference.tsfrom the bitbadgesjs SDK source. Do not hand-edit these pages — runbun run gen:sdkfromsite/instead.
Every symbol the bitbadges npm package exports, one page each — 1710 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 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 | The REST API client. Every indexer route hangs off this class. |
BitBadgesSigningClient | Signs and broadcasts transactions: gas simulation, sequence retry, Cosmos and EVM paths. |
WalletAdapter | The signer contract the signing client takes. Implement it to plug in your own wallet. |
GenericCosmosAdapter | Cosmos-side adapter: Keplr, Leap, or a mnemonic. |
GenericEvmAdapter | EVM-side adapter: MetaMask, an ethers signer, or a mnemonic. |
MsgCreateCollection | Create a collection. |
MsgUpdateCollection | Update a collection you manage. |
MsgTransferTokens | Move tokens — the message behind mints, transfers and burns. |
Balance | An amount over a set of token ids for a set of ownership times. |
UintRange | An inclusive start–end range. Token ids, times and ids are all expressed with it. |
Transfer | One from -> toAddresses movement inside a transfer message. |
CollectionApproval | A collection-level approval and its criteria. |
NumberType | bigint | number | string — the numeric layer every type is generic over. |
BigIntify | The converter to pass everywhere; keeps chain-scale numbers exact. |
convertToBitBadgesAddress | Normalise any supported chain address to its bb1… form. |
Browse everything
| Group | Pages | What is in it |
|---|---|---|
| Classes | 437 | Everything with behaviour: the API client, the signing client, wallet adapters, message builders, and the core value types. |
| Interfaces | 737 | The iFoo shapes each class accepts and returns — what you annotate parameters and responses with. |
| Functions | 385 | Standalone helpers: number conversion, address conversion and validation, range and balance maths. |
| Type aliases | 80 | Named unions and generics — NumberType, view keys, payload aliases. |
| Variables | 54 | Exported constants: network presets, well-known ids, default configs. |
| Enumerations | 9 | Closed sets the chain and API accept. |
Or read every export on one page — 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: the root .github/workflows/docs-sync-sdk-reference.yml regenerates the tree after the accepted public SDK pin changes and opens a PR. See _docs/runbooks/docs-sync.md.