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

use bip32::{DerivationPath, Language, Mnemonic, Seed};
use rand_core::OsRng;

/// Generate a new mnemonic phrase
/// with 12 words and in English
///
/// # Example
/// ```
/// use walleth::generate_english_mnemonic;
///
/// let mnemonic = generate_english_mnemonic();
/// ```
pub fn generate_english_mnemonic() -> Mnemonic {
	Mnemonic::random(&mut OsRng, Language::English)
}

/// Generate a new seed from a random english mnemonic phrase
/// with an empty password
///
/// # Example
/// ```
/// use walleth::generate_seed;
///
/// let seed = generate_seed();
/// ```
pub fn generate_seed() -> Seed {
	generate_english_mnemonic().to_seed("")
}

/// Convert a seed to a boxed slice of bytes
///
/// # Example
///
/// ```
/// use walleth::{box_seed, generate_seed};
///
/// let seed = generate_seed();
/// let boxed_seed = box_seed(&seed);
/// ```
pub fn box_seed(seed: &Seed) -> Box<[u8]> {
	seed.as_bytes().to_vec().into_boxed_slice()
}

/// Generate a new seed from a mnemonic phrase
/// with an empty password
/// and return it as a boxed slice of bytes
///
/// # Example
/// ```
/// use walleth::generate_boxed_seed_bytes;
///
/// let seed = generate_boxed_seed_bytes();
/// ```
pub fn generate_boxed_seed_bytes() -> Box<[u8]> {
	generate_english_mnemonic()
		.to_seed("")
		.as_bytes()
		.to_vec()
		.into_boxed_slice()
}

/// Parse a mnemonic phrase
/// and return it as a `Mnemonic`
///
/// # Example
/// ```
/// use walleth::parse_mnemonic;
///
/// let mnemonic = parse_mnemonic("oak ethics setup flat gesture security must leader people boring donkey one".to_string());
/// ```
pub fn parse_mnemonic(phrase: String) -> Result<Mnemonic, String> {
	match Mnemonic::new(phrase, Default::default()) {
		Ok(mnemonic) => Ok(mnemonic),
		Err(e) => Err(e.to_string()),
	}
}

/// Get a derivation path from an account, change and index
/// and return it as a `DerivationPath`
///
/// # Example
/// ```
/// use walleth::get_derivation_path;
///
/// let path = get_derivation_path(0, 0, 0);
/// ```
pub fn get_derivation_path(
	account: usize,
	change: usize,
	index: usize,
) -> Result<DerivationPath, String> {
	match format!("m/44'/60'/{}'/{}/{}", account, change, index).parse() {
		Ok(path) => Ok(path),
		Err(e) => Err(e.to_string()),
	}
}