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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
use std::{collections::HashMap, fmt, ops, path::Path};
use async_trait::async_trait;
use elliptic_curve::rand_core;
use eth_keystore::KeystoreError;
use fuel_core_client::client::{PaginatedResult, PaginationRequest};
use fuel_crypto::{Message, PublicKey, SecretKey, Signature};
use fuel_tx::{AssetId, Bytes32, ContractId, Input, Output, Receipt, TxPointer, UtxoId, Witness};
use fuel_types::MessageId;
use fuels_core::{
abi_encoder::UnresolvedBytes,
offsets::{base_offset, coin_predicate_data_offset, message_predicate_data_offset},
};
use fuels_types::{
bech32::{Bech32Address, Bech32ContractId, FUEL_BECH32_HRP},
coin::Coin,
constants::BASE_ASSET_ID,
errors::{error, Error, Result},
message::Message as InputMessage,
resource::Resource,
transaction::{ScriptTransaction, Transaction, TxParameters},
transaction_response::TransactionResponse,
};
use rand::{CryptoRng, Rng};
use thiserror::Error;
use crate::{
provider::{Provider, ResourceFilter},
Signer,
};
pub const DEFAULT_DERIVATION_PATH_PREFIX: &str = "m/44'/1179993420'";
type WalletResult<T> = std::result::Result<T, WalletError>;
#[derive(Clone)]
pub struct Wallet {
pub(crate) address: Bech32Address,
pub(crate) provider: Option<Provider>,
}
#[derive(Clone, Debug)]
pub struct WalletUnlocked {
wallet: Wallet,
pub(crate) private_key: SecretKey,
}
#[derive(Error, Debug)]
pub enum WalletError {
#[error(transparent)]
Hex(#[from] hex::FromHexError),
#[error("Failed to parse slice")]
Parsing(#[from] std::array::TryFromSliceError),
#[error("No provider was setup: make sure to set_provider in your wallet!")]
NoProvider,
#[error(transparent)]
KeystoreError(#[from] KeystoreError),
#[error(transparent)]
FuelCrypto(#[from] fuel_crypto::Error),
}
impl From<WalletError> for Error {
fn from(e: WalletError) -> Self {
Error::WalletError(e.to_string())
}
}
impl Wallet {
pub fn from_address(address: Bech32Address, provider: Option<Provider>) -> Self {
Self { address, provider }
}
pub fn get_provider(&self) -> WalletResult<&Provider> {
self.provider.as_ref().ok_or(WalletError::NoProvider)
}
pub fn set_provider(&mut self, provider: Provider) {
self.provider = Some(provider)
}
pub fn address(&self) -> &Bech32Address {
&self.address
}
pub async fn get_transactions(
&self,
request: PaginationRequest<String>,
) -> Result<PaginatedResult<TransactionResponse, String>> {
Ok(self
.get_provider()?
.get_transactions_by_owner(&self.address, request)
.await?)
}
pub async fn get_asset_inputs_for_amount(
&self,
asset_id: AssetId,
amount: u64,
witness_index: u8,
) -> Result<Vec<Input>> {
let filter = ResourceFilter {
from: self.address().clone(),
asset_id,
amount,
..Default::default()
};
self.get_provider()?
.get_asset_inputs(filter, witness_index)
.await
}
pub fn get_asset_outputs_for_amount(
&self,
to: &Bech32Address,
asset_id: AssetId,
amount: u64,
) -> Vec<Output> {
vec![
Output::coin(to.into(), amount, asset_id),
Output::change((&self.address).into(), 0, asset_id),
]
}
pub async fn get_coins(&self, asset_id: AssetId) -> Result<Vec<Coin>> {
Ok(self
.get_provider()?
.get_coins(&self.address, asset_id)
.await?)
}
pub async fn get_spendable_resources(
&self,
asset_id: AssetId,
amount: u64,
) -> Result<Vec<Resource>> {
let filter = ResourceFilter {
from: self.address().clone(),
asset_id,
amount,
..Default::default()
};
self.get_provider()?
.get_spendable_resources(filter)
.await
.map_err(Into::into)
}
pub async fn get_asset_balance(&self, asset_id: &AssetId) -> Result<u64> {
self.get_provider()?
.get_asset_balance(&self.address, *asset_id)
.await
.map_err(Into::into)
}
pub async fn get_balances(&self) -> Result<HashMap<String, u64>> {
self.get_provider()?
.get_balances(&self.address)
.await
.map_err(Into::into)
}
pub async fn get_messages(&self) -> Result<Vec<InputMessage>> {
Ok(self.get_provider()?.get_messages(&self.address).await?)
}
pub fn unlock(self, private_key: SecretKey) -> WalletUnlocked {
WalletUnlocked {
wallet: self,
private_key,
}
}
}
impl WalletUnlocked {
pub fn lock(self) -> Wallet {
self.wallet
}
pub fn set_provider(&mut self, provider: Provider) {
self.wallet.set_provider(provider)
}
pub fn new_random(provider: Option<Provider>) -> Self {
let mut rng = rand::thread_rng();
let private_key = SecretKey::random(&mut rng);
Self::new_from_private_key(private_key, provider)
}
pub fn new_from_private_key(private_key: SecretKey, provider: Option<Provider>) -> Self {
let public = PublicKey::from(&private_key);
let hashed = public.hash();
let address = Bech32Address::new(FUEL_BECH32_HRP, hashed);
Wallet::from_address(address, provider).unlock(private_key)
}
pub fn new_from_mnemonic_phrase(
phrase: &str,
provider: Option<Provider>,
) -> WalletResult<Self> {
let path = format!("{DEFAULT_DERIVATION_PATH_PREFIX}/0'/0/0");
Self::new_from_mnemonic_phrase_with_path(phrase, provider, &path)
}
pub fn new_from_mnemonic_phrase_with_path(
phrase: &str,
provider: Option<Provider>,
path: &str,
) -> WalletResult<Self> {
let secret_key = SecretKey::new_from_mnemonic_phrase_with_path(phrase, path)?;
Ok(Self::new_from_private_key(secret_key, provider))
}
pub fn new_from_keystore<P, R, S>(
dir: P,
rng: &mut R,
password: S,
provider: Option<Provider>,
) -> WalletResult<(Self, String)>
where
P: AsRef<Path>,
R: Rng + CryptoRng + rand_core::CryptoRng,
S: AsRef<[u8]>,
{
let (secret, uuid) = eth_keystore::new(dir, rng, password)?;
let secret_key = unsafe { SecretKey::from_slice_unchecked(&secret) };
let wallet = Self::new_from_private_key(secret_key, provider);
Ok((wallet, uuid))
}
pub fn encrypt<P, S>(&self, dir: P, password: S) -> WalletResult<String>
where
P: AsRef<Path>,
S: AsRef<[u8]>,
{
let mut rng = rand::thread_rng();
Ok(eth_keystore::encrypt_key(
dir,
&mut rng,
*self.private_key,
password,
)?)
}
pub fn load_keystore<P, S>(
keypath: P,
password: S,
provider: Option<Provider>,
) -> WalletResult<Self>
where
P: AsRef<Path>,
S: AsRef<[u8]>,
{
let secret = eth_keystore::decrypt_key(keypath, password)?;
let secret_key = unsafe { SecretKey::from_slice_unchecked(&secret) };
Ok(Self::new_from_private_key(secret_key, provider))
}
pub async fn add_fee_resources(
&self,
tx: &mut impl Transaction,
previous_base_amount: u64,
witness_index: u8,
) -> Result<()> {
let consensus_parameters = self
.get_provider()?
.chain_info()
.await?
.consensus_parameters;
let transaction_fee = tx
.fee_checked_from_tx(&consensus_parameters)
.expect("Error calculating TransactionFee");
let (base_asset_inputs, remaining_inputs): (Vec<_>, Vec<_>) =
tx.inputs().iter().cloned().partition(|input| {
matches!(input, Input::MessageSigned { .. })
|| matches!(input, Input::CoinSigned { asset_id, .. } if asset_id == &BASE_ASSET_ID)
});
let base_inputs_sum: u64 = base_asset_inputs
.iter()
.map(|input| input.amount().unwrap())
.sum();
if base_inputs_sum < previous_base_amount {
return Err(error!(
WalletError,
"The provided base asset amount is less than the present input coins"
));
}
let mut new_base_amount = transaction_fee.total() + previous_base_amount;
let is_consuming_utxos = tx
.inputs()
.iter()
.any(|input| !matches!(input, Input::Contract { .. }));
const MIN_AMOUNT: u64 = 1;
if !is_consuming_utxos && new_base_amount == 0 {
new_base_amount = MIN_AMOUNT;
}
let new_base_inputs = self
.get_asset_inputs_for_amount(BASE_ASSET_ID, new_base_amount, witness_index)
.await?;
let adjusted_inputs: Vec<_> = remaining_inputs
.into_iter()
.chain(new_base_inputs.into_iter())
.collect();
*tx.inputs_mut() = adjusted_inputs;
let is_base_change_present = tx.outputs().iter().any(|output| {
matches!(output, Output::Change { asset_id, .. } if asset_id == &BASE_ASSET_ID)
});
if !is_base_change_present && new_base_amount != 0 {
tx.outputs_mut()
.push(Output::change(self.address().into(), 0, BASE_ASSET_ID));
}
Ok(())
}
pub async fn transfer(
&self,
to: &Bech32Address,
amount: u64,
asset_id: AssetId,
tx_parameters: TxParameters,
) -> Result<(String, Vec<Receipt>)> {
let inputs = self
.get_asset_inputs_for_amount(asset_id, amount, 0)
.await?;
let outputs = self.get_asset_outputs_for_amount(to, asset_id, amount);
let mut tx = ScriptTransaction::new(inputs, outputs, tx_parameters);
if asset_id == AssetId::default() {
self.add_fee_resources(&mut tx, amount, 0).await?;
} else {
self.add_fee_resources(&mut tx, 0, 0).await?;
};
self.sign_transaction(&mut tx).await?;
let tx_id = tx.id().to_string();
let receipts = self.get_provider()?.send_transaction(&tx).await?;
Ok((tx_id, receipts))
}
pub async fn withdraw_to_base_layer(
&self,
to: &Bech32Address,
amount: u64,
tx_parameters: TxParameters,
) -> Result<(String, String, Vec<Receipt>)> {
let inputs = self
.get_asset_inputs_for_amount(BASE_ASSET_ID, amount, 0)
.await?;
let mut tx =
ScriptTransaction::build_message_to_output_tx(to.into(), amount, inputs, tx_parameters);
self.add_fee_resources(&mut tx, amount, 0).await?;
self.sign_transaction(&mut tx).await?;
let tx_id = tx.id().to_string();
let receipts = self.get_provider()?.send_transaction(&tx).await?;
let message_id = WalletUnlocked::extract_message_id(&receipts)
.expect("MessageId could not be retrieved from tx receipts.");
Ok((tx_id, message_id.to_string(), receipts))
}
fn extract_message_id(receipts: &[Receipt]) -> Option<&MessageId> {
receipts
.iter()
.find(|r| matches!(r, Receipt::MessageOut { .. }))
.and_then(|m| m.message_id())
}
#[allow(clippy::too_many_arguments)]
pub async fn spend_predicate(
&self,
predicate_address: &Bech32Address,
code: Vec<u8>,
amount: u64,
asset_id: AssetId,
to: &Bech32Address,
predicate_data: UnresolvedBytes,
tx_parameters: TxParameters,
) -> Result<Vec<Receipt>> {
let provider = self.get_provider()?;
let filter = ResourceFilter {
from: predicate_address.clone(),
amount,
..Default::default()
};
let spendable_predicate_resources = provider.get_spendable_resources(filter).await?;
let input_amount: u64 = spendable_predicate_resources
.iter()
.map(|resource| resource.amount())
.sum();
let mut offset = base_offset(&provider.consensus_parameters().await?);
let inputs = spendable_predicate_resources
.into_iter()
.map(|resource| match resource {
Resource::Coin(coin) => {
offset += coin_predicate_data_offset(code.len());
let data = predicate_data.clone().resolve(offset as u64);
offset += data.len();
self.create_coin_predicate(coin, asset_id, code.clone(), data)
}
Resource::Message(message) => {
offset += message_predicate_data_offset(message.data.len(), code.len());
let data = predicate_data.clone().resolve(offset as u64);
offset += data.len();
self.create_message_predicate(message, code.clone(), data)
}
})
.collect::<Vec<_>>();
let outputs = vec![
Output::coin(to.into(), amount, asset_id),
Output::coin(predicate_address.into(), input_amount - amount, asset_id),
];
let mut tx = ScriptTransaction::new(inputs, outputs, tx_parameters);
self.add_fee_resources(&mut tx, 0, 0).await?;
self.sign_transaction(&mut tx).await?;
provider.send_transaction(&tx).await
}
fn create_coin_predicate(
&self,
coin: Coin,
asset_id: AssetId,
code: Vec<u8>,
predicate_data: Vec<u8>,
) -> Input {
Input::coin_predicate(
coin.utxo_id,
coin.owner.into(),
coin.amount,
asset_id,
TxPointer::default(),
0,
code,
predicate_data,
)
}
fn create_message_predicate(
&self,
message: InputMessage,
code: Vec<u8>,
predicate_data: Vec<u8>,
) -> Input {
Input::message_predicate(
message.message_id(),
message.sender.into(),
message.recipient.into(),
message.amount,
message.nonce,
message.data,
code,
predicate_data,
)
}
pub async fn receive_from_predicate(
&self,
predicate_address: &Bech32Address,
predicate_code: Vec<u8>,
amount: u64,
asset_id: AssetId,
predicate_data: UnresolvedBytes,
tx_parameters: TxParameters,
) -> Result<Vec<Receipt>> {
self.spend_predicate(
predicate_address,
predicate_code,
amount,
asset_id,
self.address(),
predicate_data,
tx_parameters,
)
.await
}
pub async fn force_transfer_to_contract(
&self,
to: &Bech32ContractId,
balance: u64,
asset_id: AssetId,
tx_parameters: TxParameters,
) -> Result<(String, Vec<Receipt>)> {
let zeroes = Bytes32::zeroed();
let plain_contract_id: ContractId = to.into();
let mut inputs = vec![Input::contract(
UtxoId::new(zeroes, 0),
zeroes,
zeroes,
TxPointer::default(),
plain_contract_id,
)];
inputs.extend(
self.get_asset_inputs_for_amount(asset_id, balance, 0)
.await?,
);
let outputs = vec![
Output::contract(0, zeroes, zeroes),
Output::change((&self.address).into(), 0, asset_id),
];
let mut tx = ScriptTransaction::build_contract_transfer_tx(
plain_contract_id,
balance,
asset_id,
inputs,
outputs,
tx_parameters,
);
let base_amount = if asset_id == AssetId::default() {
balance
} else {
0
};
self.add_fee_resources(&mut tx, base_amount, 0).await?;
self.sign_transaction(&mut tx).await?;
let tx_id = tx.id();
let receipts = self.get_provider()?.send_transaction(&tx).await?;
Ok((tx_id.to_string(), receipts))
}
}
#[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
#[cfg_attr(not(target_arch = "wasm32"), async_trait)]
impl Signer for WalletUnlocked {
type Error = WalletError;
async fn sign_message<S: Send + Sync + AsRef<[u8]>>(
&self,
message: S,
) -> WalletResult<Signature> {
let message = Message::new(message);
let sig = Signature::sign(&self.private_key, &message);
Ok(sig)
}
async fn sign_transaction<T: Transaction + Send>(&self, tx: &mut T) -> WalletResult<Signature> {
let id = tx.id();
let message = unsafe { Message::from_bytes_unchecked(*id) };
let sig = Signature::sign(&self.private_key, &message);
let witness = vec![Witness::from(sig.as_ref())];
let witnesses: &mut Vec<Witness> = tx.witnesses_mut();
match witnesses.len() {
0 => *witnesses = witness,
_ => {
witnesses.extend(witness);
}
}
Ok(sig)
}
fn address(&self) -> &Bech32Address {
&self.address
}
}
impl fmt::Debug for Wallet {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Wallet")
.field("address", &self.address)
.finish()
}
}
impl ops::Deref for WalletUnlocked {
type Target = Wallet;
fn deref(&self) -> &Self::Target {
&self.wallet
}
}
pub fn generate_mnemonic_phrase<R: Rng>(rng: &mut R, count: usize) -> WalletResult<String> {
Ok(fuel_crypto::FuelMnemonic::generate_mnemonic_phrase(
rng, count,
)?)
}
#[cfg(test)]
mod tests {
use tempfile::tempdir;
use super::*;
#[tokio::test]
async fn encrypted_json_keystore() -> Result<()> {
let dir = tempdir()?;
let mut rng = rand::thread_rng();
let (wallet, uuid) = WalletUnlocked::new_from_keystore(&dir, &mut rng, "password", None)?;
let message = "Hello there!";
let signature = wallet.sign_message(message).await?;
let path = Path::new(dir.path()).join(uuid);
let recovered_wallet = WalletUnlocked::load_keystore(path.clone(), "password", None)?;
let signature2 = recovered_wallet.sign_message(message).await?;
assert_eq!(signature, signature2);
assert!(std::fs::remove_file(&path).is_ok());
Ok(())
}
#[tokio::test]
async fn mnemonic_generation() -> Result<()> {
let mnemonic = generate_mnemonic_phrase(&mut rand::thread_rng(), 12)?;
let _wallet = WalletUnlocked::new_from_mnemonic_phrase(&mnemonic, None)?;
Ok(())
}
#[tokio::test]
async fn wallet_from_mnemonic_phrase() -> Result<()> {
let phrase =
"oblige salon price punch saddle immune slogan rare snap desert retire surprise";
let wallet =
WalletUnlocked::new_from_mnemonic_phrase_with_path(phrase, None, "m/44'/60'/0'/0/0")?;
let expected_plain_address =
"df9d0e6c6c5f5da6e82e5e1a77974af6642bdb450a10c43f0c6910a212600185";
let expected_address = "fuel1m7wsumrvtaw6d6pwtcd809627ejzhk69pggvg0cvdyg2yynqqxzseuzply";
assert_eq!(wallet.address().hash().to_string(), expected_plain_address);
assert_eq!(wallet.address().to_string(), expected_address);
let wallet2 =
WalletUnlocked::new_from_mnemonic_phrase_with_path(phrase, None, "m/44'/60'/1'/0/0")?;
let expected_second_plain_address =
"261191b0164a24fd0fd51566ec5e5b0b9ba8fb2d42dc9cf7dbbd6f23d2742759";
let expected_second_address =
"fuel1ycgervqkfgj06r74z4nwchjmpwd637edgtwfea7mh4hj85n5yavszjk4cc";
assert_eq!(
wallet2.address().hash().to_string(),
expected_second_plain_address
);
assert_eq!(wallet2.address().to_string(), expected_second_address);
Ok(())
}
#[tokio::test]
async fn encrypt_and_store_wallet_from_mnemonic() -> Result<()> {
let dir = tempdir()?;
let phrase =
"oblige salon price punch saddle immune slogan rare snap desert retire surprise";
let wallet =
WalletUnlocked::new_from_mnemonic_phrase_with_path(phrase, None, "m/44'/60'/0'/0/0")?;
let uuid = wallet.encrypt(&dir, "password")?;
let path = Path::new(dir.path()).join(uuid);
let recovered_wallet = WalletUnlocked::load_keystore(&path, "password", None)?;
assert_eq!(wallet.address(), recovered_wallet.address());
assert!(std::fs::remove_file(&path).is_ok());
Ok(())
}
}