walleth 0.1.0

A (WIP) Rust library for easily create, manage, use and protect Ethereum accounts.
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

use bip32::{XPrv, XPub};

use crate::{box_seed, generate_boxed_seed_bytes, get_derivation_path, parse_mnemonic};

#[derive(Clone, Debug)]
pub struct HDWallet {
	seed: Box<[u8]>,
}

impl HDWallet {
	/// Create a new `HDWallet` from a random seed
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::new();
	/// ```
	pub fn new() -> Self {
		HDWallet {
			seed: generate_boxed_seed_bytes(),
		}
	}

	/// Create a new `HDWallet` from a seed as slice of bytes
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::from_bytes(&[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]);
	/// ```
	pub fn from_bytes(seed: &[u8]) -> Result<Self, String> {
		Ok(HDWallet {
			seed: Box::from(seed),
		})
	}

	/// Create a new `HDWallet` from a mnemonic phrase
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::from_mnemonic_str("grocery belt target explain clay essay focus spatial skull brain measure matrix toward visual protect owner stone scale slim ghost panda exact combine game").unwrap();
	/// ```
	pub fn from_mnemonic_str(mnemonic: &str) -> Result<Self, String> {
		let seed = parse_mnemonic(mnemonic.to_string())?.to_seed("");

		Ok(HDWallet {
			seed: box_seed(&seed),
		})
	}

	/// Get the private key at a derivation path
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::from_mnemonic_str("grocery belt target explain clay essay focus spatial skull brain measure matrix toward visual protect owner stone scale slim ghost panda exact combine game").unwrap();
	/// let private_key = hdwallet.private_key_at_path(0, 0, 0);
	/// ```
	pub fn private_key_at_path(
		&self,
		account: usize,
		change: usize,
		index: usize,
	) -> Result<XPrv, String> {
		match XPrv::derive_from_path(&self.seed, &get_derivation_path(account, change, index)?) {
			Ok(private_key) => Ok(private_key),
			Err(e) => Err(e.to_string()),
		}
	}

	/// Get the public key at a derivation path
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::from_mnemonic_str("grocery belt target explain clay essay focus spatial skull brain measure matrix toward visual protect owner stone scale slim ghost panda exact combine game").unwrap();
	/// let public_key = hdwallet.public_key_at_path(0, 0, 0);
	/// ```
	pub fn public_key_at_path(
		&self,
		account: usize,
		change: usize,
		index: usize,
	) -> Result<XPub, String> {
		match XPrv::derive_from_path(&self.seed, &get_derivation_path(account, change, index)?) {
			Ok(private_key) => Ok(private_key.public_key()),
			Err(e) => Err(e.to_string()),
		}
	}

	/// Get the keypair at a derivation path
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::from_mnemonic_str("grocery belt target explain clay essay focus spatial skull brain measure matrix toward visual protect owner stone scale slim ghost panda exact combine game").unwrap();
	/// let (private_key, public_key) = hdwallet.keypair_at_path(0, 0, 0).unwrap();
	/// ```
	pub fn keypair_at_path(
		&self,
		account: usize,
		change: usize,
		index: usize,
	) -> Result<(XPrv, XPub), String> {
		match XPrv::derive_from_path(&self.seed, &get_derivation_path(account, change, index)?) {
			Ok(private_key) => Ok((private_key.clone(), private_key.public_key())),
			Err(e) => Err(e.to_string()),
		}
	}

	/// Get the seed as a slice of bytes
	///
	/// # Example
	///
	/// ```
	/// use walleth::HDWallet;
	///
	/// let hdwallet = HDWallet::from_mnemonic_str("grocery belt target explain clay essay focus spatial skull brain measure matrix toward visual protect owner stone scale slim ghost panda exact combine game").unwrap();
	/// let seed_bytes = hdwallet.to_bytes();
	/// ```
	pub fn to_bytes(&self) -> &[u8] {
		&self.seed
	}
}