stacks-rs 0.1.9

Rust toolkit to interact with the Stacks Blockchain.
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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

pub const HIRO_MAINNET_DEFAULT: &str = "https://stacks-node-api.mainnet.stacks.co";
pub const HIRO_TESTNET_DEFAULT: &str = "https://stacks-node-api.testnet.stacks.co";
pub const HIRO_MOCKNET_DEFAULT: &str = "http://localhost:3999";

#[repr(u8)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum TransactionVersion {
    Mainnet = 0x00,
    Testnet = 0x80,
}

#[repr(u32)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub enum ChainID {
    Testnet = 0x8000_0000,
    Mainnet = 0x0000_0001,
}

macro_rules! impl_default_network {
    ($type:ty, $version:expr, $chain_id:expr) => {
        impl Default for $type {
            fn default() -> Self {
                Self::new()
            }
        }

        impl AsRef<$type> for $type {
            fn as_ref(&self) -> &Self {
                self
            }
        }

        impl $type {
            pub fn new() -> Self {
                Self {
                    version: $version,
                    chain_id: $chain_id,
                }
            }
        }
    };
}

pub trait Network: std::fmt::Debug + Clone {
    /// Returns the transaction version.
    fn version(&self) -> TransactionVersion;
    /// Returns the chain ID.
    fn chain_id(&self) -> ChainID;
    /// Returns the API base URL.
    fn base_url(&self) -> String;
}

/// The mainnet network.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct StacksMainnet {
    version: TransactionVersion,
    chain_id: ChainID,
}

impl_default_network!(StacksMainnet, TransactionVersion::Mainnet, ChainID::Mainnet);
impl Network for StacksMainnet {
    fn version(&self) -> TransactionVersion {
        self.version
    }

    fn chain_id(&self) -> ChainID {
        self.chain_id
    }

    fn base_url(&self) -> String {
        HIRO_MAINNET_DEFAULT.into()
    }
}

/// The testnet network.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct StacksTestnet {
    version: TransactionVersion,
    chain_id: ChainID,
}

impl_default_network!(StacksTestnet, TransactionVersion::Testnet, ChainID::Testnet);
impl Network for StacksTestnet {
    fn version(&self) -> TransactionVersion {
        self.version
    }

    fn chain_id(&self) -> ChainID {
        self.chain_id
    }

    fn base_url(&self) -> String {
        HIRO_TESTNET_DEFAULT.into()
    }
}

/// The mocknet network.
#[derive(Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct StacksMocknet {
    version: TransactionVersion,
    chain_id: ChainID,
}

impl_default_network!(StacksMocknet, TransactionVersion::Testnet, ChainID::Testnet);
impl Network for StacksMocknet {
    fn version(&self) -> TransactionVersion {
        self.version
    }

    fn chain_id(&self) -> ChainID {
        self.chain_id
    }

    fn base_url(&self) -> String {
        HIRO_MOCKNET_DEFAULT.into()
    }
}