# RGB Core Library
[](https://codecov.io/gh/RGB-WG/rgb-core)
[](https://crates.io/crates/rgb-core)
[](https://docs.rs/rgb-core)
[](https://github.com/rust-secure-code/safety-dance/)
[](./LICENSE)
RGB is confidential & scalable client-validated smart contracts for Bitcoin &
Lightning. To learn more about RGB please check [RGB blueprint][Blueprint] and
[RGB FAQ][FAQ] websites.
RGB Core library provides consensus-critical and validation code for RGB.
It is a standard implementation, jointly with [LNP/BP Standards][LNPBPs]
defining RGB consensus and validation rules.
The consensus-critical code library is shared with the following libraries:
1. [Client-side-validation Foundation Lib][Foundation]. It is
non-bitcoin-specific library, covering concepts related to
client-side-validation (commitments, single-use-seals abstracted from
bitcoin, consensus-critical data encoding protocols).
2. [BP Core Lib][BP]. This is client-side-validation applied to bitcoin protocol
with deterministic bitcoin commitments (tapret) and TXO-based
single-use-seals.
3. [AluVM virtual machine][AluVM] used by RGB for Turing-complete smart contract
functionality.
4. [Encoding schema][StenS], defining structured data types used in RGB smart
contracts.
The development of the project is supported and managed by [LNP/BP Standards
Association][Association]. The design of RGB smart contract system and
implementation of this and underlying consensus libraries was done in 2019-2022
by [Dr Maxim Orlovsky][Max] basing or earlier ideas of client-side-validation
and RGB as "assets for bitcoin and LN" by [Peter Todd][Todd] and
[Giacomo Zucco][Zucco]. Upon the release of RGBv1 the protocol will be immutable
and this library will accept only bugfixes; i.e. it will be ossified by
requiring consensus ACK for the new changes across the large set of maintainers.
The current list of the projects based on the library include:
* [RGB Standard Lib][RGB Std]: library providing high-level RGB smart contract
API in rust.
* [RGB Node][RGB Node]: standalone & embeddable node for running RGB.
* [MyCitadel Node][MyCitadel Node]: wallet node providing RGB smart contract
functionality integrated with Lightning network, bitcoin blockchain indexers,
decentralized data storage and propagation (Storm) and wallet services. It can
run as embedded, desktop, server or cloud-based node.
## Use
Minimum supported rust compiler version (MSRV): 1.59, rust 2022 edition.
The library can be integrated into other rust projects via `Cargo.toml`
`[dependecies]` section:
```toml
[dependencies]
rgb-core = "0.8"
```
If the library will be used for wallet applications and work with PSBT files,
than use `wallet` feature, which is non-default:
```toml
[dependencies]
rgb-core = { version = "0.8", features = ["wallet"] }
```
For serialization purposes library provides `serde` feature, which is turned off
by default.
## Contributing
Currently, library functionality is freezed and as a part of ossification only
bugfixes are accepted.
Altcoins and "blockchains" other than Bitcoin blockchain/Bitcoin protocols are
not supported and not planned to be supported; pull requests targeting them will
be declined.
## License
See [LICENCE](LICENSE) file.
[LNPBPs]: https://github.com/LNP-BP/LNPBPs
[Association]: https://lnp-bp.org
[Blueprint]: https://rgb.network
[FAQ]: https://rgbfaq.com
[Foundation]: https://github.com/LNP-BP/client_side_validation
[BP]: https://github.com/BP-WG/bp-core
[AluVM]: https://github.com/Internet2-WG/rust-aluvm
[StenS]: https://github.com/Internet2-WG/rust-stens
[RGB Std]: https://github.com/RGB-WG/rgb-std
[RGB Node]: https://github.com/RGB-WG/rgb-node
[MyCitadel Node]: https://github.com/MyCitadel/mycitadel-node
[Max]: https://github.com/dr-orlovsky
[Todd]: https://petertodd.org/
[Zucco]: https://giacomozucco.com/