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

wallet/wallet-controller/src/lib.rs

wallet/src/signer/trezor_signer/mod.rs

build-tools/codecheck/codecheck.py

crypto/src/key/secp256k1/extended_keys.rs

crypto/src/key/extended.rs

node-gui/src/backend/backend_impl.rs

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

this comment is still valid. We can't run tests on CI but we can at least build the code

wallet/src/signer/trezor_signer/mod.rs

wallet/Cargo.toml

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

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

wallet/wallet-controller/src/lib.rs

wallet/src/signer/trezor_signer/mod.rs

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

The current test assumes the device will be initialized with the same mnemonic, but that can be fixed later as the tests can't run automatically now anyway.

To automate the tests I think we will need first to make the signing async, so that we can return from the wallet the status of the signing, i.e. when it is waiting for a button to be pressed on the trezor device

wallet/src/signer/trezor_signer/mod.rs

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

whether_to_store_seed_phrase was a required parameter I am not sure if we should break backwards compatibility or not, that is why I left it alone, and just check that it is set to false.

Should thenwhether_to_store_seed_phrase be marked with required_unless_present("hardware_wallet") or something like that? So people won't have to type it every time for hardware.

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

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

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

wallet/src/signer/trezor_signer/mod.rs

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

wallet/wallet-rpc-lib/src/rpc/types.rs

wallet/wallet-rpc-lib/src/service/worker.rs

wallet/types/src/wallet_type.rs

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

wallet/src/signer/trezor_signer/tests.rs

azarovh · 2024-10-08T07:58:46Z

wallet/src/signer/trezor_signer/tests.rs

+            Destination::AnyoneCanSpend,
+        ),
+        TxOutput::DataDeposit(vec![1, 2, 3]),
+        TxOutput::Htlc(OutputValue::Coin(burn_amount), Box::new(hash_lock)),


there also should be a case for spending Htlc utxo with a secret

wallet/src/signer/trezor_signer/tests.rs

azarovh · 2024-10-08T08:15:18Z

wallet/src/signer/trezor_signer/tests.rs

+    assert!(!devices.is_empty());
+    let client = devices.pop().unwrap().connect().unwrap();
+
+    let mut signer = TrezorSigner::new(chain_config.clone(), Arc::new(Mutex::new(client)));


There should be some negative cases: where trezor failed to sign inputs with unknown keys or something like that.

How does device become aware of private keys? I see that at the beginning of the test a key chain is created from mnemonic, but how trezor is related to that I don't understand (like initialising it with test mnemonic of something)

ok I keep forgetting that this is manual test. So basically you have to recover a wallet from test mnemonic right?

- 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 e1f4596 to 37b71b9 Compare June 20, 2024 04:25

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

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

wallet/wallet-controller/src/lib.rs Outdated Show resolved Hide resolved

azarovh reviewed Aug 5, 2024

View reviewed changes

wallet/src/signer/trezor_signer/mod.rs Outdated Show resolved Hide resolved

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

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

azarovh reviewed Aug 24, 2024

View reviewed changes

OBorce force-pushed the refactor/wallet-generic-signer branch from c23f38d to 4824da8 Compare August 30, 2024 16:09

OBorce force-pushed the refactor/wallet-generic-signer branch 4 times, most recently from 6c3d058 to 037f258 Compare September 17, 2024 19:42

OBorce requested review from azarovh and ImplOfAnImpl September 18, 2024 08:53

azarovh reviewed Oct 7, 2024

View reviewed changes

wallet/wallet-cli-commands/src/helper_types.rs Outdated Show resolved Hide resolved

azarovh reviewed Oct 7, 2024

View reviewed changes

azarovh reviewed Oct 8, 2024

View reviewed changes

OBorce added 28 commits October 31, 2024 10:07

fix pipeline errors

c945e6f

fix trezor feature compilation

2444100

update rpc docs

0d2d8ba

remove the trezor client code and reference the git repository

d6c4848

add support for Hot wallet with trezor device

d5c7bc2

add wallet-recover command

3aa3141

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

add additional UTXO info to partially signed tx

855e331

update RPC docs

d5d93b4

add additional token info for utxos in partially signed tx

7c8570b

clean up from review comments

6717aef

update rpc docs

0ba5ad6

Add additional utxo info for tx outputs

309fade

move PartiallySignedTx to wallet

71f9f6d

refactor review comments

8e49516

refactor wallet utxo token_id uses

3b765c9

add separate additional data for anyonecanstake

33172c8

add support for signing HTLC outputs with trezor

f40da28

fix comments

2b319f7

extract runtime wallet functionality

c5dbfa7

fix functional tests

499d2ef

fix trezor test

c0e22f9

add ChangeTokenMetadataUri to trezor singer

e75b9d4

Convert TrezorError to string

ae80b8f

Add support for orders in trezor

44184ea

fix trezor produce from stake additional info

ff715e1

add all inputs/outputs to trezor test

ca87d5f

fix fill order change after rebase

1542b29

Update trezor dependency and new messages

dc97e1b

OBorce force-pushed the refactor/wallet-generic-signer branch from b459b54 to dc97e1b Compare October 31, 2024 09:46

Reuse referenced tokens util in API Server

3abd05c

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

azarovh Aug 6, 2024

azarovh Oct 8, 2024

azarovh Aug 24, 2024

OBorce Sep 17, 2024

azarovh Aug 24, 2024

OBorce Sep 17, 2024

azarovh Oct 7, 2024

azarovh Oct 8, 2024

azarovh Oct 8, 2024

azarovh Oct 8, 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

OBorce commented Jun 18, 2024 •

edited

Loading