xrpl-rust

[!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 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 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 environment.

WIP - Help Welcome

🛠 Installation

To install, add the following to your project's Cargo.toml:

[dependencies.xrpl]
version = "0.4.0"

🕮 Documentation

Documentation is available here.

⛮ Quickstart

TODO - Most core functionality is in place and working.

In Progress:

• no_std examples
• Response Models
• Benchmarks
• Integration tests

⚐ 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:

[dependencies.xrpl]
version = "0.4.0"
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

If you want to contribute to this project, see CONTRIBUTING.

🗎 License

The xrpl-rust library is licensed under the ISC License. See LICENSE for more information.