feat: migrate keplr to the hub

Author: arlert-armin

wallets/provider-all/src/index.ts

@@ -16,7 +16,7 @@ import { versions as enkrypt } from '@rango-dev/provider-enkrypt';
 import { versions as exodus } from '@rango-dev/provider-exodus';
 import * as frontier from '@rango-dev/provider-frontier';
 import * as halo from '@rango-dev/provider-halo';
-import * as keplr from '@rango-dev/provider-keplr';
+import { versions as keplr } from '@rango-dev/provider-keplr';
 import * as leapCosmos from '@rango-dev/provider-leap-cosmos';
 import { versions as ledger } from '@rango-dev/provider-ledger';
 import * as mathwallet from '@rango-dev/provider-math-wallet';
@@ -103,7 +103,7 @@ export const allProviders = (
     metamask,
     lazyProvider(legacyProviderImportsToVersionsInterface(walletconnect2)),
     lazyProvider(legacyProviderImportsToVersionsInterface(tonconnect)),
-    lazyProvider(legacyProviderImportsToVersionsInterface(keplr)),
+    keplr,
     phantom,
     lazyProvider(legacyProviderImportsToVersionsInterface(ready)),
     lazyProvider(legacyProviderImportsToVersionsInterface(tronLink)),

wallets/provider-keplr/package.json

@@ -3,18 +3,19 @@
   "version": "0.54.2-next.3",
   "license": "MIT",
   "type": "module",
-  "source": "./src/index.ts",
-  "main": "./dist/index.js",
+  "source": "./src/mod.ts",
+  "main": "./dist/mod.js",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/mod.js",
+    "./lib": "./dist/lib.js"
   },
-  "typings": "dist/index.d.ts",
+  "typings": "dist/mod.d.ts",
   "files": [
     "dist",
     "src"
   ],
   "scripts": {
-    "build": "node ../../scripts/build/command.mjs --path wallets/provider-keplr",
+    "build": "node ../../scripts/build/command.mjs --path wallets/provider-keplr --inputs src/mod.ts",
     "ts-check": "tsc --declaration --emitDeclarationOnly -p ./tsconfig.json",
     "clean": "rimraf dist",
     "format": "prettier --write '{.,src}/**/*.{ts,tsx}'",
@@ -24,6 +25,7 @@
     "@rango-dev/signer-cosmos": "^0.38.0",
     "@rango-dev/wallets-core": "^0.53.1-next.2",
     "@rango-dev/wallets-shared": "^0.54.2-next.3",
+    "@chain-registry/keplr": "^2.0.110",
     "rango-types": "^0.1.89"
   },
   "devDependencies": {
@@ -35,4 +37,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}

wallets/provider-keplr/readme.md

