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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
use std::convert::{TryFrom, TryInto};
use std::fs::{self, File};
use std::path::{Path, PathBuf};
use std::str::FromStr;
use bech32::{ToBase32, Variant};
use bip39::{Language, Mnemonic, Seed};
use bitcoin::{
network::constants::Network,
secp256k1::Secp256k1,
util::bip32::{DerivationPath, ExtendedPrivKey, ExtendedPubKey},
};
use hdpath::StandardHDPath;
use k256::ecdsa::{signature::Signer, Signature, SigningKey};
use ripemd160::Ripemd160;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use errors::{Error, Kind};
pub use pub_key::EncodedPubKey;
use crate::config::ChainConfig;
pub mod errors;
mod pub_key;
pub const KEYSTORE_DEFAULT_FOLDER: &str = ".hermes/keys/";
pub const KEYSTORE_DISK_BACKEND: &str = "keyring-test";
pub const KEYSTORE_FILE_EXTENSION: &str = "json";
#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
pub struct CoinType(u32);
impl CoinType {
pub const ATOM: CoinType = CoinType(118);
pub fn new(coin_type: u32) -> Self {
Self(coin_type)
}
pub fn num(&self) -> u32 {
self.0
}
}
impl Default for CoinType {
fn default() -> Self {
Self::ATOM
}
}
impl FromStr for CoinType {
type Err = std::num::ParseIntError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
s.parse::<u32>().map(Self::new)
}
}
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct KeyEntry {
pub public_key: ExtendedPubKey,
pub private_key: ExtendedPrivKey,
pub account: String,
pub address: Vec<u8>,
pub coin_type: CoinType,
}
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct KeyFile {
pub name: String,
pub r#type: String,
pub address: String,
pub pubkey: String,
pub mnemonic: String,
pub coin_type: Option<CoinType>,
}
impl TryFrom<KeyFile> for KeyEntry {
type Error = Error;
fn try_from(key_file: KeyFile) -> Result<Self, Self::Error> {
let keyfile_address_bytes = decode_bech32(&key_file.address)?;
let encoded_key: EncodedPubKey = key_file.pubkey.parse()?;
let mut keyfile_pubkey_bytes = encoded_key.into_bytes();
let coin_type = key_file.coin_type.unwrap_or_default();
let private_key = private_key_from_mnemonic(&key_file.mnemonic, coin_type)?;
let derived_pubkey = ExtendedPubKey::from_private(&Secp256k1::new(), &private_key);
let derived_pubkey_bytes = derived_pubkey.public_key.to_bytes();
assert!(derived_pubkey_bytes.len() <= keyfile_pubkey_bytes.len());
let keyfile_pubkey_bytes =
keyfile_pubkey_bytes.split_off(keyfile_pubkey_bytes.len() - derived_pubkey_bytes.len());
if keyfile_pubkey_bytes != derived_pubkey_bytes {
return Err(Kind::PublicKeyMismatch {
keyfile: keyfile_pubkey_bytes,
mnemonic: derived_pubkey_bytes,
}
.into());
}
Ok(KeyEntry {
public_key: derived_pubkey,
private_key,
account: key_file.address,
address: keyfile_address_bytes,
coin_type,
})
}
}
pub trait KeyStore {
fn get_key(&self) -> Result<KeyEntry, Error>;
fn add_key(&mut self, key_entry: KeyEntry) -> Result<(), Error>;
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Memory {
account_prefix: String,
key_entry: Option<KeyEntry>,
}
impl Memory {
pub fn new(account_prefix: String, key_entry: Option<KeyEntry>) -> Self {
Self {
account_prefix,
key_entry,
}
}
}
impl KeyStore for Memory {
fn get_key(&self) -> Result<KeyEntry, Error> {
self.key_entry
.clone()
.ok_or_else(|| Kind::KeyNotFound.into())
}
fn add_key(&mut self, key_entry: KeyEntry) -> Result<(), Error> {
if self.key_entry.is_some() {
return Err(Kind::ExistingKey.into());
}
self.key_entry = Some(key_entry);
Ok(())
}
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Test {
key_name: String,
account_prefix: String,
store: PathBuf,
}
impl Test {
pub fn new(key_name: String, account_prefix: String, store: PathBuf) -> Self {
Self {
key_name,
account_prefix,
store,
}
}
}
impl KeyStore for Test {
fn get_key(&self) -> Result<KeyEntry, Error> {
let mut filename = self.store.join(&self.key_name);
filename.set_extension(KEYSTORE_FILE_EXTENSION);
if !filename.as_path().exists() {
return Err(Kind::KeyStore.context("cannot find key file").into());
}
let file =
File::open(filename).map_err(|_| Kind::KeyStore.context("cannot open key file"))?;
let key_entry = serde_json::from_reader(file)
.map_err(|_| Kind::KeyStore.context("cannot ready key file"))?;
Ok(key_entry)
}
fn add_key(&mut self, key_entry: KeyEntry) -> Result<(), Error> {
let mut filename = self.store.join(&self.key_name);
filename.set_extension(KEYSTORE_FILE_EXTENSION);
let file = File::create(filename)
.map_err(|_| Kind::KeyStore.context("error creating the key file"))?;
serde_json::to_writer_pretty(file, &key_entry)
.map_err(|_| Kind::KeyStore.context("error writing the key file"))?;
Ok(())
}
}
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum Store {
Memory,
Test,
}
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum KeyRing {
Memory(Memory),
Test(Test),
}
impl KeyRing {
pub fn new(store: Store, chain_config: ChainConfig) -> Result<Self, Error> {
match store {
Store::Memory => Ok(Self::Memory(Memory::new(chain_config.account_prefix, None))),
Store::Test => {
let keys_folder = disk_store_path(chain_config.id.as_str()).map_err(|e| {
Kind::KeyStore.context(format!("failed to compute keys folder path: {:?}", e))
})?;
fs::create_dir_all(&keys_folder).map_err(|e| {
Kind::KeyStore.context(format!("failed to create keys folder: {:?}", e))
})?;
Ok(Self::Test(Test::new(
chain_config.key_name,
chain_config.account_prefix,
keys_folder,
)))
}
}
}
pub fn get_key(&self) -> Result<KeyEntry, Error> {
match self {
KeyRing::Memory(m) => m.get_key(),
KeyRing::Test(d) => d.get_key(),
}
}
pub fn add_key(&mut self, key_entry: KeyEntry) -> Result<(), Error> {
match self {
KeyRing::Memory(m) => m.add_key(key_entry),
KeyRing::Test(d) => d.add_key(key_entry),
}
}
pub fn key_from_seed_file(&self, key_file_content: &str) -> Result<KeyEntry, Error> {
let key_file: KeyFile =
serde_json::from_str(key_file_content).map_err(|e| Kind::InvalidKey.context(e))?;
key_file.try_into()
}
pub fn key_from_mnemonic(
&self,
mnemonic_words: &str,
coin_type: CoinType,
) -> Result<KeyEntry, Error> {
let private_key = private_key_from_mnemonic(mnemonic_words, coin_type)?;
let public_key = ExtendedPubKey::from_private(&Secp256k1::new(), &private_key);
let address = get_address(public_key);
let account = bech32::encode(self.account_prefix(), address.to_base32(), Variant::Bech32)
.map_err(|e| Kind::Bech32Account.context(e))?;
Ok(KeyEntry {
public_key,
private_key,
account,
address,
coin_type,
})
}
pub fn sign_msg(&self, msg: Vec<u8>) -> Result<Vec<u8>, Error> {
let key = self.get_key()?;
let private_key_bytes = key.private_key.private_key.to_bytes();
let signing_key = SigningKey::from_bytes(private_key_bytes.as_slice()).map_err(|_| {
Kind::InvalidKey.context("could not build signing key from private key bytes")
})?;
let signature: Signature = signing_key.sign(&msg);
Ok(signature.as_ref().to_vec())
}
pub fn account_prefix(&self) -> &str {
match self {
KeyRing::Memory(m) => &m.account_prefix,
KeyRing::Test(d) => &d.account_prefix,
}
}
}
fn private_key_from_mnemonic(
mnemonic_words: &str,
coin_type: CoinType,
) -> Result<ExtendedPrivKey, Error> {
let mnemonic = Mnemonic::from_phrase(mnemonic_words, Language::English)
.map_err(|e| Kind::InvalidMnemonic.context(e))?;
let seed = Seed::new(&mnemonic, "");
let hd_path_format = format!("m/44'/{}'/0'/0/0", coin_type.num());
let hd_path = StandardHDPath::try_from(hd_path_format.as_str())
.map_err(|_| Kind::InvalidHdPath(hd_path_format))?;
let private_key = ExtendedPrivKey::new_master(Network::Bitcoin, seed.as_bytes())
.and_then(|k| k.derive_priv(&Secp256k1::new(), &DerivationPath::from(hd_path)))
.map_err(|e| Kind::PrivateKey.context(e))?;
Ok(private_key)
}
fn get_address(pk: ExtendedPubKey) -> Vec<u8> {
let mut hasher = Sha256::new();
hasher.update(pk.public_key.to_bytes().as_slice());
let pk_hash = hasher.finalize();
let mut rip_hasher = Ripemd160::new();
rip_hasher.update(pk_hash);
let rip_result = rip_hasher.finalize();
rip_result.to_vec()
}
fn decode_bech32(input: &str) -> Result<Vec<u8>, Error> {
use bech32::FromBase32;
let bytes = bech32::decode(input)
.and_then(|(_, data, _)| Vec::from_base32(&data))
.map_err(|e| Kind::Bech32Account.context(e))?;
Ok(bytes)
}
fn disk_store_path(folder_name: &str) -> Result<PathBuf, Error> {
let home = dirs_next::home_dir()
.ok_or_else(|| Kind::KeyStore.context("cannot retrieve home folder location"))?;
let folder = Path::new(home.as_path())
.join(KEYSTORE_DEFAULT_FOLDER)
.join(folder_name)
.join(KEYSTORE_DISK_BACKEND);
Ok(folder)
}