vertex_sdk/
lib.rs

1//! # vertex_sdk
2//!
3//! ## Usage
4//! See the [examples](https://github.com/vertex-protocol/vertex-rust-sdk/tree/main/examples) and [sanity](https://github.com/vertex-protocol/vertex-rust-sdk/tree/main/src/sanity) directories.
5//!
6//! ## Quickstart: `prelude`
7//! A prelude is provided which imports all the important data types and traits for you. Use this
8//! when you want to quickly bootstrap a new project.
9//!
10//! ```rust
11//! use vertex_sdk::prelude::*;
12//! ```
13//!
14//! ## Modules
15//! ### `core`
16//! Core traits that define API interaction. These traits must be imported when using the client. The
17//! simplest way to import the traits is by using the prelude.
18//!
19//! ### `vertex-utils`
20//! Contains request and response models.
21//!
22//! ### `builders`
23//! Use builders for improved UX when writing complex queries or executes. You can build each
24//! query or execute struct for later use or send it directly from the builder.
25//!
26//! ### `vertex_client`
27//! REST implementation of core traits.
28//!
29//! ### `sanity`
30//! Sanity checks for core SDK functionality.
31
32pub mod builders;
33pub mod core;
34pub mod sanity;
35pub mod utils;
36pub mod vertex_client;
37pub mod vertex_utils;
38
39#[doc(hidden)]
40pub use vertex_utils::*;
41
42pub mod prelude {
43    pub use crate::core::*;
44
45    pub use crate::utils::client_mode::ClientMode;
46
47    pub use crate::math::{to_i128_x18, to_i128_x6};
48    pub use crate::utils::private_key::private_key;
49    pub use crate::vertex_client::VertexClient;
50}