feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos by borngraced · Pull Request #2223 · GLEECBTC/komodo-defi-framework

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.

Changes included:

Implemented multi-session handling for concurrent WalletConnect connections across accounts, integrates SQLite/IndexedDB for persistent session storage across devices and 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

…toml

shamardy · 2025-06-02T23:07:23Z

@smk762 this https://github.com/KomodoPlatform/komodo-defi-framework/blob/8a96e79b4a7b44eacd403f9c9522ccbf2a29c060/mm2src/coins/eth/v2_activation.rs#L170-L172 is an API breaking change. Users and GUIs have to use the below after the PR is merged.

"priv_key_policy": { "type": "ContextPrivKey" }

…tionPolicy::public_key()`

…ation

shamardy

Thanks a lot for the huge effort @borngraced. All the below comments are either questions or things that can be done later in another PR to not delay this anymore.

shamardy · 2025-06-02T23:26:40Z

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

+    let delete_request = SessionDeleteRequest {
+        code: USER_REQUESTED,
+        message: "User Disconnected".to_owned(),
+    };


Should we allow this to be passed in the request?

shamardy · 2025-06-02T23:38:17Z

mm2src/kdf_walletconnect/src/metadata.rs

+pub(crate) const RELAY_ADDRESS: &str = "wss://relay.walletconnect.com";
+pub(crate) const PROJECT_ID: &str = "86e916bcbacee7f98225dde86b697f5b";
+pub(crate) const AUTH_TOKEN_SUB: &str = "http://127.0.0.1:3000";
+pub(crate) const AUTH_TOKEN_DURATION: Duration = Duration::from_secs(5 * 60 * 60);
+pub(crate) const APP_NAME: &str = "Komodefi Framework";
+pub(crate) const APP_DESCRIPTION: &str = "WallectConnect Komodefi Framework Playground";
+
+#[inline]
+pub(crate) fn generate_metadata() -> Metadata {
+    Metadata {
+        description: APP_DESCRIPTION.to_owned(),
+        url: AUTH_TOKEN_SUB.to_owned(),
+        icons: vec!["https://avatars.githubusercontent.com/u/21276113?s=200&v=4".to_owned()],
+        name: APP_NAME.to_owned(),
+    }


These should be part of the external wallet initialization request in this PR #2411

shamardy · 2025-06-02T23:46:16Z

mm2src/coins/eth/wallet_connect.rs

+    wc.validate_update_active_chain_id(session_topic, &chain_id).await?;
+
+    let (account_str, _) = wc.get_account_and_properties_for_chain_id(session_topic, &chain_id)?;
+    let message = "Authenticate with Komodefi";


It should be part of the request instead, so whitelabels and GUIs can place their own messages. Can be done in another PR though.

shamardy · 2025-06-03T01:48:41Z

mm2src/coins/tendermint/wallet_connect.rs

+    async fn wc_send_tx<'a>(
+        &self,
+        _ctx: &WalletConnectCtx,
+        _params: Self::Params<'a>,
+    ) -> Result<Self::SendTxData, Self::Error> {
+        todo!()
+    }


I see that we are not using this, so not a priority to implement in this PR but this comment so that I can remember all the todos.

shamardy · 2025-06-03T02:25:07Z

mm2src/kdf_walletconnect/src/inbound_message.rs

+        Params::SessionRequest(_param) => {
+            // TODO: Implement when integrating KDF as a Dapp.
+            return MmError::err(WalletConnectError::NotImplemented);
+        },


Isn't this PR an implementation of KDF as a Dapp? A better note would be that this in not needed for our current usecases.

Yes it is. As a Dapp

shamardy · 2025-06-03T02:39:06Z

mm2src/kdf_walletconnect/src/lib.rs

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


This can be done in another PR

shamardy · 2025-06-03T02:51:57Z

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

+            };
+        },
+        "accountsChanged" => {
+            // TODO: Handle accountsChanged event logic.


I guess we need this implemented in next PRs. Will add it to the issue checklist, this should be done by disabling and enabling the coin again with a different pubkey.

* dev: feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos (#2223) feat(ibc-routing-part-1): supporting entire Cosmos network for swaps (#2459) fix(test): fix HD Wallet message signing tests (#2474) improvement(builds): enable static CRT linking for MSVC builds (#2464) feat(wallet): implement HD multi-address support for message signing (#2432)

smk762 · 2025-06-04T09:03:08Z

@smk762 this

https://github.com/KomodoPlatform/komodo-defi-framework/blob/8a96e79b4a7b44eacd403f9c9522ccbf2a29c060/mm2src/coins/eth/v2_activation.rs#L170-L172

is an API breaking change. Users and GUIs have to use the below after the PR is merged.
"priv_key_policy": { "type": "ContextPrivKey" }

Existing docs for wallet connect suggest using

      "priv_key_policy": {
        "wallet_connect": {
          "session_topic": "3569914dd09a5cc4ac92dedab354f06ff5db17ef616233a8ba562cbea51269fd"
        }
      }

Is it correct to assume the following?

"priv_key_policy": { "type": "ContextPrivKey" } is only for non-WalletConnect activations.
`"priv_key_policy":"Trezor" & "priv_key_policy":"Metamask" are still valid options.
"priv_key_policy" is now a required field (if not, please specify the default)
"priv_key_policy" being a required field only applies to v2 ETH activation methods (enable_eth_with_tokens and task::enable_eth::init), and not to tendermint or other v2 activation methods.
"priv_key_policy" being a required field does not apply to any v1 activation methods

