Merge pull request #94 from sephynox/dev

v0.4.0

Author: LimpidCrypto

.devcontainer/devcontainer.json

@@ -25,7 +25,8 @@
 				"panicbit.cargo",
 				"vadimcn.vscode-lldb",
 				"tamasfe.even-better-toml",
-				"Swellaby.vscode-rust-test-adapter"
+				"Swellaby.vscode-rust-test-adapter",
+				"fill-labs.dependi"
 			],
 			"settings": {
 				"files.autoSave": "onFocusChange",

.github/workflows/unit_test.yml

@@ -72,4 +72,4 @@ jobs:
         name: Test for no_std
         with:
           command: test
-          args: --release --no-default-features --features embassy-rt,core,wallet,models,helpers,websocket,json-rpc
+          args: --release --no-default-features --features embassy-rt,core,utils,wallet,models,helpers,websocket,json-rpc

CHANGELOG.md

@@ -13,7 +13,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [[Unreleased]]
 
-## [[v0.2.0-beta.1]]
+## [[v0.4.0]]
+
+- add amm support
+  - Transaction models
+  - Transaction signing
+  - Request models
+- add sidechain support
+  - Transaction models
+  - Transaction signing
+- improve errorhandling utilizing thiserror
+- simplifying feature flags
+
+## [[v0.3.0]]
 
 - Examples
   - Wallet from seed

Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "xrpl-rust"
-version = "0.3.0"
+version = "0.4.0"
 edition = "2021"
 authors = [
     "Tanveer Wahid <tan@wahid.email>",
-    "Steffen Konermann <contact@limpidcrypto.com>",
+    "LimpidCrypto <contact@limpidcrypto.com>",
 ]
 description = "A 100% Rust library to interact with the XRPL"
 readme = "README.md"
@@ -33,14 +33,14 @@ ed25519-dalek = { version = "2.1.1", default-features = false, features = [
     "alloc",
     "zeroize",
 ] }
-secp256k1 = { version = "0.29.0", default-features = false, features = [
+secp256k1 = { version = "0.30.0", default-features = false, features = [
     "alloc",
 ] }
 bs58 = { version = "0.5.0", default-features = false, features = [
     "check",
     "alloc",
 ] }
-indexmap = { version = "2.0.0", features = ["serde"] }
+indexmap = { version = "2.6.0", features = ["serde"] }
 regex = { version = "1.5.4", default-features = false }
 strum = { version = "0.26.3", default-features = false }
 strum_macros = { version = "0.26.4", default-features = false }
@@ -61,11 +61,10 @@ serde_json = { version = "1.0.68", default-features = false, features = [
 serde_with = "3.2.0"
 serde_repr = "0.1"
 zeroize = "1.5.7"
-hashbrown = { version = "0.14.5", features = ["serde"] }
+hashbrown = { version = "0.15.0", features = ["serde"] }
 fnv = { version = "1.0.7", default-features = false }
 derive-new = { version = "0.7.0", default-features = false }
 thiserror-no-std = "2.0.2"
-anyhow = { version = "1.0.69", default-features = false }
 embassy-sync = "0.6.0"
 
 # networking
@@ -77,23 +76,25 @@ embassy-time = { version = "0.3.2", optional = true }
 embedded-websocket-embedded-io = { version = "0.1.0", optional = true, default-features = false, features = [
     "embedded-io-async",
 ] }
-reqwless = { version = "0.12.1", optional = true }
+reqwless = { version = "0.13.0", optional = true }
 reqwest = { version = "0.12.7", optional = true, features = ["json"] }
-tokio-tungstenite = { version = "0.23.1", optional = true, features = [
+tokio-tungstenite = { version = "0.24.0", optional = true, features = [
     "native-tls",
 ] }
 embassy-futures = { version = "0.1.1" }
-embedded-nal-async = { version = "0.7.1", optional = true }
+embedded-nal-async = { version = "0.8.0", optional = true }
 actix-rt = { version = "2.10.0", optional = true }
 async-std = { version = "1.13.0", optional = true }
 futures-executor = { version = "0.3.30", optional = true }
 futures-timer = { version = "3.0.3", optional = true }
 smol = { version = "2.0.2", optional = true }
+bigdecimal = { version = "0.4.5", features = ["serde-json"] }
 
 [dev-dependencies]
 criterion = "0.5.1"
 tokio = { version = "1.0", features = ["full"] }
 embedded-io-adapters = { version = "0.6.1", features = ["tokio-1"] }
+anyhow = { version = "1.0.91", no-default-features = true }
 
 [[bench]]
 name = "benchmarks"
@@ -108,42 +109,15 @@ default = [
     "models",
     "utils",
     "helpers",
-    "websocket",
     "json-rpc",
+    "websocket",
 ]
-models = [
-    "transaction-models",
-    "request-models",
-    "ledger-models",
-    "result-models",
-]
-transaction-models = ["core"]
-request-models = []
-result-models = ["request-models", "ledger-models"]
-ledger-models = []
-helpers = [
-    "account-helpers",
-    "ledger-helpers",
-    "transaction-helpers",
-    "wallet-helpers",
-]
-account-helpers = ["core", "request-models", "result-models"]
-ledger-helpers = ["request-models", "result-models"]
-wallet-helpers = ["wallet", "request-models", "result-models"]
-transaction-helpers = [
-    "wallet",
-    "account-helpers",
-    "ledger-helpers",
-    "request-models",
-    "result-models",
-    "transaction-models",
-    "ledger-models",
-]
+models = ["core"]
+helpers = ["core", "models", "wallet"]
 wallet = ["core"]
-json-rpc = ["request-models", "result-models", "reqwless", "embedded-nal-async"]
+json-rpc = ["models", "reqwless", "embedded-io-async", "embedded-nal-async"]
 websocket = [
-    "request-models",
-    "result-models",
+    "models",
     "futures",
     "embedded-io-async",
     "embedded-websocket-embedded-io",

README.md

@@ -24,6 +24,9 @@
   <img alt="" src="/assets/xrpl-rust_black.png">
 </picture>
 
+> [!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.
 
@@ -47,7 +50,7 @@ To install, add the following to your project's `Cargo.toml`:
 
 ```toml
 [dependencies.xrpl]
-version = "0.1.1"
+version = "0.4.0"
 ```
 
 # 🕮 Documentation [![docs_status]][docs]
@@ -60,38 +63,37 @@ TODO - Most core functionality is in place and working.
 
 In Progress:
 
-- Models
-- Asynchronous ledger interactions
-  - JSON RPC
-  - API
-  - Websocket
+- no_std examples
+- Response Models
 - Benchmarks
 - Integration tests
 
 # ⚐ Flags
 
-By default, the `std` and `core` features are enabled.
+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 = "0.1.1"
+version = "0.4.0"
 default-features = false
-features = ["core", "models"]
+features = ["core", "models", "wallet", "utils", "websocket", "json-rpc", "helpers", "embassy-rt"]
 ```
 
-## ‼ Exported Dependencies
-
-### Serde
-
-This project exports [serde](https://serde.rs) for handling JSON.
-
-### Indexmap
-
-This project exports [indexmap](https://docs.rs/crate/indexmap) as `HashMap` is
-not supported in the `alloc` crate. TODO: Support both.
-
 ## ⚙ #![no_std]
 
 This library aims to be `#![no_std]` compliant.

benches/benchmarks.rs

@@ -1,5 +1,5 @@
 use criterion::{black_box, criterion_group, criterion_main, Criterion};
-use xrpl::core::definitions::get_field_type_name;
+use xrpl::core::binarycodec::definitions::get_field_type_name;
 use xrpl::utils::xrp_to_drops;
 
 pub fn bench_xrp_to_drops(c: &mut Criterion) {

src/_anyhow/mod.rs

@@ -1,5 +1,4 @@
 use alloc::borrow::Cow;
-use anyhow::Result;
 use embassy_futures::block_on;
 
 use crate::{
@@ -12,6 +11,7 @@ use crate::{
             get_xrp_balance as async_get_xrp_balance,
         },
         clients::XRPLClient,
+        exceptions::XRPLHelperResult,
     },
     models::{ledger::objects::AccountRoot, results::account_tx::AccountTx, XRPAmount},
 };
@@ -20,7 +20,7 @@ pub fn does_account_exist<C>(
     address: Cow<'_, str>,
     client: &C,
     ledger_index: Option<Cow<'_, str>>,
-) -> Result<bool>
+) -> XRPLHelperResult<bool>
 where
     C: XRPLClient,
 {
@@ -31,7 +31,7 @@ pub fn get_next_valid_seq_number<C>(
     address: Cow<'_, str>,
     client: &C,
     ledger_index: Option<Cow<'_, str>>,
-) -> Result<u32>
+) -> XRPLHelperResult<u32>
 where
     C: XRPLClient,
 {
@@ -46,7 +46,7 @@ pub fn get_xrp_balance<'a: 'b, 'b, C>(
     address: Cow<'a, str>,
     client: &C,
     ledger_index: Option<Cow<'a, str>>,
-) -> Result<XRPAmount<'b>>
+) -> XRPLHelperResult<XRPAmount<'b>>
 where
     C: XRPLClient,
 {
@@ -57,7 +57,7 @@ pub fn get_account_root<'a: 'b, 'b, C>(
     address: Cow<'a, str>,
     client: &C,
     ledger_index: Cow<'a, str>,
-) -> Result<AccountRoot<'b>>
+) -> XRPLHelperResult<AccountRoot<'b>>
 where
     C: XRPLClient,
 {
@@ -67,7 +67,7 @@ where
 pub fn get_latest_transaction<'a: 'b, 'b, C>(
     address: Cow<'a, str>,
     client: &C,
-) -> Result<AccountTx<'b>>
+) -> XRPLHelperResult<AccountTx<'b>>
 where
     C: XRPLClient,
 {