v2.0.1, async_callbacks and general optimizations.

- Increased visibility of `apis::*` to improve documentation.
- General cleaning of the API for documentation due to new linting.
- Refactored the Order Builder to be easier to manage.
- Refactored Message parsing for the WebSocket.
- Removed the `sub` and `unsub` functions from the websocket.
- Added support for the FuturesBalanceSummary channel for the websocket.
- JWT Generation Optimizations.
- Added PANIC and ERROR documentation.
- WebSocket MessageCallbacks are now asynchronous.
- Updated the `websocket` example to demonstrate using a callback function and not trait.
- Re-exporting `async_trait` for user friendliness.
- `FunctionCallback` automatically converts `async` and `sync` functions to trait-based.
- Added the `From` trait to convert from CandleUpdate to Candle.
- Documentation updates.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cbadv"
-version = "2.0.0"
+version = "2.0.1"
 edition = "2021"
 description = "Asynchronous Coinbase Advanced REST and WebSocket API"
 license = "MIT"
@@ -36,6 +36,7 @@ toml = { version = "0.8.19", optional = true }
 # WebSocket support
 tokio-tungstenite = { version = "0.24.0", features = ["native-tls"] }
 futures-util = "0.3.31"
+async-trait = "0.1.83"
 
 # Utilities
 uuid = { version = "1.11.0", features = [

README.md

@@ -76,8 +76,9 @@ Full API documentation is available at [docs.rs](https://docs.rs/cbadv/latest/cb
 Client: `use cbadv::{WebSocketClient, WebSocketClientBuilder}`
 
 - **Authentication**: `client.connect`
-- **Subscribe**: `client.subscribe` or `client.sub`
-- **Unsubscribe**: `client.unsubscribe` or `client.unsub`
+- **Subscribe**: `client.subscribe`
+- **Unsubscribe**: `client.unsubscribe`
+- **Listen**: `client.listen`
 - **Channels Supported**:
   - `Channel::STATUS`: Status
   - `Channel::CANDLES`: Candles

examples/account_api.rs

@@ -7,8 +7,8 @@
 
 use std::process::exit;
 
-use cbadv::account::AccountListQuery;
 use cbadv::config::{self, BaseConfig};
+use cbadv::models::account::AccountListQuery;
 use cbadv::RestClientBuilder;
 
 #[tokio::main]
@@ -21,7 +21,7 @@ async fn main() {
         Err(err) => {
             println!("Could not load configuration file.");
             if config::exists("config.toml") {
-                println!("File exists, {}", err);
+                println!("File exists, {err}");
                 exit(1);
             }
 
@@ -36,7 +36,7 @@ async fn main() {
     let mut client = match RestClientBuilder::new().with_config(&config).build() {
         Ok(c) => c,
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };
@@ -48,12 +48,12 @@ async fn main() {
         .get_by_id(product_name, &AccountListQuery::new())
         .await
     {
-        Ok(account) => println!("{:#?}", account),
-        Err(error) => println!("Unable to get account: {}", error),
+        Ok(account) => println!("{account:#?}"),
+        Err(error) => println!("Unable to get account: {error}"),
     }
 
     // Pull accounts by ID.
-    let mut account_uuid = "".to_string();
+    let mut account_uuid = String::new();
     println!("\n\nObtaining ALL accounts (non-standard).");
     match client.account.get_all(&AccountListQuery::new()).await {
         Ok(accounts) => {
@@ -68,7 +68,7 @@ async fn main() {
                 None => println!("Out of bounds, could not find account."),
             }
         }
-        Err(error) => println!("Unable to get accounts: {}", error),
+        Err(error) => println!("Unable to get accounts: {error}"),
     }
 
     // Parameters to send to the API.
@@ -79,17 +79,17 @@ async fn main() {
     match client.account.get_bulk(&query).await {
         Ok(accounts) => {
             println!("Accounts obtained: {:#?}", accounts.accounts.len());
-            for acct in accounts.accounts.iter() {
+            for acct in &accounts.accounts {
                 println!("Account name: {}", acct.currency);
             }
         }
-        Err(error) => println!("Unable to get all accounts: {}", error),
+        Err(error) => println!("Unable to get all accounts: {error}"),
     }
 
     // Get a singular account based on the UUID.
-    println!("\n\nObtaining Account by UUID: {}", account_uuid);
+    println!("\n\nObtaining Account by UUID: {account_uuid}");
     match client.account.get(&account_uuid).await {
-        Ok(account) => println!("{:#?}", account),
-        Err(error) => println!("Unable to get account: {}", error),
+        Ok(account) => println!("{account:#?}"),
+        Err(error) => println!("Unable to get account: {error}"),
     }
 }

examples/convert_api.rs

@@ -7,7 +7,7 @@
 use std::process::exit;
 
 use cbadv::config::{self, BaseConfig};
-use cbadv::convert::{ConvertQuery, ConvertQuoteRequest};
+use cbadv::models::convert::{ConvertQuery, ConvertQuoteRequest};
 use cbadv::RestClientBuilder;
 
 #[tokio::main]
@@ -22,7 +22,7 @@ async fn main() {
         Err(err) => {
             println!("Could not load configuration file.");
             if config::exists("config.toml") {
-                println!("File exists, {}", err);
+                println!("File exists, {err}");
                 exit(1);
             }
 
@@ -37,34 +37,33 @@ async fn main() {
     let mut client = match RestClientBuilder::new().with_config(&config).build() {
         Ok(c) => c,
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };
 
     // Create a quote to convert USDC to USD.
     println!(
-        "Creating a quote to convert {} {} to {}.",
-        amount, from_product, to_product
+        "Creating a quote to convert {amount} {from_product} to {to_product}."
     );
     let request = ConvertQuoteRequest::new(from_product, to_product, amount);
     let quote = match client.convert.create_quote(&request).await {
         Ok(q) => q,
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };
 
-    println!("Quote created: {:#?}", quote);
+    println!("Quote created: {quote:#?}");
     println!("\n\nObtain the quote with the quote_id: {}", quote.id);
     let query = ConvertQuery::new(from_product, to_product);
     match client.convert.get(&quote.id, &query).await {
         Ok(q) => {
-            println!("Quote obtained: {:#?}", q);
+            println!("Quote obtained: {q:#?}");
         }
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };

examples/custom_config.rs

@@ -54,7 +54,7 @@ async fn main() {
         Err(err) => {
             println!("Could not load configuration file.");
             if config::exists("config.toml") {
-                println!("File exists, {}", err);
+                println!("File exists, {err}");
                 exit(1);
             }
 
@@ -69,7 +69,7 @@ async fn main() {
     let mut client = match RestClientBuilder::new().with_config(&config).build() {
         Ok(c) => c,
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };
@@ -79,9 +79,9 @@ async fn main() {
     let product = match client.product.get(&config.general.product_id).await {
         Ok(p) => p,
         Err(err) => {
-            println!("{}", err);
+            println!("{err}");
             exit(1);
         }
     };
-    println!("{:#?}\n\n", product);
+    println!("{product:#?}\n\n");
 }

examples/data_api.rs

@@ -16,7 +16,7 @@ async fn main() {
         Err(err) => {
             println!("Could not load configuration file.");
             if config::exists("config.toml") {
-                println!("File exists, {}", err);
+                println!("File exists, {err}");
                 exit(1);
             }
 
@@ -31,15 +31,15 @@ async fn main() {
     let mut client = match RestClientBuilder::new().with_config(&config).build() {
         Ok(c) => c,
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };
 
     // Get the API key permissions.
     println!("Obtaining Key Permissions for the API key.");
     match client.data.key_permissions().await {
-        Ok(perm) => println!("{:#?}", perm),
-        Err(error) => println!("Unable to get the API key permissions: {}", error),
+        Ok(perm) => println!("{perm:#?}"),
+        Err(error) => println!("Unable to get the API key permissions: {error}"),
     }
 }

examples/fee_api.rs

@@ -6,8 +6,8 @@
 use std::process::exit;
 
 use cbadv::config::{self, BaseConfig};
-use cbadv::fee::FeeTransactionSummaryQuery;
-use cbadv::product::ProductType;
+use cbadv::models::fee::FeeTransactionSummaryQuery;
+use cbadv::models::product::ProductType;
 use cbadv::RestClientBuilder;
 
 #[tokio::main]
@@ -18,7 +18,7 @@ async fn main() {
         Err(err) => {
             println!("Could not load configuration file.");
             if config::exists("config.toml") {
-                println!("File exists, {}", err);
+                println!("File exists, {err}");
                 exit(1);
             }
 
@@ -33,7 +33,7 @@ async fn main() {
     let mut client = match RestClientBuilder::new().with_config(&config).build() {
         Ok(c) => c,
         Err(why) => {
-            eprintln!("!ERROR! {}", why);
+            eprintln!("!ERROR! {why}");
             exit(1)
         }
     };
@@ -44,7 +44,7 @@ async fn main() {
     // Get fee transaction summary.
     println!("Obtaining Transaction Fee Summary");
     match client.fee.get(&params).await {
-        Ok(summary) => println!("{:#?}", summary),
-        Err(error) => println!("Unable to get the Transaction Summary: {}", error),
+        Ok(summary) => println!("{summary:#?}"),
+        Err(error) => println!("Unable to get the Transaction Summary: {error}"),
     }
 }