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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
#![allow(unused)]
use trezor_client::client::{AccessListItem as Trezor_AccessListItem, Trezor};
use futures_executor::block_on;
use futures_util::lock::Mutex;
use ethers_core::{
types::{
transaction::{eip2718::TypedTransaction, eip712::Eip712},
Address, NameOrAddress, Signature, Transaction, TransactionRequest, TxHash, H256, U256,
},
utils::keccak256,
};
use home;
use std::{
convert::TryFrom,
env, fs,
io::{Read, Write},
path,
path::PathBuf,
};
use thiserror::Error;
use super::types::*;
#[derive(Debug)]
pub struct TrezorEthereum {
derivation: DerivationType,
session_id: Vec<u8>,
cache_dir: PathBuf,
pub(crate) chain_id: u64,
pub(crate) address: Address,
}
const FIRMWARE_MIN_VERSION: &str = ">=2.4.2";
const SESSION_ID_LENGTH: usize = 32;
const SESSION_FILE_NAME: &str = "trezor.session";
impl TrezorEthereum {
pub async fn new(
derivation: DerivationType,
chain_id: u64,
cache_dir: Option<PathBuf>,
) -> Result<Self, TrezorError> {
let cache_dir = (match cache_dir.or_else(home::home_dir) {
Some(path) => path,
None => match env::current_dir() {
Ok(path) => path,
Err(e) => return Err(TrezorError::CacheError(e.to_string())),
},
})
.join(".ethers-rs")
.join("trezor")
.join("cache");
let mut blank = Self {
derivation: derivation.clone(),
chain_id,
cache_dir,
address: Address::from([0_u8; 20]),
session_id: vec![],
};
blank.initate_session()?;
blank.address = blank.get_address_with_path(&derivation).await?;
Ok(blank)
}
fn check_version(version: String) -> Result<(), TrezorError> {
let req = semver::VersionReq::parse(FIRMWARE_MIN_VERSION)?;
let version = semver::Version::parse(&version)?;
if !req.matches(&version) {
return Err(TrezorError::UnsupportedFirmwareVersion(FIRMWARE_MIN_VERSION.to_string()))
}
Ok(())
}
fn get_cached_session(&self) -> Result<Option<Vec<u8>>, TrezorError> {
let mut session = [0; SESSION_ID_LENGTH];
if let Ok(mut file) = fs::File::open(self.cache_dir.join(SESSION_FILE_NAME)) {
file.read_exact(&mut session).map_err(|e| TrezorError::CacheError(e.to_string()))?;
Ok(Some(session.to_vec()))
} else {
Ok(None)
}
}
fn save_session(&mut self, session_id: Vec<u8>) -> Result<(), TrezorError> {
fs::create_dir_all(&self.cache_dir).map_err(|e| TrezorError::CacheError(e.to_string()))?;
let mut file = fs::File::create(self.cache_dir.join(SESSION_FILE_NAME))
.map_err(|e| TrezorError::CacheError(e.to_string()))?;
file.write_all(&session_id).map_err(|e| TrezorError::CacheError(e.to_string()))?;
self.session_id = session_id;
Ok(())
}
fn initate_session(&mut self) -> Result<(), TrezorError> {
let mut client = trezor_client::unique(false)?;
client.init_device(self.get_cached_session()?)?;
let features = client.features().ok_or(TrezorError::FeaturesError)?;
Self::check_version(format!(
"{}.{}.{}",
features.get_major_version(),
features.get_minor_version(),
features.get_patch_version()
))?;
self.save_session(features.get_session_id().to_vec())?;
Ok(())
}
fn get_client(&self, session_id: Vec<u8>) -> Result<Trezor, TrezorError> {
let mut client = trezor_client::unique(false)?;
client.init_device(Some(session_id))?;
Ok(client)
}
pub async fn get_address(&self) -> Result<Address, TrezorError> {
self.get_address_with_path(&self.derivation).await
}
pub async fn get_address_with_path(
&self,
derivation: &DerivationType,
) -> Result<Address, TrezorError> {
let mut client = self.get_client(self.session_id.clone())?;
let address_str = client.ethereum_get_address(Self::convert_path(derivation))?;
let mut address = [0; 20];
address.copy_from_slice(&hex::decode(&address_str[2..])?);
Ok(Address::from(address))
}
pub async fn sign_tx(&self, tx: &TypedTransaction) -> Result<Signature, TrezorError> {
let mut client = self.get_client(self.session_id.clone())?;
let arr_path = Self::convert_path(&self.derivation);
let transaction = TrezorTransaction::load(tx)?;
let chain_id = tx.chain_id().map(|id| id.as_u64()).unwrap_or(self.chain_id);
let signature = match tx {
TypedTransaction::Eip2930(_) | TypedTransaction::Legacy(_) => client.ethereum_sign_tx(
arr_path,
transaction.nonce,
transaction.gas_price,
transaction.gas,
transaction.to,
transaction.value,
transaction.data,
chain_id,
)?,
TypedTransaction::Eip1559(eip1559_tx) => client.ethereum_sign_eip1559_tx(
arr_path,
transaction.nonce,
transaction.gas,
transaction.to,
transaction.value,
transaction.data,
chain_id,
transaction.max_fee_per_gas,
transaction.max_priority_fee_per_gas,
transaction.access_list,
)?,
};
Ok(Signature { r: signature.r, s: signature.s, v: signature.v })
}
pub async fn sign_message<S: AsRef<[u8]>>(&self, message: S) -> Result<Signature, TrezorError> {
let message = message.as_ref();
let mut client = self.get_client(self.session_id.clone())?;
let apath = Self::convert_path(&self.derivation);
let signature = client.ethereum_sign_message(message.into(), apath)?;
Ok(Signature { r: signature.r, s: signature.s, v: signature.v })
}
pub async fn sign_typed_struct<T>(&self, payload: &T) -> Result<Signature, TrezorError>
where
T: Eip712,
{
unimplemented!()
}
fn convert_path(derivation: &DerivationType) -> Vec<u32> {
let derivation = derivation.to_string();
let elements = derivation.split('/').skip(1).collect::<Vec<_>>();
let depth = elements.len();
let mut path = vec![];
for derivation_index in elements {
let hardened = derivation_index.contains('\'');
let mut index = derivation_index.replace('\'', "").parse::<u32>().unwrap();
if hardened {
index |= 0x80000000;
}
path.push(index);
}
path
}
}
#[cfg(all(test, feature = "trezor"))]
mod tests {
use super::*;
use crate::Signer;
use ethers_contract_derive::EthAbiType;
use ethers_core::types::{
transaction::{
eip2930::{AccessList, AccessListItem},
eip712::Eip712,
},
Address, Eip1559TransactionRequest, TransactionRequest, I256, U256,
};
use ethers_derive_eip712::*;
use std::str::FromStr;
#[derive(Debug, Clone, Eip712, EthAbiType)]
#[eip712(
name = "Eip712Test",
version = "1",
chain_id = 1,
verifying_contract = "0x0000000000000000000000000000000000000001",
salt = "eip712-test-75F0CCte"
)]
struct FooBar {
foo: I256,
bar: U256,
fizz: Vec<u8>,
buzz: [u8; 32],
far: String,
out: Address,
}
#[tokio::test]
#[ignore]
async fn test_get_address() {
let trezor =
TrezorEthereum::new(DerivationType::TrezorLive(1), 1, Some(PathBuf::from("randomdir")))
.await
.unwrap();
assert_eq!(
trezor.get_address().await.unwrap(),
"eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee".parse().unwrap()
);
assert_eq!(
trezor.get_address_with_path(&DerivationType::TrezorLive(0)).await.unwrap(),
"eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee".parse().unwrap()
);
}
#[tokio::test]
#[ignore]
async fn test_sign_tx() {
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1, None).await.unwrap();
let data = hex::decode("095ea7b30000000000000000000000007a250d5630b4cf539739df2c5dacb4c659f2488dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap();
let tx_req = TransactionRequest::new()
.to("2ed7afa17473e17ac59908f088b4371d28585476".parse::<Address>().unwrap())
.gas(1000000)
.gas_price(400e9 as u64)
.nonce(5)
.data(data)
.value(ethers_core::utils::parse_ether(100).unwrap())
.into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
#[tokio::test]
#[ignore]
async fn test_sign_big_data_tx() {
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1, None).await.unwrap();
let big_data = hex::decode("095ea7b30000000000000000000000007a250d5630b4cf539739df2c5dacb4c659f2488dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff".to_string()+ &"ff".repeat(1032*2) + "aa").unwrap();
let tx_req = TransactionRequest::new()
.to("2ed7afa17473e17ac59908f088b4371d28585476".parse::<Address>().unwrap())
.gas(1000000)
.gas_price(400e9 as u64)
.nonce(5)
.data(big_data)
.value(ethers_core::utils::parse_ether(100).unwrap())
.into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
#[tokio::test]
#[ignore]
async fn test_sign_empty_txes() {
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1, None).await.unwrap();
{
let tx_req = Eip1559TransactionRequest::new()
.to("2ed7afa17473e17ac59908f088b4371d28585476".parse::<Address>().unwrap())
.into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
{
let tx_req = TransactionRequest::new()
.to("2ed7afa17473e17ac59908f088b4371d28585476".parse::<Address>().unwrap())
.into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
let data = hex::decode("095ea7b30000000000000000000000007a250d5630b4cf539739df2c5dacb4c659f2488dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap();
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1, None).await.unwrap();
{
let tx_req = Eip1559TransactionRequest::new().data(data.clone()).into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
{
let tx_req = TransactionRequest::new().data(data.clone()).into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
}
#[tokio::test]
#[ignore]
async fn test_sign_eip1559_tx() {
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1, None).await.unwrap();
let data = hex::decode("095ea7b30000000000000000000000007a250d5630b4cf539739df2c5dacb4c659f2488dffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff").unwrap();
let lst = AccessList(vec![
AccessListItem {
address: "0x8ba1f109551bd432803012645ac136ddd64dba72".parse().unwrap(),
storage_keys: vec![
"0x0000000000000000000000000000000000000000000000000000000000000000"
.parse()
.unwrap(),
"0x0000000000000000000000000000000000000000000000000000000000000042"
.parse()
.unwrap(),
],
},
AccessListItem {
address: "0x2ed7afa17473e17ac59908f088b4371d28585476".parse().unwrap(),
storage_keys: vec![
"0x0000000000000000000000000000000000000000000000000000000000000000"
.parse()
.unwrap(),
"0x0000000000000000000000000000000000000000000000000000000000000042"
.parse()
.unwrap(),
],
},
]);
let tx_req = Eip1559TransactionRequest::new()
.to("2ed7afa17473e17ac59908f088b4371d28585476".parse::<Address>().unwrap())
.gas(1000000)
.max_fee_per_gas(400e9 as u64)
.max_priority_fee_per_gas(400e9 as u64)
.nonce(5)
.data(data)
.access_list(lst)
.value(ethers_core::utils::parse_ether(100).unwrap())
.into();
let tx = trezor.sign_transaction(&tx_req).await.unwrap();
}
#[tokio::test]
#[ignore]
async fn test_sign_message() {
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1, None).await.unwrap();
let message = "hello world";
let sig = trezor.sign_message(message).await.unwrap();
let addr = trezor.get_address().await.unwrap();
sig.verify(message, addr).unwrap();
}
#[tokio::test]
#[ignore]
async fn test_sign_eip712_struct() {
let trezor = TrezorEthereum::new(DerivationType::TrezorLive(0), 1u64, None).await.unwrap();
let foo_bar = FooBar {
foo: I256::from(10),
bar: U256::from(20),
fizz: b"fizz".to_vec(),
buzz: keccak256("buzz"),
far: String::from("space"),
out: Address::from([0; 20]),
};
let sig = trezor.sign_typed_struct(&foo_bar).await.expect("failed to sign typed data");
let foo_bar_hash = foo_bar.encode_eip712().unwrap();
sig.verify(foo_bar_hash, trezor.address).unwrap();
}
}