lexe 0.1.5

Lexe Rust SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

// Use README.md as module docs
#![doc = include_str!("../README.md")]
//
// NOTE: Docs for all stable APIs (i.e. all public items accessible via this
// crate) must be written for consumption by external users.
//
// Preview the public API rustdoc: `$ just docs-build-rustdoc --open`
//
// - Internal-facing documentation can still be written for public items, but
//   should be placed in `//` comments, not `///` comments, to avoid being
//   rendered in the public API docs at <rust.lexe.tech>.
// - `///` comments are still preferred for private, crate-private, and unstable
//   items.
#![deny(missing_docs)]

// --- Public API --- //
//
// All APIs accessible via these public modules must respect semver guarantees.

/// Configuration options for a `LexeWallet`.
pub mod config;
/// Types used by the Lexe SDK.
pub mod types;
/// `LexeWallet`: the top-level handle to a Lexe wallet.
pub mod wallet;

/// Returns the default Lexe data directory (`~/.lexe`).
pub use lexe_common::default_lexe_data_dir;

/// `BlockingLexeWallet`: synchronous wrapper around `LexeWallet`.
///
/// Enabled by the `blocking` feature flag.
#[cfg(feature = "blocking")]
pub mod blocking_wallet;

/// General-purpose utilities and re-exports.
pub mod util {
    pub use lexe_byte_array::ByteArray;
    pub use lexe_hex::hex;
}

// Reexport crates and items reachable through the stable public API surface.
pub use anyhow;
pub use bip39;
pub use bitcoin;
pub use lightning;
pub use semver;

/// Initialize the Lexe logger with the given default log level.
///
/// Example: `lexe::init_logger("info")`
pub fn init_logger(default_level: &str) {
    lexe_logger::init_with_default(default_level);
}

// Reexport additional dependencies that may be useful to SDK consumers.
pub use serde_json;
pub use tracing;

// --- Unstable APIs --- //

/// This module ensures all unstable APIs are accessible within the crate, but
/// not to external users of the crate, unless they enable the `unstable`
/// feature, in which case they can access it via the re-export below.
mod unstable {
    /// A flat file system abstraction.
    pub mod ffs;
    /// Local payments database synced from the user node.
    pub mod payments_db;
    /// Provision-related utilities.
    pub mod provision;
    /// Wallet database.
    pub mod wallet_db;

    /// The user agent string used for SDK requests to Lexe infrastructure.
    ///
    /// Format: `lexe/<sdk_version> node/<latest_node_version>`
    ///
    /// Example: `lexe/0.1.0 node/0.8.11`
    pub static SDK_USER_AGENT: std::sync::LazyLock<&'static str> =
        std::sync::LazyLock::new(|| {
            // Get the latest node version.
            let releases = provision::releases_json();
            let node_releases =
                releases.0.get("node").expect("No 'node' in releases.json");
            let (latest_node_version, _release) =
                node_releases.last_key_value().expect("No node releases");

            let sdk_with_version = lexe_api::user_agent_to_lexe!();
            let user_agent =
                format!("{sdk_with_version} node/{latest_node_version}");

            Box::leak(user_agent.into_boxed_str())
        });
}

/// Opt-in to unstable APIs.
#[cfg(feature = "unstable")]
pub use unstable::*;