https://github.com/sephynox/xrpl-rust
A 100% Rust library to interact with the XRPL. XRPL Grant Winner
https://github.com/sephynox/xrpl-rust
blockchain cryptocurrency ledger rust-lang xrp xrp-ledger xrpl
Last synced: 6 months ago
JSON representation
A 100% Rust library to interact with the XRPL. XRPL Grant Winner
- Host: GitHub
- URL: https://github.com/sephynox/xrpl-rust
- Owner: sephynox
- License: isc
- Created: 2021-09-30T21:35:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-28T15:12:44.000Z (over 1 year ago)
- Last Synced: 2024-05-02T01:22:39.982Z (over 1 year ago)
- Topics: blockchain, cryptocurrency, ledger, rust-lang, xrp, xrp-ledger, xrpl
- Language: Rust
- Homepage: https://crates.io/crates/xrpl-rust
- Size: 1.92 MB
- Stars: 15
- Watchers: 5
- Forks: 7
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-xrpl - xrpl-rust
README
# xrpl-rust 
[![latest]][crates.io] [![deps_status]][deps] [![audit_status]][audit] [![unit_status]][unit]
[latest]: https://img.shields.io/crates/v/xrpl-rust.svg
[crates.io]: https://crates.io/crates/xrpl-rust
[docs_status]: https://docs.rs/xrpl-rust/badge.svg
[docs]: https://docs.rs/xrpl-rust/latest/xrpl/
[deps_status]: https://deps.rs/repo/github/589labs/xrpl-rust/status.svg
[deps]: https://deps.rs/repo/github/589labs/xrpl-rust
[audit_status]: https://github.com/589labs/xrpl-rust/actions/workflows/audit_test.yml/badge.svg
[audit]: https://github.com/589labs/xrpl-rust/actions/workflows/audit_test.yml
[rustc]: https://img.shields.io/badge/rust-1.51.0%2B-orange.svg
[rust]: https://blog.rust-lang.org/2021/03/25/Rust-1.51.0.html
[unit_status]: https://github.com/589labs/xrpl-rust/actions/workflows/unit_test.yml/badge.svg
[unit]: https://github.com/589labs/xrpl-rust/actions/workflows/unit_test.yml
[contributors]: https://github.com/589labs/xrpl-rust/graphs/contributors
[contributors_status]: https://img.shields.io/github/contributors/589labs/xrpl-rust.svg
[license]: https://opensource.org/licenses/ISC
[license_status]: https://img.shields.io/badge/License-ISC-blue.svg
> [!WARNING]
> This repository is under active development. All releases before v1.0.0 can be considered as **beta-releases**
A Rust library to interact with the XRPL.
Based off of the [xrpl-py](https://github.com/XRPLF/xrpl-py) library.
A pure Rust implementation for interacting with the XRP Ledger. The xrpl-rust
crate simplifies the hardest parts of XRP Ledger interaction including
serialization and transaction signing while providing idiomatic Rust
functionality for XRP Ledger transactions and core server API (rippled)
objects.
Interactions with this crate occur using data structures from this crate or
core [alloc](https://doc.rust-lang.org/alloc) types with the exception of
serde for JSON handling and indexmap for dictionaries. The goal is to ensure
this library can be used on devices without the ability to use a
[std](hhttps://doc.rust-lang.org/std) environment.
> WIP - Help Welcome
# 🛠 Installation [![rustc]][rust]
To install, add the following to your project's `Cargo.toml`:
```toml
[dependencies.xrpl]
version = "0.5.0"
```
# 🕮 Documentation [![docs_status]][docs]
Documentation is available [here](https://docs.rs/xrpl-rust).
## ⛮ Quickstart
TODO - Most core functionality is in place and working.
In Progress:
- no_std examples
- Benchmarks
# ⚐ Flags
By default, the the following features are enabled:
- std
- core
- models
- wallet
- utils
- websocket
- json-rpc
- helpers
- tokio-rt
When `helpers` is enabled you also need to specify a `*-rt` feature flag as it is needed for waiting between requests when using the `submit_and_wait` function.
To operate in a `#![no_std]` environment simply disable the defaults
and enable features manually:
```toml
[dependencies.xrpl]
version = "*"
default-features = false
features = ["core", "models", "wallet", "utils", "websocket", "json-rpc", "helpers", "embassy-rt"]
```
## ⚙ #![no_std]
This library aims to be `#![no_std]` compliant.
# 🕊 Contributing [![contributors_status]][contributors]
If you want to contribute to this project, see [CONTRIBUTING](CONTRIBUTING.md).
# 🗎 License [![license_status]][license]
The `xrpl-rust` library is licensed under the ISC License.
See [LICENSE](LICENSE) for more information.