circle_developer_controlled_wallets/lib.rs
1//! Rust client for the Circle Web3 Services Developer-Controlled Wallets API.
2//!
3//! This crate provides a typed, async HTTP client for the
4//! [Circle W3S Developer-Controlled Wallets API](https://developers.circle.com/api-reference/w3s/developer-controlled-wallets),
5//! where your service holds the signing keys on behalf of users.
6//!
7//! ## Covered Endpoints
8//!
9//! | Module | Functionality |
10//! |--------|---------------|
11//! | [`models::wallet_set`] | Create and manage wallet sets |
12//! | [`models::wallet`] | Create wallets, query balances and NFTs |
13//! | [`models::transaction`] | Initiate and track on-chain transactions |
14//! | [`models::signing`] | Sign messages and typed data |
15//! | [`models::token`] | Look up token metadata |
16//!
17//! ## Quick Start
18//!
19//! ```no_run
20//! use circle_developer_controlled_wallets::{
21//! DeveloperWalletsClient, models::wallet::ListWalletsParams,
22//! };
23//!
24//! #[tokio::main]
25//! async fn main() -> Result<(), circle_developer_controlled_wallets::Error> {
26//! let client = DeveloperWalletsClient::new("your_api_key");
27//! let params = ListWalletsParams::default();
28//! let wallets = client.list_wallets(¶ms).await?;
29//! println!("Found {} wallets", wallets.data.wallets.len());
30//! Ok(())
31//! }
32//! ```
33//!
34//! ## Authentication
35//!
36//! All requests require a Circle API key, which can be created in the
37//! [Circle Developer Console](https://console.circle.com).
38//!
39//! ## Error Handling
40//!
41//! Every fallible operation returns [`Error`], which captures both HTTP-level
42//! transport failures and API-level error responses from Circle.
43
44#![deny(missing_docs)]
45
46pub mod client;
47pub mod error;
48pub mod models;
49
50pub use client::DeveloperWalletsClient;
51pub use error::Error;