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

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

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

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 wont't recognize such session request

…oins

…alletconnect

mariocynicys

Thanks for the changes! Here are my last notes.

Will follow up with the changes and approve once we covered/discussed all the important comments.

mariocynicys · 2025-01-09T12:24:35Z

mm2src/coins/tendermint/wallet_connect.rs

+        Value::Object(map) => map
+            .iter()
+            .enumerate()
+            .map(|(_, (_, value))| {


we don't use the enumuration indices nor the map iter keys.
so we can replace map.iter().enumerate().map(|(index, (key, value))| {}) by map.value().map(|value| {}).

mariocynicys · 2025-01-09T12:24:52Z

mm2src/coins/tendermint/wallet_connect.rs

+                    .as_u64()
+                    .ok_or_else(|| serde::de::Error::custom("Invalid byte value"))
+                    .and_then(|n| {
+                        if n <= 255 {


better replace 255 with u8::MAX

n is still of type u64 so we can't assert n <= u8::MAX unless we explicitly cast n to u8 which isn't something we want to do.

mariocynicys · 2025-01-09T12:45:30Z

mm2src/kdf_walletconnect/src/lib.rs

+        let (topic, url) = self.pairing.create(self.metadata.clone(), None)?;
+
+        info!("[{topic}] Subscribing to topic");


let's leave a todo here about cleaning up expired pairings that were abandoned.

what if we leave deleting expired session to the users? enough decentralizations...xd

mariocynicys · 2025-01-09T13:01:12Z

mm2src/kdf_walletconnect/src/session/mod.rs

+
+    pub(crate) fn get_sessions_full(&self) -> impl Iterator<Item = Session> { self.read().clone().into_values() }
+


nit: we can return only the pairs of session topics and controllers

idea, I will come back to this...

mariocynicys · 2025-01-09T13:07:10Z

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

+    {
+        let mut session = ctx.session_manager.write();
+        let Some(session) = session.get_mut(topic) else {
+            return MmError::err(WalletConnectError::SessionError(format!("No session found for topic: {topic}")));
+        };
+        session.namespaces = settle.namespaces.0;
+        session.controller = settle.controller.clone();
+        session.relay = settle.relay;
+        session.expiry = settle.expiry;
+
+        if let Some(value) = settle.session_properties {
+            let session_properties = serde_json::from_value::<SessionProperties>(value)?;
+            session.session_properties = Some(session_properties);
+        };
+    };
+
+    //  Update storage session.
+    let session = ctx
+        .session_manager
+        .get_session(topic)
+        .ok_or(MmError::new(WalletConnectError::SessionError(format!(
+            "session not found topic: {topic}"
+        ))))?;


nit: we could unscope the codeblock above so not to have to query get_session one more time.

the scope for session update is on purpose since we can't hold an await over a sync RwLock, Mutex guard...the most obvious fix is the current arrangement..another fix would be using async mutex

/// Process session settle request. pub(crate) async fn reply_session_settle_request( ctx: &WalletConnectCtxImpl, topic: &Topic, settle: SessionSettleRequest, ) -> MmResult<(), WalletConnectError> { let mut sessions = ctx.session_manager.write(); let Some(session) = sessions.get_mut(topic) else { return MmError::err(WalletConnectError::SessionError(format!("No session found for topic: {topic}"))); }; session.namespaces = settle.namespaces.0; session.controller = settle.controller.clone(); session.relay = settle.relay; session.expiry = settle.expiry; if let Some(value) = settle.session_properties { let session_properties = serde_json::from_value::<SessionProperties>(value)?; session.session_properties = Some(session_properties); }; let session = session.clone(); drop(sessions); ctx.session_manager .storage() .update_session(&session) .await .mm_err(|err| WalletConnectError::StorageError(err.to_string()))?; info!("[{topic}] Session successfully settled for topic"); // Delete other sessions with same controller // NOTE: we might not want to do this! let all_sessions = ctx.session_manager.get_sessions_full(); for session in all_sessions { if session.controller == settle.controller && session.topic.as_ref() != topic.as_ref() { ctx.drop_session(&session.topic).await?; debug!("[{}] session deleted", session.topic); } } Ok(()) }

that's what i am suggesting, to drop the mutex before awaiting.
that said, this doesn't compile for some reason that i don't comprehend (still thinks sessions variable is inscope for some reason).

/// Process session settle request. pub(crate) async fn reply_session_settle_request( ctx: &WalletConnectCtxImpl, topic: &Topic, settle: SessionSettleRequest, ) -> MmResult<(), WalletConnectError> { let session = { let mut sessions = ctx.session_manager.write(); let Some(session) = sessions.get_mut(topic) else { return MmError::err(WalletConnectError::SessionError(format!("No session found for topic: {topic}"))); }; session.namespaces = settle.namespaces.0; session.controller = settle.controller.clone(); session.relay = settle.relay; session.expiry = settle.expiry; if let Some(value) = settle.session_properties { let session_properties = serde_json::from_value::<SessionProperties>(value)?; session.session_properties = Some(session_properties); }; session.clone() }; ctx.session_manager .storage() .update_session(&session) .await .mm_err(|err| WalletConnectError::StorageError(err.to_string()))?; info!("[{topic}] Session successfully settled for topic"); // Delete other sessions with same controller // NOTE: we might not want to do this! let all_sessions = ctx.session_manager.get_sessions_full(); for session in all_sessions { if session.controller == settle.controller && session.topic.as_ref() != topic.as_ref() { ctx.drop_session(&session.topic).await?; debug!("[{}] session deleted", session.topic); } } Ok(()) }

a working sol

I avoided this because I didn't want to clone.
Actually I think I should have kept the async mutex I used earlier....cloning here is just an unnecessary overhead IMO.

updated bb73b1f

I avoided this because I didn't want to clone.

calling get_session does already clone. also serializing this to the DB probably clone as well. that's a tiny overhead anyways.

Actually I think I should have kept the async mutex I used earlier....cloning here is just an unnecessary overhead IMO.

Not at all 😂, having that mutex async just locks the mutex way more than needed, degrading pref. Also being sync guards us in compile time from very nasty mistakes (e.g. forgetting to release the mutex before awaiting on a network request, and boom, you have a disaster of a synchronization mutex).

mariocynicys · 2025-01-09T13:40:27Z

mm2src/kdf_walletconnect/src/lib.rs

+    message_id_generator: MessageIdGenerator,
+    pending_requests: Mutex<HashMap<MessageId, oneshot::Sender<SessionMessageType>>>,
+    abortable_system: AbortableQueue,


we should really make pending_requests a timed map.

request handles which we don't get a response for will reside in the map forever

mariocynicys · 2025-01-09T13:57:32Z

mm2src/kdf_walletconnect/src/session/mod.rs

+struct SessionManagerImpl {
+    /// The currently active session topic.
+    active_topic: Mutex<Option<Topic>>,
+    /// A thread-safe map of sessions indexed by topic.
+    sessions: Arc<RwLock<HashMap<Topic, Session>>>,
+    pub(crate) storage: SessionStorageDb,
+}


with the latest changes, i don't think we need active_topic any more.

removed active_topic and active_sesson.

mariocynicys · 2025-01-09T13:57:51Z

mm2src/kdf_walletconnect/src/session/mod.rs

+    /// Get active session topic or return error if no session has been activated.
+    pub fn get_active_topic_or_err(&self) -> MmResult<Topic, WalletConnectError> {
+        self.0
+            .active_topic
+            .lock()
+            .unwrap()
+            .clone()
+            .ok_or(MmError::new(WalletConnectError::SessionError(
+                "No active session".to_owned(),
+            )))
+    }
+


and this method is never used.

mariocynicys · 2025-01-09T14:00:49Z

mm2src/coins_activation/src/tendermint_with_assets_activation.rs

+    let wallet_type = if wc.is_ledger_connection() {
+        TendermintWalletConnectionType::WcLedger(session_topic)
+    } else {


we should check weather this session topic is a ledger connection and not the active session (and should remove the active session field anyway)

mariocynicys · 2025-01-09T14:11:16Z

mm2src/coins/tendermint/wallet_connect.rs

+        wc.send_session_request_and_wait(session_topic, &chain_id, method, params, |data: CosmosTxSignedData| {
            let signature = general_purpose::STANDARD
                .decode(data.signature.signature)
                .map_to_mm(|err| WalletConnectError::PayloadError(err.to_string()))?;


why do we provide callback as the last args? why not get the return value and do the callback here?
doesn't seem intuitive

I don't want to use WalletConnect lib in coin mod... also taking callback as last args seems practical
https://stackoverflow.com/a/41394746

I don't want to use WalletConnect lib in coin mod

How is that using walletconnect lib in coins crate? the callback is used at the very end of send_session_request_and_wait, it could just be taken out.

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

borngraced added 2 commits December 10, 2024 19:29

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

borngraced added 9 commits December 26, 2024 12:38

bump WalletConnectRust lib

f95e385

save dev state - implement dynamic session management for activated c…

dd1a842

…oins

complete coin with session topic

4dd315a

improve and remove redundancy session_properties call in tendermint w…

3b07397

…alletconnect

minor changes

5b4838d

marge with dev

7124b4f

revert metadata to fn

2243c9d

move u256_to_hex fn to common mod and minor changes

1a8f243

replace EthPrivKeyActivationPolicy name for WC des

020ecb8

mariocynicys reviewed Jan 9, 2025

View reviewed changes

borngraced added 2 commits January 9, 2025 17:18

remove active_session/topic and some other minor changes

432b056

reduce lookup for session in session/settle.rs

bb73b1f

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 12, 2024 •

edited

Loading

mariocynicys left a comment

mariocynicys Dec 25, 2024

borngraced commented Dec 26, 2024 •

edited

Loading

mariocynicys left a comment

mariocynicys Jan 9, 2025

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025 •

edited

Loading

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025

mariocynicys Jan 10, 2025

mariocynicys Jan 10, 2025

borngraced Jan 12, 2025 •

edited

Loading

mariocynicys Jan 13, 2025

mariocynicys Jan 9, 2025

borngraced Jan 12, 2025

mariocynicys Jan 13, 2025

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025

mariocynicys Jan 9, 2025

borngraced Jan 12, 2025

mariocynicys Jan 9, 2025

borngraced Jan 9, 2025

mariocynicys Jan 13, 2025

		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

		let (topic, url) = self.pairing.create(self.metadata.clone(), None)?;

		info!("[{topic}] Subscribing to topic");


		pub(crate) fn get_sessions_full(&self) -> impl Iterator<Item = Session> { self.read().clone().into_values() }

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)

mariocynicys Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

mariocynicys left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borngraced commented Dec 26, 2024 • edited Loading

mariocynicys left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borngraced Jan 9, 2025 • 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

borngraced Jan 12, 2025 • 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

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 commented Sep 16, 2024 •

edited by mariocynicys

Loading

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

mariocynicys Dec 12, 2024 •

edited

Loading

borngraced commented Dec 26, 2024 •

edited

Loading

borngraced Jan 9, 2025 •

edited

Loading

borngraced Jan 12, 2025 •

edited

Loading