feat(wallet-connect): impl BTC (UTxO) for swaps v2

mm2src/coins/Cargo.toml

@@ -29,6 +29,7 @@ async-std = { workspace = true, features = ["unstable"] }
 async-trait.workspace = true
 base64.workspace = true
 bip32.workspace = true
+bitcoin.workspace = true
 bitcoin_hashes.workspace = true
 bitcrypto = { path = "../mm2_bitcoin/crypto" }
 blake2b_simd = { workspace = true, optional = true }
@@ -73,11 +74,11 @@ mm2_event_stream = { path = "../mm2_event_stream" }
 mm2_io = { path = "../mm2_io" }
 mm2_metrics = { path = "../mm2_metrics" }
 mm2_net = { path = "../mm2_net" }
-mm2_number = { path = "../mm2_number"}
+mm2_number = { path = "../mm2_number" }
 mm2_p2p = { path = "../mm2_p2p", default-features = false }
 mm2_rpc = { path = "../mm2_rpc" }
 mm2_state_machine = { path = "../mm2_state_machine" }
-mocktopus = { workspace =  true, optional = true }
+mocktopus = { workspace = true, optional = true }
 num-traits.workspace = true
 parking_lot = { workspace = true }
 primitives = { path = "../mm2_bitcoin/primitives" }
@@ -108,7 +109,9 @@ sha3.workspace = true
 utxo_signer = { path = "utxo_signer" }
 # using the same version as cosmrs
 tendermint-rpc.workspace = true
-tokio-tungstenite-wasm = { workspace = true, features = ["rustls-tls-native-roots"]}
+tokio-tungstenite-wasm = { workspace = true, features = [
+	"rustls-tls-native-roots",
+] }
 url.workspace = true
 uuid.workspace = true
 # One of web3 dependencies is the old `tokio-uds 0.1.7` which fails cross-compiling to ARM.
@@ -130,12 +133,24 @@ mm2_metamask = { path = "../mm2_metamask" }
 mm2_test_helpers = { path = "../mm2_test_helpers" }
 time = { workspace = true, features = ["wasm-bindgen"] }
 timed-map = { workspace = true, features = ["rustc-hash", "wasm"] }
-tonic = { workspace = true, default-features = false, features = ["prost", "codegen", "gzip"] }
+tonic = { workspace = true, default-features = false, features = [
+	"prost",
+	"codegen",
+	"gzip",
+] }
 tower-service.workspace = true
 wasm-bindgen.workspace = true
 wasm-bindgen-futures.workspace = true
 wasm-bindgen-test.workspace = true
-web-sys = { workspace = true, features = ["console", "Headers", "Request", "RequestInit", "RequestMode", "Response", "Window"] }
+web-sys = { workspace = true, features = [
+	"console",
+	"Headers",
+	"Request",
+	"RequestInit",
+	"RequestMode",
+	"Response",
+	"Window",
+] }
 zcash_proofs = { workspace = true, features = ["local-prover"] }
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
@@ -152,7 +167,13 @@ secp256k1v24.workspace = true
 timed-map = { workspace = true, features = ["rustc-hash"] }
 tokio.workspace = true
 tokio-rustls.workspace = true
-tonic = { workspace = true, features = ["codegen", "prost", "gzip", "tls", "tls-webpki-roots"] }
+tonic = { workspace = true, features = [
+	"codegen",
+	"prost",
+	"gzip",
+	"tls",
+	"tls-webpki-roots",
+] }
 webpki-roots.workspace = true
 zcash_client_sqlite.workspace = true
 zcash_proofs = { workspace = true, features = ["local-prover", "multicore"] }

mm2src/coins/lp_coins.rs

@@ -4484,6 +4484,10 @@ impl<T> PrivKeyPolicy<T> {
     fn is_trezor(&self) -> bool {
         matches!(self, PrivKeyPolicy::Trezor)
     }
+
+    fn is_internal(&self) -> bool {
+        matches!(self, PrivKeyPolicy::Iguana(_) | PrivKeyPolicy::HDWallet { .. })
+    }
 }
 
 /// 'CoinWithPrivKeyPolicy' trait is used to get the private key policy of a coin.
