Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RGB-WG/rgb
RGB smart contracts: command-line tool & wallet runtime library for desktop and mobile integration
https://github.com/RGB-WG/rgb
bitcoin command-line-tool lightning lightning-network lnp-bp rgb rgb-contracts rust smat-contracts
Last synced: about 1 month ago
JSON representation
RGB smart contracts: command-line tool & wallet runtime library for desktop and mobile integration
- Host: GitHub
- URL: https://github.com/RGB-WG/rgb
- Owner: RGB-WG
- License: apache-2.0
- Created: 2023-03-08T23:42:14.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T01:09:30.000Z (8 months ago)
- Last Synced: 2024-04-14T02:54:02.801Z (8 months ago)
- Topics: bitcoin, command-line-tool, lightning, lightning-network, lnp-bp, rgb, rgb-contracts, rust, smat-contracts
- Language: Rust
- Homepage: https://rgb.tech
- Size: 655 KB
- Stars: 116
- Watchers: 10
- Forks: 31
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-rgb-protocol - RGB CLI
- awesome-rgb - RGB (Contracts/Cli)
README
# RGB smart contracts
[](https://codecov.io/gh/RGB-WG/rgb)
[](https://crates.io/crates/rgb-wallet)
[](https://docs.rs/rgb-wallet)
[](https://github.com/rust-secure-code/safety-dance/)
[](./LICENSE)
RGB is confidential & scalable client-validated smart contracts for Bitcoin &
Lightning. It embraces the concepts of private & mutual ownership, abstraction
and separation of concerns and represents "post-blockchain", Turing-complete
form of trustless distributed computing which does not require introduction of
"tokens". To learn more about RGB please check [RGB black paper][Blackpaper]
and [RGB Tech] websites.
This repository provides client-facing library which can be used by desktop
apps and mobile wallets for integrating RGB support. It also provides binary
`rgb` which runs in the command-line and exposes all RGB functionality locally,
requiring only Electrum server.
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-2023
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].
## Installing
First, you need to install [cargo](https://doc.rust-lang.org/cargo/).
Minimum supported rust compiler version (MSRV) is shown in `rust-version` of `Cargo.toml`.
Next, you need to install developer components, which are OS-specific:
* Linux
```
sudo apt update
sudo apt install -y build-essential cmake pkg-config
```
* MacOS
```
brew install cmake pkg-config
```
* Windows: download and install the
latest [Build Tools for Visual Studio](https://aka.ms/vs/17/release/vs_BuildTools.exe), including the 'Desktop
development with C++' workflow and recommended optional features
Finally, install RGB command-line utility shipped with this repo by running
```
cargo install rgb-wallet
```
To use the library from other rust code add dependency to the `Cargo.toml` file:
```toml
[dependencies]
rgb-std = "0.11.0-beta.7" # use the latest version
rgb-runtime = "0.11.0-beta.7" # use the latest version
```
## Using command-line
## Contributing
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.
[Association]: https://lnp-bp.org
[Blackpaper]: https://blackpaper.rgb.tech
[RGB Tech]: https://rgb.tech
[FAQ]: https://rgbfaq.com
[Max]: https://github.com/dr-orlovsky
[Todd]: https://petertodd.org/
[Zucco]: https://giacomozucco.com/
[VS]: https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170