feat(walletconnect): walletconnect integration #2223

borngraced · 2024-09-16T19:11:09Z

#1543
This PR introduces the integration of WalletConnect into the Komodo DeFi Framework (KDF), enabling secure wallet connections for Cosmos and EVM-based chains. KDF acts as the DApp(in this PR), allowing users to initiate and manage transactions securely with external wallets e.g via Metamask.
Key changes include:

Implement multi-session handling for concurrent WalletConnect connections across accounts, integrates SQLite/IndexedDB for persistent session storage across devices, enhances relayer disconnection handling for smoother session management
Implemented WalletConnect coin activation for Tendermint and EVM.
Implemented Withdraw and Swap functionalities for Tendermint and EVM

https://specs.walletconnect.com/2.0/specs/clients/sign/
https://specs.walletconnect.com/2.0/specs/clients/core/pairing/
https://specs.walletconnect.com/2.0/specs/clients/core/crypto/
https://specs.walletconnect.com/2.0/specs/servers/relay/
https://docs.reown.com/advanced/multichain/rpc-reference/ethereum-rpc

Additional improvements include cleanup of unused dependencies, minor code refinements, and WASM compatibility

Updated deps:

aead: 0.5.2
aes-gcm: 0.10.3
anyhow: 1.0.89
proc-macro2: 1.0.86
quote: 1.0.37
bip39: 2.1.0
chacha20: 0.9.1
chacha20poly1305: 0.10.1
curve25519-dalek: 4.1.3
ctr: 0.9.2
ghash: 0.5.1
lock_api: 0.4.12
syn: 2.0.77
snow: 0.9.6
signature: 1.6.4
serde_json, serde, serde_derive: 1.0.210

Added deps:

Removed deps:

cipher: 0.4.4 / 0.3.0
aes: 0.8.3
libm: 0.2.7
platforms: 3.0.2

How to test using EVM coin e.g `ETH` (Native && WASM)

Start kdf (cargo run)
Create WalletConnect session connection
- Use the RPC below
- Copy the connection URL and either:
  - Paste directly in your wallet or
  - Generate QR code using QR Code Generator and scan with your wallet (e.g., MetaMask)