@@ -4722,7 +4726,7 @@ pub struct UtxoProtocolInfo {
 #[derive(Clone, Debug, Deserialize, Serialize)]
 #[serde(tag = "type", content = "protocol_data")]
 pub enum CoinProtocol {
-    // TODO: Nest this option deep into the innert struct fields when more fields are added to the UTXO protocol info.
+    // TODO: Nest this option deep into the inner struct fields when more fields are added to the UTXO protocol info.
     UTXO(Option<UtxoProtocolInfo>),
     QTUM,
     QRC20 {

mm2src/coins/qrc20.rs

@@ -716,7 +716,7 @@ impl UtxoCommonOps for Qrc20Coin {
         utxo_common::denominate_satoshis(&self.utxo, satoshi)
     }
 
-    fn my_public_key(&self) -> Result<&Public, MmError<UnexpectedDerivationMethod>> {
+    fn my_public_key(&self) -> Result<Public, MmError<UnexpectedDerivationMethod>> {
         utxo_common::my_public_key(self.as_ref())
     }
 
@@ -754,7 +754,7 @@ impl UtxoCommonOps for Qrc20Coin {
         utxo_common::get_mut_verbose_transaction_from_map_or_rpc(self, tx_hash, utxo_tx_map).await
     }
 
-    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput<'_>) -> Result<UtxoTx, String> {
+    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput) -> Result<UtxoTx, String> {
         utxo_common::p2sh_spending_tx(self, input).await
     }
 
@@ -1073,7 +1073,7 @@ impl SwapOps for Qrc20Coin {
     }
 
     fn derive_htlc_pubkey(&self, swap_unique_data: &[u8]) -> [u8; 33] {
-        utxo_common::derive_htlc_pubkey(self, swap_unique_data)
+        utxo_common::derive_htlc_pubkey(self.as_ref(), swap_unique_data)
     }
 
     #[inline]

mm2src/coins/utxo.rs

@@ -61,6 +61,7 @@ use futures::channel::mpsc::{Receiver as AsyncReceiver, Sender as AsyncSender};
 use futures::compat::Future01CompatExt;
 use futures::lock::{Mutex as AsyncMutex, MutexGuard as AsyncMutexGuard};
 use futures01::Future;
+use kdf_walletconnect::chain::WcChainId;
 use keys::bytes::Bytes;
 use keys::NetworkAddressPrefixes;
 use keys::Signature;
@@ -600,6 +601,9 @@ pub struct UtxoCoinConf {
     pub checksum_type: ChecksumType,
     /// Fork id used in sighash
     pub fork_id: u32,
+    /// A CAIP-2 compliant chain ID. This is used to identify the UTXO chain in WalletConnect and other cross-chain protocols.
+    /// https://github.com/ChainAgnostic/CAIPs/blob/9516a2c0b26223d98a342938bf6d9ee59517f190/CAIPs/caip-4.md
+    pub chain_id: Option<WcChainId>,
     /// Signature version
     pub signature_version: SignatureVersion,
     pub required_confirmations: AtomicU64,
@@ -1056,7 +1060,7 @@ pub trait UtxoCommonOps:
     /// The method is expected to fail if [`UtxoCoinFields::priv_key_policy`] is [`PrivKeyPolicy::HardwareWallet`].
     /// It's worth adding a method like `my_public_key_der_path`
     /// that takes a derivation path from which we derive the corresponding public key.
-    fn my_public_key(&self) -> Result<&Public, MmError<UnexpectedDerivationMethod>>;
+    fn my_public_key(&self) -> Result<Public, MmError<UnexpectedDerivationMethod>>;
 
     /// Try to parse address from string using specified on asset enable format,
     /// and if it failed inform user that he used a wrong format.
@@ -1083,7 +1087,7 @@ pub trait UtxoCommonOps:
 
     /// Generates a transaction spending P2SH vout (typically, with 0 index [`utxo_common::DEFAULT_SWAP_VOUT`]) of input.prev_transaction
     /// Works only if single signature is required!
-    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput<'_>) -> Result<UtxoTx, String>;
+    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput) -> Result<UtxoTx, String>;
 
     /// Loads verbose transactions from cache or requests it using RPC client.
     fn get_verbose_transactions_from_cache_or_rpc(
@@ -1877,7 +1881,6 @@ where
     T: AsRef<UtxoCoinFields> + UtxoTxGenerationOps + UtxoTxBroadcastOps,
 {
     let my_address = try_tx_s!(coin.as_ref().derivation_method.single_addr_or_err().await);
-    let key_pair = try_tx_s!(coin.as_ref().priv_key_policy.activated_key_or_err());
     let mut builder = UtxoTxBuilder::new(coin)
         .await
         .add_available_inputs(unspents)
@@ -1888,7 +1891,7 @@ where
     }
     let (unsigned, _) = try_tx_s!(builder.build().await);
 
-    let spent_unspents = unsigned
+    let spent_unspents: Vec<_> = unsigned
         .inputs
         .iter()
         .map(|input| UnspentInfo {
@@ -1904,12 +1907,22 @@ where
         _ => coin.as_ref().conf.signature_version,
     };
 
-    let signed = try_tx_s!(sign_tx(
-        unsigned,
-        key_pair,
-        signature_version,
-        coin.as_ref().conf.fork_id
-    ));
+    let signed = match coin.as_ref().priv_key_policy {
+        PrivKeyPolicy::Iguana(activated_key) | PrivKeyPolicy::HDWallet { activated_key, .. } => {
+            try_tx_s!(sign_tx(
+                unsigned,
+                &activated_key,
+                signature_version,
+                coin.as_ref().conf.fork_id
+            ))
+        },
+        PrivKeyPolicy::WalletConnect { ref session_topic, .. } => {
+            try_tx_s!(wallet_connect::sign_p2pkh(coin, session_topic, &unsigned).await)
+        },
+        PrivKeyPolicy::Trezor => return Err(TransactionErr::Plain("Can't sign tx with trezor".to_string())),
+        #[cfg(target_arch = "wasm32")]
+        PrivKeyPolicy::Metamask { .. } => return Err(TransactionErr::Plain("Can't sign tx with metamask".to_string())),
+    };
 
     Ok((signed, spent_unspents))
 }

mm2src/coins/utxo/bch.rs

@@ -809,7 +809,7 @@ impl UtxoCommonOps for BchCoin {
         utxo_common::denominate_satoshis(&self.utxo_arc, satoshi)
     }
 
-    fn my_public_key(&self) -> Result<&Public, MmError<UnexpectedDerivationMethod>> {
+    fn my_public_key(&self) -> Result<Public, MmError<UnexpectedDerivationMethod>> {
         utxo_common::my_public_key(self.as_ref())
     }
 
@@ -842,7 +842,7 @@ impl UtxoCommonOps for BchCoin {
         utxo_common::get_mut_verbose_transaction_from_map_or_rpc(self, tx_hash, utxo_tx_map).await
     }
 
-    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput<'_>) -> Result<UtxoTx, String> {
+    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput) -> Result<UtxoTx, String> {
         utxo_common::p2sh_spending_tx(self, input).await
     }
 
@@ -1046,7 +1046,7 @@ impl SwapOps for BchCoin {
     }
 
     fn derive_htlc_pubkey(&self, swap_unique_data: &[u8]) -> [u8; 33] {
-        utxo_common::derive_htlc_pubkey(self, swap_unique_data)
+        utxo_common::derive_htlc_pubkey(self.as_ref(), swap_unique_data)
     }
 
     #[inline]

mm2src/coins/utxo/qtum.rs

@@ -422,7 +422,7 @@ impl UtxoCommonOps for QtumCoin {
         utxo_common::denominate_satoshis(&self.utxo_arc, satoshi)
     }
 
-    fn my_public_key(&self) -> Result<&Public, MmError<UnexpectedDerivationMethod>> {
+    fn my_public_key(&self) -> Result<Public, MmError<UnexpectedDerivationMethod>> {
         utxo_common::my_public_key(self.as_ref())
     }
 
@@ -460,7 +460,7 @@ impl UtxoCommonOps for QtumCoin {
         utxo_common::get_mut_verbose_transaction_from_map_or_rpc(self, tx_hash, utxo_tx_map).await
     }
 
-    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput<'_>) -> Result<UtxoTx, String> {
+    async fn p2sh_spending_tx(&self, input: utxo_common::P2SHSpendingTxInput) -> Result<UtxoTx, String> {
         utxo_common::p2sh_spending_tx(self, input).await
     }
 
@@ -686,7 +686,7 @@ impl SwapOps for QtumCoin {
     }
 
     fn derive_htlc_pubkey(&self, swap_unique_data: &[u8]) -> [u8; 33] {
-        utxo_common::derive_htlc_pubkey(self, swap_unique_data)
+        utxo_common::derive_htlc_pubkey(self.as_ref(), swap_unique_data)
     }
 
     #[inline]

mm2src/coins/utxo/slp.rs

@@ -10,7 +10,7 @@ use crate::tx_history_storage::{GetTxHistoryFilters, WalletId};
 use crate::utxo::bch::BchCoin;
 use crate::utxo::bchd_grpc::{check_slp_transaction, validate_slp_utxos, ValidateSlpUtxosErr};
 use crate::utxo::rpc_clients::{UnspentInfo, UtxoRpcClientEnum, UtxoRpcError, UtxoRpcResult};
-use crate::utxo::utxo_common::{self, big_decimal_from_sat_unsigned, payment_script, UtxoTxBuilder};
+use crate::utxo::utxo_common::{self, big_decimal_from_sat_unsigned, payment_script, UtxoTxBuilder, DEFAULT_SWAP_VIN};
 use crate::utxo::{
     generate_and_send_tx, sat_from_big_decimal, ActualFeeRate, BroadcastTxErr, FeePolicy, GenerateTxError,
     RecentlySpentOutPointsGuard, UtxoCoinConf, UtxoCoinFields, UtxoCommonOps, UtxoTx, UtxoTxBroadcastOps,
@@ -581,7 +581,7 @@ impl SlpToken {
 
         let other_pub = Public::from_slice(other_pub)?;
         let my_public_key = self.platform_coin.my_public_key().map_mm_err()?;
-        let redeem_script = payment_script(time_lock, secret_hash, my_public_key, &other_pub);
+        let redeem_script = payment_script(time_lock, secret_hash, &my_public_key, &other_pub);
 
         let slp_amount = match slp_tx.transaction {
             SlpTransaction::Send { token_id, amounts } => {
@@ -702,7 +702,7 @@ impl SlpToken {
             .map_mm_err()?;
 
         unsigned.lock_time = tx_locktime;
-        unsigned.inputs[0].sequence = input_sequence;
+        unsigned.inputs[DEFAULT_SWAP_VIN].sequence = input_sequence;
 
         let my_key_pair = self
             .platform_coin
@@ -712,7 +712,7 @@ impl SlpToken {
             .map_mm_err()?;
         let signed_p2sh_input = p2sh_spend(
             &unsigned,
-            0,
+            DEFAULT_SWAP_VIN,
             htlc_keypair,
             script_data,
             redeem_script,
@@ -1516,7 +1516,7 @@ impl SwapOps for SlpToken {
     }
 
     fn derive_htlc_pubkey(&self, swap_unique_data: &[u8]) -> [u8; 33] {
-        utxo_common::derive_htlc_pubkey(self, swap_unique_data)
+        utxo_common::derive_htlc_pubkey(self.as_ref(), swap_unique_data)
     }
 
     #[inline]
@@ -2162,7 +2162,7 @@ mod slp_tests {
         let other_pub = Public::from_slice(&other_pub).unwrap();
 
         let my_public_key = bch.my_public_key().unwrap();
-        let htlc_script = payment_script(1624547837, &secret_hash, &other_pub, my_public_key);
+        let htlc_script = payment_script(1624547837, &secret_hash, &other_pub, &my_public_key);
 
         let slp_send_op_return_out = slp_send_output(&token_id, &[1000]);
 
@@ -2254,10 +2254,10 @@ mod slp_tests {
 
         // standard BCH validation should pass as the output itself is correct
         block_on(utxo_common::validate_payment(
-            bch.clone(),
+            bch,
             &deserialize(payment_tx.as_slice()).unwrap(),
             SLP_SWAP_VOUT,
-            my_pub,
+            &my_pub,
             &other_pub,
             SwapTxTypeWithSecretHash::TakerOrMakerPayment {
                 maker_secret_hash: &secret_hash,