In-depth technical documentation for developers who want to understand the internals of the FROSTR protocol and Bifrost SDK.
| Document | Description |
|---|---|
| Guide | Getting started with code examples and interactive demo |
| API Reference | Full API documentation |
| Development | Build, test, debugging, and git workflow |
| Contributing | Code style, PR process, and testing guidelines |
| Migration | Version upgrade guides |
| Glossary | Definitions of protocol-specific terminology |
| Architecture | System components, data flow, and extension points |
| Protocol | Wire protocol specification and message formats |
| Cryptography | Cryptographic primitives, FROST protocol, and security properties |
| Security | Threat model and deployment guidance |
For new contributors:
- Glossary - Establish vocabulary
- Guide - See the protocol in action
- Development - Build, test, and debug
- Architecture - See how components fit together
- Cryptography - Understand the crypto foundations
- Protocol - Learn the wire format and nonce management
- FROST Paper - Original protocol specification
- BIP-340 - Schnorr signature standard
- Noble Cryptography - Underlying crypto libraries
- Nostr Protocol - Transport layer
See CONTRIBUTING.md for full guidelines. Quick tips for documentation:
- Use terminology from GLOSSARY.md
- Reference source files with
file.ts:lineformat - Keep code examples synchronized with actual API
- Update cross-references when adding new documents