RGB documentation
Intro to RGB
RGB FAQ
RGB FAQ is an external resource maintained by our team which gives a high-level introduction into RGB and provides a detailed glossary.
Videos
Over the years we have made hundreds of videos, which not just explain RGB, but reveal the whole history of its design and development.
Guidelines
Check our guidelines, which help in getting started with RGB from both user and developer perspectives.
RGB Specifications
Black paper
Unlike an ICO "whitepaper", RGB blackpaper systematically explains RGB, its capabilities and most important applications without shilling any tokens.
Yellow paper
Yellow paper gives a formal description of RGB system in terms of distributed computing and computer science. It is work-in-progress and will be released later this year.
LNP/BP Standards
RGB is also defined in a number of LNPBP standards from LNP/BP Standards Association.
API references
Consensus level APIs
Library | Description | API Reference | Source code |
---|---|---|---|
Commit-verify | Commit-verify cryptographic schemes and multi-protocol commitments (LNPBP-4 standard) | https://docs.rs/commit_verify | LNP-BP/commit_verify |
Single-use-seals | Single-use-seals abstract APIs | https://docs.rs/single_use_seals | LNP-BP/single_use_seals |
BP DBC | Deterministic bitcoin commitments on bitcoin protocol | https://docs.rs/bp-dbc | BP-WG/bp-dbc |
BP Seals | Single-use-seals with bitcoin protocol | https://docs.rs/bp-seals | BP-WG/bp-seals |
RGB Core | Main consensus code for RGB | https://docs.rs/rgb-core | RGB-WG/rgb-core |
Integration level APIs
Library | Description | API Reference | Source code |
---|---|---|---|
RGB Standard Lib | RGB standard library for working with smart contracts on the lowest level | https://docs.rs/rgb-std | RGB-WG/rgb-std |
RGB Wallet Lib | Wallet-integration library for WASM apps providing RGB invoices and PSBT functionality | https://docs.rs/rgb-wallet | RGB-WG/rgb-wallet |
RGB Lib | High-level RGB integration library for mobile & desktop apps providing FS-based stash storage | https://docs.rs/rgb-contracts | RGB-WG/rgb |
Other resources
AluVM
Functional virtual machine used in RGB smart contracts and in lightning.
Strict types
Data type system, "protocol buffers for functional programming", used in RGB.
Contractum
Contractum is declarative programming language for smart contracts.