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)

{
     "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"
				]
			}
		}
	}
}

Activate ETH coin (set "priv_key_policy": "WalletConnect", 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"]

…ubscriptions

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

mariocynicys · 2024-12-08T20:22:26Z

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

+        session.relay = settle.relay;
+        session.expiry = settle.expiry;
+
+        if let Some(value) = settle.session_properties {


any reason why not let settle.session_properties be of type Option<SessionProperties> instead of Option<Value>?

session_properties field varies depending on the wallet and is currently used primarily by certain wallets like Keplr. Its fields can differ across wallets, as it isn’t standardized.

We can extend this using any enum once more wallets are discovered. For now, only Keplr sends this field during session initialization afaik.

komodo-defi-framework/mm2src/kdf_walletconnect/src/session/mod.rs

Line 122 in 371af58

pub session_properties: Option<SessionProperties>,

do you mean we want to be able to discard this field if we were not able to deserialize it?
i think then the serde_json::from_str::<SessionProperties>(&value.to_string())? should be optional, i.e. we shouldn't fail (?) the whole function if we fail deserializing the arbitrary value.

p.s. we can also use serde_json::from_value instead of from_str and ditch .to_string()

#2223 (comment)

any reason why not let settle.session_properties be of type Option<SessionProperties> instead of Option<Value>?

settle.session_properties is generic I mean it can be any arbitrary data depending on the wallet of course.

so,

if session_properties isn't sent, it's fine since it's optional,

if session_properties is sent along in the request, we MUST succeed in parsing it (that means we must have an enumration of all the possible shapes it could be)

if we fail to de-serialize session_properties we will fail the request (the MUST part).

why do we need it as Option<Value> (instead of Option<SessionProperties>) if we will fail the request if we fail to deserialize it?

not all wallet will send this payload e.g metamask doesn't send but Kelpr does and maybe TrustWallet

if it's not sent we will deserialize it as None (because session_properties: Option<SessionProps>) so it's fine and exactly the same as using Option<Value>. the only diff is we let serde deser the value instead of we desering it ourselves.

another thing, WalletConnect lib shouldn't handle this data since it can't know what type it is so that's why I delegate the data deserialization to the lib user, which I assume is the right way.

LIBRARY: doesn't have any idea what data it is, so session_properties: Option<Value>
USER: have an idea of what the data type is, so Option<SessionProps>

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

mariocynicys · 2024-12-08T20:28:05Z

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

+    // Delete other sessions with same controller
+    // TODO: we might not want to do this!


Q to get more context: why do we delete sessions with the same controller?
and what does the controller mean/does?

Let's say there's already a session with Metamask wallet, any new connection with Metamask will override the existing connection.

So, I'm unsure if we should do this!

mm2src/kdf_walletconnect/src/connection_handler.rs

mm2src/kdf_walletconnect/src/session/rpc/event.rs

mm2src/crypto/Cargo.toml

mm2src/kdf_walletconnect/Cargo.toml

mariocynicys · 2024-12-09T17:07:20Z

mm2src/kdf_walletconnect/src/lib.rs

+            Some(value) => Some(serde_json::from_value(value)?),
+            None => None,
+        };
+        let (topic, url) = self.pairing.create(self.metadata.clone(), None)?;


i think then we should clean up these old pairings.

mariocynicys · 2024-12-09T17:34:55Z

mm2src/kdf_walletconnect/src/session/mod.rs

+    /// Information about the controlling party (typically a wallet).
+    pub controller: Controller,
+    /// Information about the proposing party (typically a dApp).
+    pub proposer: Proposer,


I mean the other one is always Default::default() so an enum makes sense here then we can store only one of them.

mm2src/kdf_walletconnect/src/session/rpc/update.rs

mariocynicys · 2024-12-10T08:39:47Z

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

+        session.relay = settle.relay;
+        session.expiry = settle.expiry;
+
+        if let Some(value) = settle.session_properties {


do you mean we want to be able to discard this field if we were not able to deserialize it?
i think then the serde_json::from_str::<SessionProperties>(&value.to_string())? should be optional, i.e. we shouldn't fail (?) the whole function if we fail deserializing the arbitrary value.

p.s. we can also use serde_json::from_value instead of from_str and ditch .to_string()

mm2src/kdf_walletconnect/src/storage/sqlite.rs

mm2src/kdf_walletconnect/src/connection_handler.rs

mm2src/kdf_walletconnect/src/lib.rs

mm2src/kdf_walletconnect/src/connection_handler.rs

mariocynicys · 2024-12-10T09:58:27Z

mm2src/kdf_walletconnect/src/lib.rs

+            let topic = session.topic.clone();
+            let pairing_topic = session.pairing_topic.clone();
+            debug!("[{topic}] Session found! activating");
+            self.session_manager.add_session(session);


why don't we add their pairings?

no use for storing pairings as they're only needed to activate a session and then we'll move to using session for all communication. albeit I still consider extending pairing storage just like session storage but there's not any use for it right now.

mariocynicys · 2024-12-10T10:21:48Z

mm2src/kdf_walletconnect/src/pairing.rs

+    {
+        ctx.pairing.activate(topic)?;
+    }


the extra scope not needed.
also this always returns error (check KomodoPlatform/WalletConnectRust#3 (comment))

mm2src/kdf_walletconnect/src/pairing.rs

mm2src/kdf_walletconnect/src/session/rpc/propose.rs

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

mm2src/kdf_walletconnect/src/lib.rs

mariocynicys · 2024-12-12T12:59:23Z

mm2src/kdf_walletconnect/src/lib.rs

        let irn_metadata = param.irn_metadata();
+        let ttl = irn_metadata.ttl;


we can use a timed/expirable map for this case. we do that for electrum and eth also i think. this is to avoid network-induced memory leaks.

mm2src/kdf_walletconnect/src/inbound_message.rs

mm2src/kdf_walletconnect/src/session/rpc/delete.rs

mariocynicys

i mainly went over some of old comments and resolved the ones which i can see have been updated (could use a helping hand in the remaining ones by pointing where the updates are).

my estimation right now is i would need one more all-over iteration for approval (+ old comments), but i don't wanna promise since break my promises :D

Thanks for that huge work!

mm2src/kdf_walletconnect/src/lib.rs

mariocynicys · 2024-12-25T16:29:52Z

mm2src/kdf_walletconnect/src/session/rpc/settle.rs

+        session.relay = settle.relay;
+        session.expiry = settle.expiry;
+
+        if let Some(value) = settle.session_properties {


so,

if session_properties isn't sent, it's fine since it's optional,

if session_properties is sent along in the request, we MUST succeed in parsing it (that means we must have an enumration of all the possible shapes it could be)

if we fail to de-serialize session_properties we will fail the request (the MUST part).

why do we need it as Option<Value> (instead of Option<SessionProperties>) if we will fail the request if we fail to deserialize it?

mariocynicys · 2024-12-25T16:39:09Z

mm2src/kdf_walletconnect/src/lib.rs

+
+        self.validate_chain_id(&session, chain_id)?;
+
+        // TODO: uncomment when WalletConnect wallets start listening to chainChanged event


So nothing happens(I mean wallets don't listen to this event) if we send such request

so what about just sending it for now and when wallets listen to it later we get this feat for free

borngraced · 2024-12-26T09:51:39Z

so what about just sending it for now and when wallets listen to it later we get this feat for free

Two reasons I didn't want to, this will add extra latency and corresponding wallet will return error as they don't recognize such session request

borngraced added 15 commits September 9, 2024 11:55

init, start walletconnect client impl

9100780

save dev state - walletconnect client impl

ca3f558

save dev state - WalletConnect client impl

c3dc6c6

rough implementations

0eea639

commit lock file

588316f

save dev state - handle connection close, session improvements, etc

60a2fc5

minor changes

fd8797c

fix wasm compilation

437767b

minor changes - create metadata mod

6374da3

minor changes and code organization

1c9cfe0

minor changes + merge session and session_key mod

f7987dd

minor changes to namespaces

1f2adb2

some improvements

658357f

add some session fn doc comments

98026ac

big improvements to session handling

9dddb91

borngraced self-assigned this Sep 16, 2024

borngraced added 14 commits September 17, 2024 11:27

implement session delete and cleaup

52a0f72

improve code and locking

9f5944c

remove unused dep

dff1b42

refactorings and cleanupds

591fbdb

minor changes

f6e7864

make session single

f535f0b

minor changes

3eb8969

save dev state

2d68488

implement coin activation for tendermint and other minor changes

42dd5ba

improve code and minor needed changes

edcb5a7

improve relayer disconnection, remove unneeded changes, track topic s…

e606ca4

…ubscriptions

fix tendermint pubkey derivation from walletconnect

d7b5a17

start persistent session storage implementation

3a85a17

implement sqlite session storage table and insert session method

be98c40

fix fmt

b874221

mariocynicys reviewed Dec 9, 2024

View reviewed changes

shamardy added 2.4.0-beta and removed 2.3.0-beta labels Dec 9, 2024

borngraced added 2 commits December 9, 2024 13:15

review deps

26ea297

use exponential backoff in spawn_connection_initializations reconnection

371af58

mariocynicys reviewed Dec 9, 2024

View reviewed changes

borngraced added 2 commits December 9, 2024 20:04

remove redundancy and fix nits

fdc18d7

Merge branch 'dev' into wc-integration

e3d9a9f

mariocynicys reviewed Dec 10, 2024

View reviewed changes

borngraced added 3 commits December 10, 2024 18:27

fix notes and graceful shutdown on init failure

5f47368

nits

1860776

track message via message_id

27cf3fb

mariocynicys reviewed Dec 11, 2024

View reviewed changes

mm2src/kdf_walletconnect/src/session/rpc/settle.rs Outdated Show resolved Hide resolved

mm2src/kdf_walletconnect/src/lib.rs Outdated Show resolved Hide resolved

borngraced added 3 commits December 12, 2024 00:06

impl correlated message handling for inbound messages

06e4dc7

remove println

25275e9

revert session property deserializing

89756db

mariocynicys reviewed Dec 12, 2024

View reviewed changes

borngraced added 3 commits December 12, 2024 20:20

nits

a2c7c71

Merge branch 'dev' into wc-integration

bbddec5

fix merge conflict

9db99ac

onur-ozkan added status: pending review and removed under review labels Dec 16, 2024

mariocynicys assigned mariocynicys and unassigned mariocynicys Dec 23, 2024

self review fixes

4739ec3

mariocynicys reviewed Dec 25, 2024

View reviewed changes

nits

414fda5

bump WalletConnectRust lib

f95e385

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(walletconnect): walletconnect integration #2223

feat(walletconnect): walletconnect integration #2223

borngraced commented Sep 16, 2024 •

edited by mariocynicys

Loading

mariocynicys Dec 8, 2024

borngraced Dec 9, 2024 •

edited

Loading

mariocynicys Dec 10, 2024

borngraced Dec 12, 2024

mariocynicys Dec 25, 2024

borngraced Dec 25, 2024

mariocynicys Dec 25, 2024 •

edited

Loading

borngraced Dec 25, 2024

mariocynicys Dec 25, 2024

borngraced Dec 25, 2024 •

edited

Loading

mariocynicys Dec 8, 2024

borngraced Dec 9, 2024

mariocynicys Dec 9, 2024

mariocynicys Dec 9, 2024

mariocynicys Dec 10, 2024

mariocynicys Dec 10, 2024

borngraced Dec 10, 2024 •

edited

Loading

mariocynicys Dec 10, 2024

mariocynicys Dec 12, 2024 •

edited

Loading

mariocynicys left a comment

mariocynicys Dec 25, 2024 •

edited

Loading

mariocynicys Dec 25, 2024

borngraced commented Dec 26, 2024

		// Delete other sessions with same controller
		// TODO: we might not want to do this!

		let irn_metadata = param.irn_metadata();
		let ttl = irn_metadata.ttl;


		self.validate_chain_id(&session, chain_id)?;

		// TODO: uncomment when WalletConnect wallets start listening to chainChanged event

feat(walletconnect): walletconnect integration #2223

Are you sure you want to change the base?

feat(walletconnect): walletconnect integration #2223

Conversation

borngraced commented Sep 16, 2024 • edited by mariocynicys Loading

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

Choose a reason for hiding this comment

borngraced Dec 9, 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

mariocynicys Dec 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borngraced Dec 25, 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

borngraced Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mariocynicys Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

mariocynicys left a comment

Choose a reason for hiding this comment

mariocynicys Dec 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borngraced commented Dec 26, 2024

borngraced commented Sep 16, 2024 •

edited by mariocynicys

Loading

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

borngraced Dec 9, 2024 •

edited

Loading

mariocynicys Dec 25, 2024 •

edited

Loading

borngraced Dec 25, 2024 •

edited

Loading

borngraced Dec 10, 2024 •

edited

Loading

mariocynicys Dec 12, 2024 •

edited

Loading

mariocynicys Dec 25, 2024 •

edited

Loading