* lr-swap-wip: (37 commits) fix custom token error name fix getting chain_id from protocol_data refactor (review): use dedicated large error cfg, add new fn to FromApiValueError, fix TODO, use experimental namespace for lr rpc, more Ticker alias feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos (GLEECBTC#2223) feat(ibc-routing-part-1): supporting entire Cosmos network for swaps (GLEECBTC#2459) fix(test): fix HD Wallet message signing tests (GLEECBTC#2474) improvement(builds): enable static CRT linking for MSVC builds (GLEECBTC#2464) feat(wallet): implement HD multi-address support for message signing (GLEECBTC#2432) fix(p2pk): validate expected pubkey correctly for p2pk inputs (GLEECBTC#2408) chore(docs): update old urls referencing atomicdex or old docs pages (GLEECBTC#2428) improvement(p2p): remove hardcoded seeds (GLEECBTC#2439) fix(evm-api): find enabled erc20 token using platform ticker (GLEECBTC#2445) chore(docs): add DeepWiki badge to README (GLEECBTC#2463) chore(core): organize deps using workspace.dependencies (GLEECBTC#2449) feat(db-arch): more dbdir to address_dir replacements (GLEECBTC#2398) chore(build-artifacts): remove duplicated mm2 build artifacts (GLEECBTC#2448) feat(pubkey-banning): expirable bans (GLEECBTC#2455) fix(eth-balance-events): serialize eth address using AddrToString (GLEECBTC#2440) chore(deps): remove base58 and replace it completely with bs58 (GLEECBTC#2427) feat(tron): initial groundwork for full TRON integration (GLEECBTC#2425) ...

* dev: (30 commits) chore(core): replace hash_raw_entry with stable entry() API (GLEECBTC#2473) chore(core): adapt `MmError` and usages for compatibility with new rustc versions (GLEECBTC#2443) feat(wallet): add `delete_wallet` RPC (GLEECBTC#2497) chore(release): add changelog entries for v2.5.0-beta (GLEECBTC#2494) chore(release): bump kdf version to 2.5.0-beta (GLEECBTC#2492) feat(tests): zcoin unit test to validate dex fee (GLEECBTC#2460) fix(zcoin): correctly track unconfirmed z-coin notes (GLEECBTC#2331) improvement(orders): remove BTC specific volume from min_trading_vol logic (GLEECBTC#2483) feat(ibc-routing-part-2): supporting entire Cosmos network for swaps (GLEECBTC#2476) fix(startup): don't initialize WalletConnect during startup (GLEECBTC#2485) fix(dns): better ip resolution (GLEECBTC#2487) improvement(event-streaming): strong type streamer IDs (GLEECBTC#2441) bump timed-map to `1.4.1` (GLEECBTC#2481) improvement(RPC): unified interface for legacy and current RPC interfaces (GLEECBTC#2450) improvement(tendermint): `tendermint_tx_internal_id` helper (GLEECBTC#2438) feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos (GLEECBTC#2223) feat(ibc-routing-part-1): supporting entire Cosmos network for swaps (GLEECBTC#2459) fix(test): fix HD Wallet message signing tests (GLEECBTC#2474) improvement(builds): enable static CRT linking for MSVC builds (GLEECBTC#2464) feat(wallet): implement HD multi-address support for message signing (GLEECBTC#2432) ... # Conflicts: # mm2src/coins/qrc20.rs # mm2src/mm2_main/src/lp_swap/maker_swap.rs

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 and others added 6 commits May 30, 2025 15:16

Merge branch 'dev' into wc-integration

8a96e79

Merge branch 'dev' into wc-integration

1cacec5

Merge branch 'dev' into wc-integration

9705a42

Add todos about using walletconnect with tron

6476400

fix typos

d7ba61d

Remove unused 'package = "futures"' key from kdf_walletconnect/Cargo.…

a8407ab

…toml

shamardy added the breaking-change: RPC label Jun 2, 2025

shamardy added 6 commits June 3, 2025 02:15

Switch test RPC requests to use type tag with eth priv_key_policy

e3cbc70

fix test_electrum_rpc_client_error

69ea07c

Make sign message Authenticate with KDF

6e35290

Implement public key getting for WalletConnect in `TendermintActiva…

be87d65

…tionPolicy::public_key()`

tendermint: make wallet_type parameter non-optional in coin initializ…

6fd331a

…ation

rename handler name from "Komodefi" to "KDF"

2e4ef04

shamardy approved these changes Jun 3, 2025

View reviewed changes

shamardy changed the title ~~feat(walletconnect): walletconnect integration~~ feat(walletconnect): add WalletConnect v2 support for Ethereum and Cosmos coins Jun 3, 2025

shamardy changed the title ~~feat(walletconnect): add WalletConnect v2 support for Ethereum and Cosmos coins~~ feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos Jun 3, 2025

shamardy merged commit 9ccb42f into dev Jun 3, 2025
33 of 34 checks passed

shamardy deleted the wc-integration branch June 3, 2025 03:21

shamardy mentioned this pull request Jun 3, 2025

Make Komodefi compatible with wallet connect #1543

Open

shamardy mentioned this pull request Jun 16, 2025

chore(release): v2.5.0-beta #2491

Merged

mariocynicys mentioned this pull request Jun 23, 2025

feat(wallet-connect): impl BTC (UTxO) activation via WalletConnect #2499

Merged

This was referenced Jul 2, 2025

Unexpected error with WalletConnect ETH activation #2518

Open

WalletConnect Tendermint session chains are null, unable to activate #2519

Open

smk762 mentioned this pull request Aug 4, 2025

fix(Trezor): fix utxo and eth calls due to firmware changes #2565

Merged

onur-ozkan mentioned this pull request Sep 18, 2025

feat(protocol): [2] solana support #2622

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos#2223

feat(walletconnect): add WalletConnect v2 support for EVM and Cosmos#2223
shamardy merged 246 commits intodevfrom
wc-integration

borngraced commented Sep 16, 2024 •

edited

Loading

Uh oh!

shamardy commented Jun 2, 2025

Uh oh!

shamardy left a comment

Uh oh!

shamardy Jun 2, 2025

Uh oh!

shamardy Jun 2, 2025

Uh oh!

shamardy Jun 2, 2025

Uh oh!

shamardy Jun 3, 2025

Uh oh!

shamardy Jun 3, 2025

Uh oh!

borngraced Jun 3, 2025 •

edited

Loading

Uh oh!

shamardy Jun 3, 2025

Uh oh!

shamardy Jun 3, 2025

Uh oh!

Uh oh!

smk762 commented Jun 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants


		self.validate_chain_id(&session, chain_id)?;

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

Conversation

borngraced commented Sep 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

New RPC Methods

New connection

Get/Retrieve Walletconnect session(s)

Ping Walletconnect session

Delete Walletconnect session

Active ETH/ERC

Active Tendermint/Cosmos

Uh oh!

shamardy commented Jun 2, 2025

Uh oh!

shamardy left a comment

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 2, 2025

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

borngraced Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

shamardy Jun 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

smk762 commented Jun 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

borngraced commented Sep 16, 2024 •

edited

Loading

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

borngraced Jun 3, 2025 •

edited

Loading