@@ -1 +1,24 @@
-# @rango-dev/provider-keplr
+# Keplr
+Keplr integration for hub.  
+[Homepage](https://www.keplr.app/) | [Docs](https://docs.keplr.app/)
+
+More about implementation status can be found [here](../readme.md).
+
+## Implementation notes/limitations
+
+### Group
+
+#### 🚧 EVM (Not Implemented)
+Keplr also provides support for **EVM networks**, but  
+**EVM is not implemented** in the current integration.
+
+### Feature
+
+#### ⚠️ Auto Connect
+Keplr does **not provide any eager-connect (silent connection) mechanism**.  
+A manual connection flow is required every time.
+
+
+---
+
+More wallet information can be found in [readme.md](../readme.md).

wallets/provider-keplr/src/actions/cosmos.ts

@@ -0,0 +1,53 @@
+import type { Context, FunctionWithContext } from '@rango-dev/wallets-core';
+
+import { chainRegistryChainToKeplr } from '@chain-registry/keplr';
+import {
+  type CosmosActions,
+  type ProviderAPI,
+  utils,
+} from '@rango-dev/wallets-core/namespaces/cosmos';
+
+import { getCosmosAccounts } from '../utils.js';
+
+function connect(
+  instance: () => ProviderAPI
+): FunctionWithContext<CosmosActions['connect'], Context> {
+  return async (context, options) => {
+    // Setting connect args to be used on other actions
+    const [, setState] = context.state();
+    setState('connectArgs', { options });
+    const cosmosInstance = instance();
+    if (!cosmosInstance) {
+      throw new Error(
+        'Do your wallet injected correctly and is cosmos compatible?'
+      );
+    }
+    if (!options?.chainIds) {
+      throw new Error(
+        'Passing chainIds meta to the connect options is mandatory'
+      );
+    }
+
+    const providerAccounts = await getCosmosAccounts(
+      cosmosInstance,
+      options.chainIds,
+      options.customChainIds
+    );
+    return utils.formatAccountsToCAIP(providerAccounts);
+  };
+}
+function suggest(
+  instance: () => ProviderAPI
+): FunctionWithContext<CosmosActions['suggest'], Context> {
+  return async (_context, chain, assetList) => {
+    const cosmosInstance = instance();
+    if (!cosmosInstance) {
+      throw new Error(
+        'Is your wallet injected correctly and cosmos compatible?'
+      );
+    }
+    const experimentalChain = chainRegistryChainToKeplr(chain, [assetList]);
+    return await cosmosInstance.experimentalSuggestChain(experimentalChain);
+  };
+}
+export const cosmosActions = { connect, suggest };

wallets/provider-keplr/src/builders/cosmos.ts

@@ -0,0 +1,31 @@
+import type {
+  CosmosActions,
+  ProviderAPI,
+} from '@rango-dev/wallets-core/namespaces/cosmos';
+
+import { ChangeAccountSubscriberBuilder } from '@rango-dev/wallets-core/namespaces/common';
+import { utils } from '@rango-dev/wallets-core/namespaces/cosmos';
+
+// Hooks
+const changeAccountSubscriber = (getInstance: () => ProviderAPI) =>
+  new ChangeAccountSubscriberBuilder<Event, ProviderAPI, CosmosActions>()
+    .getInstance(getInstance)
+    .onSwitchAccount((event, context) => {
+      const [getState] = context.state();
+      event.preventDefault();
+      const connectArgs = getState('connectArgs');
+      if (!connectArgs) {
+        throw new Error('Connect args are empty');
+      }
+      context.action('disconnect');
+      context.action('connect', connectArgs.options);
+    })
+    .format(async (_, __) => utils.formatAccountsToCAIP([]))
+    .addEventListener((_, callback) => {
+      window.addEventListener('keplr_keystorechange', callback);
+    })
+    .removeEventListener((_, callback) => {
+      window.removeEventListener('keplr_keystorechange', callback);
+    });
+
+export const cosmosBuilders = { changeAccountSubscriber };

wallets/provider-keplr/src/constants.ts

@@ -0,0 +1,41 @@
+import { type ProviderMetadata } from '@rango-dev/wallets-core';
+import { type BlockchainMeta, cosmosBlockchains } from 'rango-types';
+
+import getSigners from './signer.js';
+import { getInstanceOrThrow } from './utils.js';
+
+export const WALLET_ID = 'keplr';
+
+export const metadata: ProviderMetadata = {
+  name: 'Keplr',
+  icon: 'https://raw.githubusercontent.com/rango-exchange/assets/main/wallets/keplr/icon.svg',
+  extensions: {
+    chrome:
+      'https://chrome.google.com/webstore/detail/keplr/dmkamcknogkgcdfhhbddcghachkejeap',
+    brave:
+      'https://chrome.google.com/webstore/detail/keplr/dmkamcknogkgcdfhhbddcghachkejeap',
+    firefox: 'https://addons.mozilla.org/en-US/firefox/addon/keplr',
+    homepage: 'https://www.keplr.app',
+  },
+  properties: [
+    {
+      name: 'namespaces',
+      value: {
+        selection: 'multiple',
+        data: [
+          {
+            label: 'Cosmos',
+            value: 'Cosmos',
+            id: 'Cosmos',
+            getSupportedChains: (allBlockchains: BlockchainMeta[]) =>
+              cosmosBlockchains(allBlockchains),
+          },
+        ],
+      },
+    },
+    {
+      name: 'signers',
+      value: { getSigners: async () => getSigners(getInstanceOrThrow()) },
+    },
+  ],
+};

wallets/provider-keplr/src/helpers.ts

@@ -0,0 +1,2 @@
+export { cosmosActions as keplrCosmosActions } from './actions/cosmos.js';
+export { getCosmosAccounts as keplrGetCosmosAccounts } from './utils.js';

wallets/provider-keplr/src/index.ts

@@ -0,0 +1,8 @@
+import { defineVersions } from '@rango-dev/wallets-core/utils';
+
+import { buildProvider } from './provider.js';
+
+const versions = () =>
+  defineVersions().version('1.0.0', buildProvider()).build();
+
+export { versions };