Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LNP-BP/rust-lnpbp
Library implementing LNPBP standards related to client-side-validation paradigm
https://github.com/LNP-BP/rust-lnpbp
bitcoin bitcoin-blockchain bitcoin-protocols client-side-validation lightning-network lnp-bp rust-library single-use-seals smart-contracts
Last synced: about 2 months ago
JSON representation
Library implementing LNPBP standards related to client-side-validation paradigm
- Host: GitHub
- URL: https://github.com/LNP-BP/rust-lnpbp
- Owner: LNP-BP
- License: mit
- Created: 2019-09-25T09:43:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-21T18:27:52.000Z (9 months ago)
- Last Synced: 2024-06-24T11:56:38.772Z (3 months ago)
- Topics: bitcoin, bitcoin-blockchain, bitcoin-protocols, client-side-validation, lightning-network, lnp-bp, rust-library, single-use-seals, smart-contracts
- Language: Rust
- Homepage: https://lnp-bp.org
- Size: 2.7 MB
- Stars: 79
- Watchers: 9
- Forks: 38
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rgb-protocol - Rust LNPBP
README
# LNP/BP Library
[](https://codecov.io/gh/LNP-BP/rust-lnpbp)
[](https://crates.io/crates/lnpbp)
[](https://docs.rs/lnpbp)
[](https://github.com/rust-secure-code/safety-dance/)
[](./LICENSE)
The repository represents a set of libraries implementing LNP/BP specifications
not fitting into a scope of other existing
LNP/BP core libraries (client-side-validation, BP, LNP, RGB, invoicing). It can
be used to simplify development of layer 2 & 3 solutions on top of Lightning
Network and Bitcoin blockchain.
Currently, the repository contains the following crates:
- `lnpbp_bech32`: library implementing LNPBP-14 standard of Bech32 encoding for
client-side-validated data.
- `lnpbp_chain`: library providing chain parameters for bitcoin-related
blockchains;
- `lnpbp_elgamal`: library implementing LNPBP-31 standard for ElGamal encryption
using Secp256k1 curve;
- LNPBP umbrella crate containing all aforementioned libraries.
Other libraries, implementing LNP/BP specifications, not included in this crate:
- Client-side-validation foundation libraries
([`client_side_validation`](https://github.com/LNP-BP/client_side_validation))
- Bitcoin protocol core library
([`bp-core`](https://github.com/LNP-BP/bp-core))
- Lightning network protocol core library
([`lnp-core`](https://github.com/LNP-BP/lnp-core))
- RGB core library implementing confidential & scalable smart contracts for
Bitcoin & Lightning ([`rgb-core`](https://github.com/rgb-org/rgb-core))
- [Universal invoicing library](https://github.com/LNP-BP/invoices)
The current list of the projects based on these libraries include:
* [RGB Node](https://github.com/rgb-org/rgb-node)
* [LNP Node](https://github.com/LNP-BP/lnp-node) enabling:
- RGB extensions
- DLC extensions
- [Lightspeed payments](https://github.com/LNP-BP/LNPBPs/issues/24)
- Multi-peer channels
- Faster lightning experiments (quicker adoption of eltoo, Taproot etc)
* [BP Node](https://github.com/LNP-BP/bp-node): Indexing service for bitcoin
blockchain; more efficient & universal Electrum server replacement. In
perspective - validating Bitcoin network node (using libbitcoinconsus)
Potentially, with LNP/BP libraries you can simplify the development of
* Discreet log contracts
* Implement experimental lightning features
* Do complex multi-threaded or elastic/dockerized client-service microservice
architectures
The development of the libraries is supported by LNP/BP Standards Association.
## Install
### Clone and compile library
Minimum supported rust compiler version (MSRV): 1.59.0.
```shell script
git clone https://github.com/lnp-bp/rust-lnpbp
cd rust-lnpbp
cargo build --release --all-features
```
The library can be found in `target/release` directory.
You can run full test suite with:
```shell
cargo test --workspace --all-features
```
Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/)
for more detailed instructions.
### Use library in other projects
Add these lines to your `Cargo.toml` file at the very end of the `[dependecies]`
section:
```toml
lnpbp = "~0.5.0"
lnpbp_bech32 = "~0.5.0"
lnpbp_chain = "~0.5.0"
lnpbp_elgamal = "~0.5.0"
```
## Contributing
Contribution guidelines can be found in a separate
[CONTRIBUTING](CONTRIBUTING.md) file
## More information
### Policy on Altcoins/Altchains
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.
### Licensing
See [LICENCE](./LICENSE) file.