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

use crate::crypto::bip32::child_index::ChildIndex;
use crate::crypto::bip32::Error;

pub(crate) const DERIVATION_PATH_PREFIX: &str = "m";

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct DerivationPath {
    path: Vec<ChildIndex>,
}

impl IntoIterator for DerivationPath {
    type IntoIter = std::vec::IntoIter<Self::Item>;
    type Item = ChildIndex;

    fn into_iter(self) -> Self::IntoIter {
        self.path.into_iter()
    }
}

impl std::fmt::Display for DerivationPath {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{DERIVATION_PATH_PREFIX}")?;

        for child in &self.path {
            write!(f, "/{child}")?;
        }

        Ok(())
    }
}

impl std::str::FromStr for DerivationPath {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let mut iter = s.split('/');

        if iter.next() != Some(DERIVATION_PATH_PREFIX) {
            return Err(Error::InvalidDerivationPath);
        }

        let path = iter
            .map(str::parse)
            .collect::<Result<Vec<ChildIndex>, Self::Err>>()?;

        Ok(DerivationPath { path })
    }
}

pub trait IntoDerivationPath {
    fn into_derivation_path(self) -> Result<DerivationPath, Error>;
}

impl IntoDerivationPath for String {
    fn into_derivation_path(self) -> Result<DerivationPath, Error> {
        self.parse()
    }
}

impl IntoDerivationPath for &str {
    fn into_derivation_path(self) -> Result<DerivationPath, Error> {
        self.parse()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::crypto::bip32::child_index::HARDENED_OFFSET;

    #[test]
    fn test_derivation_path() {
        let paths = vec![
            "m",
            "m/0",
            "m/0/2147483647'",
            "m/0/2147483647'/1",
            "m/0/2147483647'/1/2147483646'",
            "m/0/2147483647'/1/2147483646'/2",
        ];

        for path in paths {
            let parsed: DerivationPath = path.into_derivation_path().unwrap();
            assert_eq!(parsed.to_string(), path);
        }
    }

    #[test]
    fn test_derivation_path_indices() {
        let path: DerivationPath = "m/1'/2'/3'/0".into_derivation_path().unwrap();

        assert_eq!(
            path,
            DerivationPath {
                path: vec![
                    ChildIndex::Hardened {
                        index: 1 | HARDENED_OFFSET
                    },
                    ChildIndex::Hardened {
                        index: 2 | HARDENED_OFFSET
                    },
                    ChildIndex::Hardened {
                        index: 3 | HARDENED_OFFSET
                    },
                    ChildIndex::Normal { index: 0 },
                ],
            }
        );
    }
}