Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor/wallet generic signer #1783

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
Open

Conversation

OBorce
Copy link
Contributor

@OBorce OBorce commented Jun 18, 2024

  • 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

@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch from e1f4596 to 37b71b9 Compare June 20, 2024 04:25
@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch 6 times, most recently from 626b7d1 to fb2af0d Compare August 1, 2024 07:47
@OBorce OBorce marked this pull request as ready for review August 1, 2024 12:04
do_checks.sh Outdated Show resolved Hide resolved
@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch from 726bb45 to 855cfce Compare August 6, 2024 10:54
build-tools/codecheck/codecheck.py Outdated Show resolved Hide resolved
crypto/src/key/secp256k1/extended_keys.rs Outdated Show resolved Hide resolved
crypto/src/key/extended.rs Outdated Show resolved Hide resolved
node-gui/src/backend/backend_impl.rs Show resolved Hide resolved
@@ -287,3 +287,6 @@ opt-level = 2
[profile.dist]
inherits = "release"
lto = "off"

[features]
trezor = []
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should be enabled in CI

wallet/src/signer/trezor_signer/mod.rs Outdated Show resolved Hide resolved
wallet/Cargo.toml Outdated Show resolved Hide resolved
wallet/wallet-cli-commands/src/helper_types.rs Outdated Show resolved Hide resolved
wallet/wallet-cli-commands/src/command_handler/mod.rs Outdated Show resolved Hide resolved
Comment on lines 417 to 435
match &self.wallet {
WalletType2::Software(w) => w.seed_phrase(),
#[cfg(feature = "trezor")]
WalletType2::Trezor(w) => w.seed_phrase(),
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved inside the impl

wallet/wallet-controller/src/lib.rs Outdated Show resolved Hide resolved
@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch 2 times, most recently from 1cd8110 to c23f38d Compare August 13, 2024 23:23
wallet/src/signer/trezor_signer/mod.rs Outdated Show resolved Hide resolved
SignatureStatus::FullySigned,
SignatureStatus::FullySigned,
)),
InputWitness::Standard(sig) => match destination {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

wallet/src/signer/trezor_signer/mod.rs Outdated Show resolved Hide resolved
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(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. why mnemonic?
  2. 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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved

/// 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"]))]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it also conflicts with whether_to_store_seed_phrase

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

wallet/wallet-cli-commands/src/lib.rs Show resolved Hide resolved
wallet/wallet-controller/src/types/mod.rs Outdated Show resolved Hide resolved
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>,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is optional because of the hardware wallet option.

wallet/src/signer/trezor_signer/mod.rs Outdated Show resolved Hide resolved
@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch from c23f38d to 4824da8 Compare August 30, 2024 16:09
@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch 2 times, most recently from f787225 to a35f2c3 Compare September 11, 2024 08:35
@OBorce OBorce force-pushed the refactor/wallet-generic-signer branch from 2157893 to 2014928 Compare September 11, 2024 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants