kobe-spark 1.1.1

Spark (Bitcoin L2) wallet for Kobe
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

//! Spark protocol (Bitcoin L2) wallet utilities for Kobe.
//!
//! Implements the [Spark](https://docs.spark.money) identity-key derivation
//! and Bech32m address encoding from a unified [`kobe_primitives::Wallet`]:
//!
//! - **Derivation path**: `m/8797555'/{account}'/0'` — hardened BIP-32
//!   secp256k1. The purpose `8797555` is the Spark-specific constant
//!   (`SHA-256("spark")` truncated).
//! - **Address**: `spark1…` (Mainnet), `sparkt1…` (Testnet), `sparks1…`
//!   (Signet), `sparkrt1…` (Regtest), `sparkl1…` (Local) — Bech32m-encoded
//!   compressed identity public key wrapped in a minimal protobuf header.
//!
//! # Example
//!
//! ```no_run
//! use kobe_primitives::Wallet;
//! use kobe_spark::{Deriver, Network};
//!
//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
//! let wallet = Wallet::from_mnemonic(
//!     "abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about",
//!     None,
//! )?;
//! let account = Deriver::with_network(&wallet, Network::Mainnet).derive(0)?;
//! assert!(account.address().starts_with("spark1"));
//! # Ok(())
//! # }
//! ```

#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(feature = "alloc")]
extern crate alloc;

#[cfg(feature = "alloc")]
mod deriver;
mod error;

#[cfg(feature = "alloc")]
pub use deriver::{DerivedAccount, Deriver, Network, SPARK_PURPOSE};
pub use error::DeriveError;

/// A convenient Result type alias for kobe-spark operations.
pub type Result<T> = core::result::Result<T, DeriveError>;