Reference
Exact and complete answers, for when you know what you are looking for. Each page links back to the guide or lesson that explains its subject.
| Page | Look here for |
|---|---|
| API at a glance | Every entry point, container member and handle method, signers, the model, stores, events and the testing kit |
| Configuration | Every option with its default: container, chains, providers, wallets, lifecycle, transport, family options, environment variables |
| Core concepts | The vocabulary: handle, Operation, Attempt, evidence, ordering slot, stores, … each with an example |
| Errors | Every error class and code, and the safe action for each |
| Capabilities | What each capability means, and which chains have it |
| Networks | Every family and network: fees, finality, tokens, presets, limits and safeguards |
| Glossary | Every term in a sentence, from "account model" to "xpub" |
| Versioning and stability | What semver covers, and the Node.js, TypeScript and SDK support policy |
| Known limitations | What crypto-aio does not do yet, and what to do about each |
| Upgrade to 1.0 | Every breaking change since 0.1.0, and what to change |
TIP
Press Ctrl + K (or ⌘ + K) anywhere to search every page, including each error code and glossary term.
The type-level reference, generated from the source with TypeDoc, is described in API at a glance. Release notes are in the changelog.