Refactor/wallet generic signer #1783

OBorce · 2024-06-18T08:58:20Z

add a generic signer provider for creating a software or a hardware signer
make account key chain generic to allow using it with and without a VRF keychain
add an implementation for the trezor signer
copy auto generated trezor client to communicate with a connected trezor device
add new hardware-wallet option when creating and opening a wallet in the CLI and RPC wallet commands

do_checks.sh

OBorce · 2024-08-01T12:18:35Z

wallet/wallet-controller/src/lib.rs

@@ -144,33 +153,44 @@ pub struct ControllerConfig {
    pub broadcast_to_mempool: bool,
 }

-pub struct Controller<T, W> {
+pub enum WalletType2<B: storage::Backend + 'static> {


find a better name

Not sure if it's a good idea, but: the existing Wallet could become GenericWallet and then WalletType2 can be just Wallet.

azarovh · 2024-08-05T14:08:46Z

wallet/src/signer/trezor_signer/mod.rs

+                                signature_hash(sig.sighash_type(), ptx.tx(), &inputs_utxo_refs, i)?;
+
+                            if sig
+                                .verify_signature(&self.chain_config, destination, &sighash)


tx_verifier::input_check::signature_only_check::verify_tx_signature should be used to verify htlc properly

azarovh · 2024-08-06T11:16:59Z

build-tools/codecheck/codecheck.py

@@ -267,7 +267,7 @@ def check_local_licenses():
    template = re.compile('(?:' + r')\n(?:'.join(LICENSE_TEMPLATE) + ')')

    ok = True
-    for path in rs_sources():
+    for path in rs_sources(['wallet/trezor-client']):


azarovh · 2024-08-06T11:18:15Z

crypto/src/key/secp256k1/extended_keys.rs

@@ -200,6 +200,18 @@ impl Secp256k1ExtendedPublicKey {
                .into(),
        }
    }
+
+    pub fn from_hardware_wallet(


new? information about hardware seems unnecessary at this level

azarovh · 2024-08-06T11:18:23Z

crypto/src/key/extended.rs

@@ -122,6 +122,12 @@ impl ExtendedPublicKey {
        }
    }

+    pub fn from_hardware_public_key(public_key: Secp256k1ExtendedPublicKey) -> Self {


azarovh · 2024-08-06T13:20:16Z

node-gui/src/backend/backend_impl.rs

+            }
+            #[cfg(feature = "trezor")]
+            (WalletType::Trezor, _) => {
+                let client = make_cold_wallet_rpc_client(Arc::clone(&self.chain_config));


why cold mode? I thought that's the whole point that hardware wallet is both convenient and secure.

azarovh · 2024-08-06T13:33:43Z

Cargo.toml

@@ -287,3 +287,6 @@ opt-level = 2
 [profile.dist]
 inherits = "release"
 lto = "off"
+
+[features]
+trezor = []


I think it should be enabled in CI

ImplOfAnImpl · 2024-08-07T15:46:39Z

wallet/src/signer/trezor_signer/mod.rs

+
+    fn make_signature(
+        &self,
+        signature: &Vec<MintlayerSignature>,


&[MintlayerSignature]?

ImplOfAnImpl · 2024-08-07T16:23:28Z

wallet/Cargo.toml

@@ -25,6 +25,8 @@ utils-networking = { path = "../utils/networking" }
 utxo = { path = "../utxo" }
 wallet-storage = { path = "./storage" }
 wallet-types = { path = "./types" }
+trezor-client = { git = "https://github.com/mintlayer/mintlayer-trezor-firmware", branch = "feature/mintlayer", features = ["bitcoin", "mintlayer"], optional = true }
+# trezor-client = { path = "../../trezor-firmware/rust/trezor-client", features = ["bitcoin", "mintlayer"], optional = true }


ImplOfAnImpl · 2024-08-07T16:25:23Z

wallet/wallet-cli-commands/src/helper_types.rs

@@ -387,3 +387,10 @@ impl YesNo {
        }
    }
 }