Activate ETH coin (set "priv_key_policy": "wallet_connect": { "session_topic": your_session_topic" } in activation params).
Approve authentication request in your Wallet
Withdraw or trade.

Note: To add more eip155 chains, modify the chains array like this: ["eip155:1", "eip155:250"]

New RPC Methods

New connection

method: wc_new_connection

{
	"method": "wc_new_connection",
	"userpass": "{{ _.userpass }}",
	"mmrpc": "2.0",
	"params": {
		"required_namespaces": {
			"eip155": {
				"chains": [
					"eip155:1"
				],
				"methods": [
					"eth_sendTransaction",
					"eth_signTransaction",
					"personal_sign"
				],
				"events": [
					"accountsChanged",
					"chainChanged"
				]
			},
			"cosmos": {
				"chains": [
					"cosmos:cosmoshub-4"
				],
				"methods": [
					"cosmos_signDirect",
					"cosmos_signAmino",
					"cosmos_getAccounts"
				],
				"events": []
			}
		}
	}
}

Get/Retrieve Walletconnect session(s)

method: wc_get_session | wc_get_sessions

{
	"method": "wc_get_session" | "wc_get_sessions",
	"userpass": "{{ _.userpass }}",
	"mmrpc": "2.0",
	"params": {
		"topic": "3a6327f78840427d3a428e8fbaaaaabc8c89c582bb2ff4464d3c73d8e2e5b253"
	}
}

Ping Walletconnect session

method: wc_ping_session

{
	"method": "wc_ping_session",
	"userpass": "{{ _.userpass }}",
	"mmrpc": "2.0",
	"params": {
		"topic": "3a6327f78840427d3a428e8fbaaaaabc8c89c582bb2ff4464d3c73d8e2e5b253"
	}
}

Delete Walletconnect session

method: wc_delete_session

{
	"method": "wc_delete_session",
	"userpass": "{{ _.userpass }}",
	"mmrpc": "2.0",
	"params": {
		"topic": "3a6327f78840427d3a428e8fbaaaaabc8c89c582bb2ff4464d3c73d8e2e5b253"
	}
}

Active ETH/ERC

method: enable_eth_with_tokens

{
    "priv_key_policy": {
        "wallet_connect": {
            "session_topic": "3a6327f78840427d3a428e8fbaaaaabc8c89c582bb2ff4464d3c73d8e2e5b253"
        }
    },
    ...
}

Active Tendermint/Cosmos

method: enable_tendermint_with_assets

{
    "activation_params": {
        "wallet_connect": {
            "session_topic": "'3a6327f78840427d3a428e8fbaaaaabc8c89c582bb2ff4464d3c73d8e2e5b253"
        }
    },
    ...
}

cc @smk762

…ubscriptions

mariocynicys

Done soon :)
there is one pending request in the previous review iter.

mariocynicys · 2025-03-04T13:14:34Z

mm2src/kdf_walletconnect/Cargo.toml

+[target.'cfg(target_arch = "wasm32")'.dependencies]
+js-sys = { version = "0.3.27" }
+mm2_db = { path = "../mm2_db" }
+mm2_test_helpers = { path = "../mm2_test_helpers" }


we shouldn't need this crate here? no?

mariocynicys · 2025-03-04T13:39:43Z

mm2src/kdf_walletconnect/src/lib.rs

@@ -358,10 +359,11 @@ impl WalletConnectCtxImpl {
            .await?;

        let (tx, rx) = oneshot::channel();
+        // insert request to map with a reasonable expiration time of 30 minutes
        self.pending_requests
            .lock()
            .expect("pending request lock shouldn't fail!")


nit: we can just unwrap here. no need for justification for mutex unwraps.

mariocynicys · 2025-03-04T13:40:38Z

mm2src/kdf_walletconnect/src/lib.rs

@@ -358,10 +359,11 @@ impl WalletConnectCtxImpl {
            .await?;

        let (tx, rx) = oneshot::channel();
+        // insert request to map with a reasonable expiration time of 30 minutes


ummm... isn't 30 mins veeery long?

as a user, i wouldn't accept any WC msg if it came so late. that's sus.

WalletConnect doesn't limit timeout it all depends on the timeout we want to set for each request.
I agree 30minsis a very long expiration time.

reduced to 5 mins

… session request

mm2src/coins/eth.rs

onur-ozkan · 2025-03-05T10:56:40Z

mm2src/coins/eth.rs

+            let _nonce_lock = address_lock.lock().await;
+            let pay_for_gas_option = if let Some(ref pay_for_gas) = args.pay_for_gas {
+                pay_for_gas.clone().try_into()?
+            } else {
+                // use legacy gas_price() if not set
+                info!(target: "sign-and-send", "get_gas_price…");
+                let gas_price = coin.get_gas_price().await?;
+                PayForGasOption::Legacy(LegacyGasPrice { gas_price })
+            };
+            let (nonce, _) = coin
+                .clone()
+                .get_addr_nonce(my_address)
+                .compat()
+                .await
+                .map_to_mm(RawTransactionError::InvalidParam)?;
+


I am curious about if we can handle nonces in a lockless way (like how it's done in TendermintCoin::seq_safe_send_raw_tx_bytes for tendermint sequences), so we can perform concurrent txs on for ETH.

Perhaps we should create a tracking issue for this topic?

Perhaps we should create a tracking issue for this topic?

#2379

onur-ozkan · 2025-03-05T10:57:54Z

mm2src/coins/eth.rs

-        wait_rpc_timeout_ms: u64,
+        wait_rpc_timeout_s: u64,
        check_every: f64,
    ) -> Web3RpcResult<Option<SignedEthTx>> {
-        let wait_until = wait_until_ms(wait_rpc_timeout_ms);
-        while now_ms() < wait_until {
+        let wait_until = wait_until_sec(wait_rpc_timeout_s);
+        while now_sec() < wait_until {


Do we have any motivation for this change? Milliseconds can be more useful for such logic flows as it can be configurable more precisely.

#2223 (comment)

onur-ozkan · 2025-03-05T11:03:30Z