Make signing an async operation

- to make an easier integration with Ledger in the future

Author: OBorce

Cargo.lock

@@ -28,7 +28,9 @@ wallet-storage = { path = "./storage" }
 wallet-types = { path = "./types" }
 trezor-client = { git = "https://github.com/mintlayer/mintlayer-trezor-firmware", branch = "feature/mintlayer-pk", features = ["bitcoin", "mintlayer"], optional = true }
 
+async-trait.workspace = true
 bip39 = { workspace = true, default-features = false, features = ["std", "zeroize"] }
+futures = { workspace = true, default-features = false }
 hex.workspace = true
 itertools.workspace = true
 parity-scale-codec.workspace = true
@@ -38,6 +40,7 @@ zeroize.workspace = true
 
 [dev-dependencies]
 test-utils = { path = "../test-utils" }
+tokio = { workspace = true, default-features = false, features = ["io-util", "macros", "net", "rt", "sync"] }
 
 rstest.workspace = true
 tempfile.workspace = true

wallet/Cargo.toml

@@ -120,7 +120,7 @@ pub struct Account<K> {
     account_info: AccountInfo,
 }
 
-impl<K: AccountKeyChains> Account<K> {
+impl<K: AccountKeyChains + Sync> Account<K> {
     /// Create a new account by providing a key chain
     pub fn new(
         chain_config: Arc<ChainConfig>,
@@ -654,7 +654,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn process_send_request_and_sign(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         request: SendRequest,
         inputs: SelectedInputs,
         change_addresses: BTreeMap<Currency, Address<Destination>>,
@@ -676,7 +676,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     fn decommission_stake_pool_impl(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         pool_id: PoolId,
         pool_balance: Amount,
         output_address: Option<Destination>,
@@ -739,7 +739,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn decommission_stake_pool(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         pool_id: PoolId,
         pool_balance: Amount,
         output_address: Option<Destination>,
@@ -756,7 +756,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn decommission_stake_pool_request(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         pool_id: PoolId,
         pool_balance: Amount,
         output_address: Option<Destination>,
@@ -900,7 +900,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn create_htlc_tx(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         output_value: OutputValue,
         htlc: HashedTimelockContract,
         median_time: BlockTimestamp,
@@ -923,7 +923,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn create_order_tx(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         ask_value: OutputValue,
         give_value: OutputValue,
         conclude_address: Address<Destination>,
@@ -949,7 +949,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn create_conclude_order_tx(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         order_id: OrderId,
         order_info: RpcOrderInfo,
         output_address: Option<Destination>,
@@ -1002,7 +1002,7 @@ impl<K: AccountKeyChains> Account<K> {
     #[allow(clippy::too_many_arguments)]
     pub fn create_fill_order_tx(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         order_id: OrderId,
         order_info: RpcOrderInfo,
         fill_amount_in_ask_currency: Amount,
@@ -1058,7 +1058,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn create_issue_nft_tx(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         nft_issue_arguments: IssueNftArguments,
         median_time: BlockTimestamp,
         fee_rate: CurrentFeeRate,
@@ -1119,7 +1119,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn mint_tokens(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         address: Address<Destination>,
         amount: Amount,
@@ -1147,7 +1147,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn unmint_tokens(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         amount: Amount,
         median_time: BlockTimestamp,
@@ -1174,7 +1174,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn lock_token_supply(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         median_time: BlockTimestamp,
         fee_rate: CurrentFeeRate,
@@ -1198,7 +1198,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn freeze_token(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         is_token_unfreezable: IsTokenUnfreezable,
         median_time: BlockTimestamp,
@@ -1225,7 +1225,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn unfreeze_token(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         median_time: BlockTimestamp,
         fee_rate: CurrentFeeRate,
@@ -1249,7 +1249,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn change_token_authority(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         address: Address<Destination>,
         median_time: BlockTimestamp,
@@ -1276,7 +1276,7 @@ impl<K: AccountKeyChains> Account<K> {
 
     pub fn change_token_metadata_uri(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         token_info: &UnconfirmedTokenInfo,
         metadata_uri: Vec<u8>,
         median_time: BlockTimestamp,
@@ -1304,7 +1304,7 @@ impl<K: AccountKeyChains> Account<K> {
         authority: Destination,
         tx_input: TxInput,
         outputs: Vec<TxOutput>,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         median_time: BlockTimestamp,
         fee_rate: CurrentFeeRate,
     ) -> Result<SendRequest, WalletError> {
@@ -2128,7 +2128,7 @@ struct PreselectedInputAmounts {
     pub burn: Amount,
 }
 
-impl<K: AccountKeyChains + VRFAccountKeyChains> Account<K> {
+impl<K: AccountKeyChains + VRFAccountKeyChains + Sync> Account<K> {
     fn get_vrf_public_key(
         &mut self,
         db_tx: &mut impl WalletStorageWriteLocked,
@@ -2199,7 +2199,7 @@ impl<K: AccountKeyChains + VRFAccountKeyChains> Account<K> {
 
     pub fn create_stake_pool_tx(
         &mut self,
-        db_tx: &mut impl WalletStorageWriteUnlocked,
+        db_tx: &mut impl WalletStorageWriteLocked,
         stake_pool_arguments: StakePoolDataArguments,
         median_time: BlockTimestamp,
         fee_rate: CurrentFeeRate,

wallet/src/account/mod.rs

@@ -15,6 +15,7 @@
 
 use std::sync::Arc;
 
+use async_trait::async_trait;
 use common::chain::{
     signature::{
         inputsig::{
@@ -86,32 +87,33 @@ type SignerResult<T> = Result<T, SignerError>;
 
 /// Signer trait responsible for signing transactions or challenges using a software or hardware
 /// wallet
+#[async_trait]
 pub trait Signer {
     /// sign a partially signed transaction and return the before and after signature statuses
-    fn sign_tx(
+    async fn sign_tx(
         &mut self,
         tx: PartiallySignedTransaction,
-        key_chain: &impl AccountKeyChains,
-        db_tx: &impl WalletStorageReadUnlocked,
+        key_chain: &(impl AccountKeyChains + Sync),
+        db_tx: &(impl WalletStorageReadUnlocked + Sync),
     ) -> SignerResult<(
         PartiallySignedTransaction,
         Vec<SignatureStatus>,
         Vec<SignatureStatus>,
     )>;
 
     /// sign an arbitrary message for a destination known to this key chain
-    fn sign_challenge(
+    async fn sign_challenge(
         &mut self,
         message: Vec<u8>,
         destination: Destination,
-        key_chain: &impl AccountKeyChains,
-        db_tx: &impl WalletStorageReadUnlocked,
+        key_chain: &(impl AccountKeyChains + Sync),
+        db_tx: &(impl WalletStorageReadUnlocked + Sync),
     ) -> SignerResult<ArbitraryMessageSignature>;
 }
 
 pub trait SignerProvider {
     type S: Signer;
-    type K: AccountKeyChains;
+    type K: AccountKeyChains + Sync;
 
     fn provide(&mut self, chain_config: Arc<ChainConfig>, account_index: U31) -> Self::S;
 

wallet/src/signer/mod.rs

@@ -15,6 +15,7 @@
 
 use std::sync::Arc;
 
+use async_trait::async_trait;
 use common::chain::{
     htlc::HtlcSecret,
     signature::{
@@ -253,12 +254,13 @@ impl SoftwareSigner {
     }
 }
 
+#[async_trait]
 impl Signer for SoftwareSigner {
-    fn sign_tx(
+    async fn sign_tx(
         &mut self,
         ptx: PartiallySignedTransaction,
-        key_chain: &impl AccountKeyChains,
-        db_tx: &impl WalletStorageReadUnlocked,
+        key_chain: &(impl AccountKeyChains + Sync),
+        db_tx: &(impl WalletStorageReadUnlocked + Sync),
     ) -> SignerResult<(
         PartiallySignedTransaction,
         Vec<SignatureStatus>,
@@ -359,12 +361,12 @@ impl Signer for SoftwareSigner {
         Ok((ptx.with_witnesses(witnesses), prev_statuses, new_statuses))
     }
 
-    fn sign_challenge(
+    async fn sign_challenge(
         &mut self,
         message: Vec<u8>,
         destination: Destination,
-        key_chain: &impl AccountKeyChains,
-        db_tx: &impl WalletStorageReadUnlocked,
+        key_chain: &(impl AccountKeyChains + Sync),
+        db_tx: &(impl WalletStorageReadUnlocked + Sync),
     ) -> SignerResult<ArbitraryMessageSignature> {
         let private_key = self
             .get_private_key_for_destination(&destination, key_chain, db_tx)?

wallet/src/signer/software_signer/mod.rs

@@ -51,7 +51,10 @@ const MNEMONIC: &str =
 #[rstest]
 #[trace]
 #[case(Seed::from_entropy())]
-fn sign_message(#[case] seed: Seed) {
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn sign_message(#[case] seed: Seed) {
+    use wallet_storage::TransactionRwUnlocked;
+
     let mut rng = make_seedable_rng(seed);
 
     let config = Arc::new(create_regtest());
@@ -75,13 +78,16 @@ fn sign_message(#[case] seed: Seed) {
     let destination = account.get_new_address(&mut db_tx, ReceiveFunds).unwrap().1.into_object();
     let mut signer = SoftwareSigner::new(config.clone(), DEFAULT_ACCOUNT_INDEX);
     let message = vec![rng.gen::<u8>(), rng.gen::<u8>(), rng.gen::<u8>()];
+    db_tx.commit().unwrap();
+    let db_tx = db.local_rw_unlocked().read_only_store();
     let res = signer
         .sign_challenge(
             message.clone(),
             destination.clone(),
             account.key_chain(),
             &db_tx,
         )
+        .await
         .unwrap();
 
     let message_challenge = produce_message_challenge(&message);
@@ -91,7 +97,8 @@ fn sign_message(#[case] seed: Seed) {
 #[rstest]
 #[trace]
 #[case(Seed::from_entropy())]
-fn sign_transaction(#[case] seed: Seed) {
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+async fn sign_transaction(#[case] seed: Seed) {
     use std::num::NonZeroU8;
 
     use common::{
@@ -110,6 +117,7 @@ fn sign_transaction(#[case] seed: Seed) {
     };
     use crypto::vrf::VRFPrivateKey;
     use serialization::extras::non_empty_vec::DataOrNoVec;
+    use wallet_storage::TransactionRwUnlocked;
 
     let mut rng = make_seedable_rng(seed);
 
@@ -376,8 +384,10 @@ fn sign_transaction(#[case] seed: Seed) {
     let additional_info = BTreeMap::new();
     let ptx = req.into_partially_signed_tx(&additional_info).unwrap();
 
+    db_tx.commit().unwrap();
+    let db_tx = db.local_rw_unlocked().read_only_store();
     let mut signer = SoftwareSigner::new(chain_config.clone(), DEFAULT_ACCOUNT_INDEX);
-    let (ptx, _, _) = signer.sign_tx(ptx, account.key_chain(), &db_tx).unwrap();
+    let (ptx, _, _) = signer.sign_tx(ptx, account.key_chain(), &db_tx).await.unwrap();
 
     eprintln!("num inputs in tx: {} {:?}", inputs.len(), ptx.witnesses());
     assert!(ptx.all_signatures_available());