+
+#[derive(Debug, Clone, Copy, ValueEnum)]
+pub enum CLIHardwareWalletType {


CLI -> Cli?

ImplOfAnImpl · 2024-08-07T16:34:17Z

wallet/wallet-cli-commands/src/command_handler/mod.rs


-use crate::{errors::WalletCliCommandError, ManageableWalletCommand, WalletManagementCommand};
+// #[cfg(feature = "trezor")]
+// use crate::helper_types::CLIHardwareWalletType;


ImplOfAnImpl · 2024-08-07T16:54:43Z

wallet/wallet-controller/src/lib.rs

+        match &self.wallet {
+            WalletType2::Software(w) => w.seed_phrase(),
+            #[cfg(feature = "trezor")]
+            WalletType2::Trezor(w) => w.seed_phrase(),
+        }


These match statements pollute the code; also, some of them are duplicated.
Perhaps it's better to encapsulate all of them inside impl WalletType2?

P.S. Personally, I'd probably try to use https://github.com/kobzol/rust-delegate for this. Not insisting on this, of course.

ImplOfAnImpl · 2024-08-07T16:57:34Z

wallet/wallet-controller/src/lib.rs

@@ -144,33 +153,44 @@ pub struct ControllerConfig {
    pub broadcast_to_mempool: bool,
 }

-pub struct Controller<T, W> {
+pub enum WalletType2<B: storage::Backend + 'static> {


Not sure if it's a good idea, but: the existing Wallet could become GenericWallet and then WalletType2 can be just Wallet.

- it will rescan the blokchain on wallet creation - wallet-create will only scan forward from the current block height

azarovh · 2024-08-24T08:30:13Z

wallet/src/signer/trezor_signer/mod.rs

+        MintlayerUnmintTokens, MintlayerUtxoType,
+    },
+};
+#[allow(clippy::all)]


why is it required?

azarovh · 2024-08-24T09:56:26Z

wallet/src/signer/trezor_signer/mod.rs

