Reference
The reference is the source of truth for symbols, signatures, and schemas. Most pages here are auto-generated from the underlying source — zod schemas, TypeChain factories, Solidity ABIs, GraphQL queries. The pipeline that produces them lives at scripts/docs-gen/.
Generated pages carry a banner: "Generated from <source>@<commit>. Edit the source, not this page."
Sections
- Core SDK —
@bosonprotocol/core-sdkand its mixins. - MCP tools — all ~56 tools, one page per tool.
- Contracts — Diamond facets, events, errors, structs.
- React Kit — components and hooks.
- x402b packages — the seven
x402-*packages. - Metadata schemas —
PRODUCT_V1,BUNDLE,BASE. - Subgraph queries — GraphQL schema and common queries.
- Widget URL params — every parameter accepted by hosted widgets.
Conventions
- TypeScript types are rendered with Twoslash; hover over identifiers in code blocks for inline type info.
- Solidity types are rendered from NatSpec; click through to GitHub for the source.
- Zod schemas are rendered as inline tables with type, required/optional, default.
- Errors are listed per-page with code, when-thrown, and what-to-do.
When the reference is wrong
Open an issue or PR against the source-of-truth file, not the generated page. The pipeline rebuilds on every commit.
Searching
The site search is biased down for Reference pages (so concept queries land on Concepts first). To search reference specifically, use the search input on this page or browse the sidebar.