+                        SignatureStatus::FullySigned,
+                        SignatureStatus::FullySigned,
+                    )),
+                    InputWitness::Standard(sig) => match destination {


we need a TODO and a github issue (so we won't forget) to support HTLC signing after my pr is merged

azarovh · 2024-08-24T09:58:40Z

wallet/src/signer/trezor_signer/mod.rs

+        | TxOutput::Htlc(value, _)
+        | TxOutput::LockThenTransfer(value, _, _)
+        | TxOutput::Burn(value) => value.clone(),
+        TxOutput::DelegateStaking(amount, _) => OutputValue::Coin(*amount),


Name of the function is too vague. Something like utxo_output_value is better. This would make it clear why DelegateStaking and Burn which are not spendable should return None here (same as others instead of ZERO).

azarovh · 2024-08-24T10:40:07Z

wallet/src/signer/trezor_signer/tests.rs

+    let db = Arc::new(Store::new(DefaultBackend::new_in_memory()).unwrap());
+    let mut db_tx = db.transaction_rw_unlocked(None).unwrap();
+
+    let master_key_chain = MasterKeyChain::new_from_mnemonic(


why mnemonic?

I don't fully understand how it's tested, this is run manually right? It looks like possible to run emulator with cli and automate this. Let's maybe discuss it because I'm afraid such functionality is not tested enough

azarovh · 2024-08-24T10:42:09Z

wallet/src/signer/trezor_signer/mod.rs

+
+fn find_trezor_device() -> Result<Trezor, TrezorError> {
+    let mut devices = find_devices(false);
+    let device = devices.pop().ok_or(TrezorError::NoDeviceFound)?;


should we filter for Model::Trezor only?

azarovh · 2024-08-24T10:53:15Z

wallet/wallet-cli-commands/src/lib.rs

+
+        /// Create a wallet using a connected hardware wallet. Only the public keys will be kept in
+        /// the software wallet
+        #[arg(long, conflicts_with_all(["mnemonic", "passphrase"]))]


it also conflicts with whether_to_store_seed_phrase

azarovh · 2024-08-24T10:57:56Z

wallet/wallet-cli-commands/src/lib.rs

@@ -73,6 +103,10 @@ pub enum WalletManagementCommand {
        /// Force change the wallet type from hot to cold or from cold to hot
        #[arg(long)]
        force_change_wallet_type: bool,


looks like a conflict with hardware

azarovh · 2024-08-24T11:00:41Z

wallet/wallet-controller/src/types/mod.rs

+            Self::Trezor => WalletType::Trezor,
+        }
+    }
+    pub fn user_supplied_menmonic(&self) -> bool {


azarovh · 2024-08-24T11:15:12Z

wallet/wallet-cli-commands/src/lib.rs

+        whether_to_store_seed_phrase: CliStoreSeedPhrase,
+
+        /// Mnemonic phrase (12, 15, or 24 words as a single quoted argument). If not specified, a new mnemonic phrase is generated and printed.
+        mnemonic: Option<String>,


should it be just String? btw we can remove mnemonic from CreateWallet

azarovh · 2024-08-24T11:19:32Z

wallet/src/signer/trezor_signer/mod.rs

+                OutputValue::TokenV1(token_id, amount) => {
+                    let mut value = MintlayerOutputValue::new();
+                    value.set_amount(amount.into_atoms().to_be_bytes().to_vec());
+                    value.set_token_id(token_id.to_hash().as_bytes().to_vec());


this looks out of sync with firmware code. I can't build it with pointing to feature/mintlayer-pk branch either

OBorce force-pushed the refactor/wallet-generic-signer branch from e1f4596 to 37b71b9 Compare June 20, 2024 04:25

OBorce force-pushed the refactor/wallet-generic-signer branch from 5ea96b9 to b031a27 Compare July 30, 2024 08:09

OBorce added 9 commits July 30, 2024 10:22

Add SignerProvider generic to the wallet

f4dd203

Add optional trezor signer support

de940ea

add trezor-client generated code

cd4c02c

refactor signer provider for creating wallet accounts

43e5abc

Add trezor hardware wallet Account implementation

b367eb1

add cli command arguments for creating trezor wallet

458a012

add support for all inputs and outputs to trezor signer

ea0fae8

add support for signing challenges with trezor

6e1b814

Add support for trezor wallet in node gui

ebe973d

OBorce force-pushed the refactor/wallet-generic-signer branch 2 times, most recently from 293c300 to cfd9fe9 Compare July 30, 2024 19:46

fix pipeline errors

484b20c

OBorce force-pushed the refactor/wallet-generic-signer branch 2 times, most recently from a99614e to 626b7d1 Compare July 31, 2024 19:28

fix trezor feature compilation

fb2af0d

OBorce force-pushed the refactor/wallet-generic-signer branch from 626b7d1 to fb2af0d Compare August 1, 2024 07:47

update rpc docs

18efe6f

OBorce marked this pull request as ready for review August 1, 2024 12:04

OBorce requested review from erubboli, azarovh and ImplOfAnImpl as code owners August 1, 2024 12:04

OBorce commented Aug 1, 2024

View reviewed changes

do_checks.sh Outdated Show resolved Hide resolved

OBorce commented Aug 1, 2024

View reviewed changes

azarovh reviewed Aug 5, 2024

View reviewed changes

remove the trezor client code and reference the git repository

855cfce

OBorce force-pushed the refactor/wallet-generic-signer branch from 726bb45 to 855cfce Compare August 6, 2024 10:54

azarovh reviewed Aug 6, 2024

View reviewed changes

ImplOfAnImpl approved these changes Aug 7, 2024

View reviewed changes

add support for Hot wallet with trezor device

2bfa44c

OBorce force-pushed the refactor/wallet-generic-signer branch from 3b2c77a to 1cd8110 Compare August 13, 2024 13:36

add wallet-recover command

c23f38d

- it will rescan the blokchain on wallet creation - wallet-create will only scan forward from the current block height

OBorce force-pushed the refactor/wallet-generic-signer branch from 1cd8110 to c23f38d Compare August 13, 2024 23:23

azarovh reviewed Aug 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/wallet generic signer #1783

Refactor/wallet generic signer #1783

OBorce commented Jun 18, 2024 •

edited

Loading

OBorce Aug 1, 2024

ImplOfAnImpl Aug 7, 2024

azarovh Aug 5, 2024

azarovh Aug 6, 2024

azarovh Aug 6, 2024

azarovh Aug 6, 2024

azarovh Aug 6, 2024

azarovh Aug 6, 2024

ImplOfAnImpl Aug 7, 2024

ImplOfAnImpl Aug 7, 2024

ImplOfAnImpl Aug 7, 2024

ImplOfAnImpl Aug 7, 2024

ImplOfAnImpl Aug 7, 2024

ImplOfAnImpl Aug 7, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

azarovh Aug 24, 2024

Refactor/wallet generic signer #1783

Are you sure you want to change the base?

Refactor/wallet generic signer #1783

Conversation

OBorce commented Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OBorce commented Jun 18, 2024 •

edited

Loading