chore: move namespaces info to provider and remove the hardcoded mapp…

…ing in wallets-shared
rango-exchange · Dec 15, 2024 · a6d4c11 · a6d4c11
1 parent 52953ea
commit a6d4c11
Show file tree

Hide file tree

Showing 11 changed files with 165 additions and 37 deletions.
diff --git a/wallets/core/src/hub/store/providers.ts b/wallets/core/src/hub/store/providers.ts
@@ -1,5 +1,5 @@
+import type { Namespace } from '../../namespaces/common/types.js';
 import type { State as InternalProviderState } from '../provider/mod.js';
-import type { CommonNamespaceKeys } from '../provider/types.js';
 import type { StateCreator } from 'zustand';
 
 import { produce } from 'immer';
@@ -8,7 +8,7 @@ import { guessProviderStateSelector, type State } from './mod.js';
 
 type Browsers = 'firefox' | 'chrome' | 'edge' | 'brave' | 'homepage';
 type Property<N extends string, V> = { name: N; value: V };
-type DetachedInstances = Property<'detached', CommonNamespaceKeys[]>;
+type DetachedInstances = Property<'detached', Namespace[]>;
 
 export type ProviderInfo = {
   name: string;

diff --git a/wallets/core/src/legacy/types.ts b/wallets/core/src/legacy/types.ts
@@ -81,6 +81,24 @@ export type InstallObjects = {
   DEFAULT: string;
 };
 
+interface NeedsNamespace {
+  selection: 'single' | 'multiple';
+  data: {
+    label: string;
+    id: string;
+    value: Namespace;
+  }[];
+}
+
+interface NeedsDerivationPath {
+  data: {
+    id: string;
+    label: string;
+    namespace: Namespace;
+    generateDerivationPath: (index: string) => string;
+  }[];
+}
+
 export type WalletInfo = {
   name: string;
   img: string;
@@ -93,9 +111,9 @@ export type WalletInfo = {
   showOnMobile?: boolean;
   isContractWallet?: boolean;
   mobileWallet?: boolean;
-  namespaces?: Namespace[];
-  singleNamespace?: boolean;
-  needsDerivationPath?: boolean;
+
+  needsDerivationPath?: NeedsDerivationPath;
+  needsNamespace?: NeedsNamespace;
 };
 
 export type State = {

diff --git a/wallets/provider-ledger/src/index.ts b/wallets/provider-ledger/src/index.ts
@@ -93,9 +93,56 @@ export const getWalletInfo: (allBlockChains: BlockchainMeta[]) => WalletInfo = (
     },
     color: 'black',
     supportedChains,
-    namespaces: ['EVM', 'Solana'],
-    singleNamespace: true,
     showOnMobile: false,
-    needsDerivationPath: true,
+    needsDerivationPath: {
+      data: [
+        {
+          id: 'metamask',
+          label: `Metamask (m/44'/60'/0'/0/index)`,
+          namespace: 'EVM',
+          generateDerivationPath: (index: string) => `44'/60'/0'/0/${index}`,
+        },
+        {
+          id: 'ledgerLive',
+          label: `LedgerLive (m/44'/60'/index'/0/0)`,
+          namespace: 'EVM',
+          generateDerivationPath: (index: string) => `44'/60'/${index}'/0/0`,
+        },
+        {
+          id: 'legacy',
+          label: `Legacy (m/44'/60'/0'/index)`,
+          namespace: 'EVM',
+          generateDerivationPath: (index: string) => `44'/60'/0'/${index}`,
+        },
+        {
+          id: `(m/44'/501'/index')`,
+          label: `(m/44'/501'/index')`,
+          namespace: 'Solana',
+          generateDerivationPath: (index: string) => `44'/501'/${index}'`,
+        },
+        {
+          id: `(m/44'/501'/0'/index)`,
+          label: `(m/44'/501'/0'/index)`,
+          namespace: 'Solana',
+          generateDerivationPath: (index: string) => `44'/501'/0'/${index}`,
+        },
+      ],
+    },
+
+    needsNamespace: {
+      selection: 'single',
+      data: [
+        {
+          label: 'EVM',
+          value: 'EVM',
+          id: 'Ethereum',
+        },
+        {
+          label: 'Solana',
+          value: 'Solana',
+          id: 'Solana',
+        },
+      ],
+    },
   };
 };
diff --git a/wallets/provider-phantom/src/constants.ts b/wallets/provider-phantom/src/constants.ts
@@ -20,7 +20,7 @@ export const info: ProviderInfo = {
     {
       name: 'detached',
       // if you are adding a new namespace, don't forget to also update `getWalletInfo`
-      value: ['solana', 'evm'],
+      value: ['Solana', 'EVM'],
     },
   ],
 };
diff --git a/wallets/provider-phantom/src/legacy/index.ts b/wallets/provider-phantom/src/legacy/index.ts
@@ -107,6 +107,22 @@ export const getWalletInfo: (allBlockChains: BlockchainMeta[]) => WalletInfo = (
         EVM_SUPPORTED_CHAINS.includes(chain.name as Networks)
       ),
     ],
+
+    needsNamespace: {
+      selection: 'single',
+      data: [
+        {
+          label: 'EVM',
+          value: 'EVM',
+          id: 'Ethereum',
+        },
+        {
+          label: 'Solana',
+          value: 'Solana',
+          id: 'Solana',
+        },
+      ],
+    },
   };
 };
 

diff --git a/wallets/provider-trezor/src/index.ts b/wallets/provider-trezor/src/index.ts
@@ -87,6 +87,7 @@ export const getWalletInfo: (allBlockChains: BlockchainMeta[]) => WalletInfo = (
   if (ethereumBlockchain) {
     supportedChains.push(ethereumBlockchain);
   }
+
   return {
     name: 'Trezor',
     img: 'https://raw.githubusercontent.com/rango-exchange/assets/main/wallets/trezor/icon.svg',
@@ -95,9 +96,51 @@ export const getWalletInfo: (allBlockChains: BlockchainMeta[]) => WalletInfo = (
     },
     color: 'black',
     supportedChains,
-    namespaces: ['EVM'],
-    singleNamespace: true,
     showOnMobile: false,
-    needsDerivationPath: true,
+
+    needsNamespace: {
+      selection: 'single',
+      data: [
+        {
+          id: 'EVM',
+          value: 'EVM',
+          label: 'Ethereum',
+        },
+      ],
+    },
+    needsDerivationPath: {
+      data: [
+        {
+          id: 'metamask',
+          label: `Metamask (m/44'/60'/0'/0/index)`,
+          namespace: 'EVM',
+          generateDerivationPath: (index: string) => `44'/60'/0'/0/${index}`,
+        },
+        {
+          id: 'ledgerLive',
+          label: `LedgerLive (m/44'/60'/index'/0/0)`,
+          namespace: 'EVM',
+          generateDerivationPath: (index: string) => `44'/60'/${index}'/0/0`,
+        },
+        {
+          id: 'legacy',
+          label: `Legacy (m/44'/60'/0'/index)`,
+          namespace: 'EVM',
+          generateDerivationPath: (index: string) => `44'/60'/0'/${index}`,
+        },
+        {
+          id: `(m/44'/501'/index')`,
+          label: `(m/44'/501'/index')`,
+          namespace: 'Solana',
+          generateDerivationPath: (index: string) => `44'/501'/${index}'`,
+        },
+        {
+          id: `(m/44'/501'/0'/index)`,
+          label: `(m/44'/501'/0'/index)`,
+          namespace: 'Solana',
+          generateDerivationPath: (index: string) => `44'/501'/0'/${index}`,
+        },
+      ],
+    },
   };
 };
diff --git a/widget/embedded/src/components/ConfirmWalletsModal/WalletList.tsx b/widget/embedded/src/components/ConfirmWalletsModal/WalletList.tsx
@@ -149,7 +149,7 @@ export function WalletList(props: PropTypes) {
           const isDisconnected = wallet.state === WalletState.DISCONNECTED;
           const isConnectedButDifferentThanTargetNamespace = wallet.isHub
             ? !conciseAddress
-            : !!wallet.namespaces && !conciseAddress;
+            : !!wallet.needsNamespace && !conciseAddress;
 
           if (isDisconnected) {
             setSelectedWalletToConnect(wallet);

diff --git a/widget/embedded/src/hooks/useStatefulConnect/useStatefulConnect.ts b/widget/embedded/src/hooks/useStatefulConnect/useStatefulConnect.ts
@@ -8,8 +8,6 @@ import { WalletState } from '@rango-dev/ui';
 import { useWallets } from '@rango-dev/wallets-react';
 import { useReducer } from 'react';
 
-import { convertCommonNamespacesKeysToLegacyNamespace } from '../../utils/hub';
-
 import {
   isStateOnDerivationPathStep,
   isStateOnNamespace,
@@ -99,10 +97,7 @@ export function useStatefulConnect(): UseStatefulConnect {
           detachedInstances && wallet.state !== 'connected';
 
         if (needsNamespace) {
-          const availableNamespaces =
-            convertCommonNamespacesKeysToLegacyNamespace(
-              detachedInstances.value
-            );
+          const availableNamespaces = detachedInstances.value;
 
           dispatch({
             type: 'needsNamespace',
@@ -117,12 +112,19 @@ export function useStatefulConnect(): UseStatefulConnect {
         }
       }
 
-      // Legacy
-      if (!wallet.namespaces) {
+      /*
+       * Legacy
+       *
+       * For legacy there are 3 states:
+       * 1. a wallet doesn't have any namespace defined, we call the connect.
+       * 2. a wallet has more than two namespaces, we should show namepsace modal, and in that place user will be checked to needs derivation path or not.
+       * 3. a wallet has exactly one namespacesape, in this case we check if that needs derivation or not, if it needs we will do it here by dispatching the action accordingly.
+       */
+      if (!wallet.needsNamespace) {
         return await runConnect(wallet.type, undefined, options);
       }
 
-      const needsNamespace = wallet.namespaces.length > 1;
+      const needsNamespace = wallet.needsNamespace.data.length > 1;
       const needsDerivationPath = wallet.needsDerivationPath;
 
       if (needsNamespace) {
@@ -131,26 +133,32 @@ export function useStatefulConnect(): UseStatefulConnect {
           payload: {
             providerType: wallet.type,
             providerImage: wallet.image,
-            availableNamespaces: wallet.namespaces,
-            singleNamespace: wallet.singleNamespace,
+            availableNamespaces: wallet.needsNamespace.data.map(
+              (ns) => ns.value
+            ),
+            singleNamespace: wallet.needsNamespace.selection === 'single',
           },
         });
         return { status: ResultStatus.Namespace };
       } else if (needsDerivationPath) {
+        const namespace = wallet.needsNamespace.data[0];
+
         dispatch({
           type: 'needsDerivationPath',
           payload: {
             providerType: wallet.type,
             providerImage: wallet.image,
-            namespace: wallet.namespaces[0],
+            namespace: namespace.value,
           },
         });
         return { status: ResultStatus.DerivationPath };
       }
 
       return await runConnect(
         wallet.type,
-        wallet.namespaces.map((namespace) => ({ namespace })),
+        wallet.needsNamespace?.data.map((namespace) => ({
+          namespace: namespace.value,
+        })),
         options
       );
     }
@@ -167,7 +175,7 @@ export function useStatefulConnect(): UseStatefulConnect {
     wallet: WalletInfoWithExtra,
     selectedNamespaces: Namespace[]
   ): Promise<Result> => {
-    const isSingleNamespace = wallet.singleNamespace;
+    const isSingleNamespace = wallet.needsNamespace?.selection === 'single';
     const needsDerivationPath = wallet.needsDerivationPath;
     const firstSelectedNamespace = selectedNamespaces[0];
 

diff --git a/widget/embedded/src/types/wallets.ts b/widget/embedded/src/types/wallets.ts
@@ -1,5 +1,4 @@
 import type { WalletInfo } from '@rango-dev/ui';
-import type { Namespace } from '@rango-dev/wallets-core/namespaces/common';
 import type { WalletType } from '@rango-dev/wallets-shared';
 
 export interface Wallet {
@@ -25,8 +24,4 @@ export type TokensBalance = {
   [key: TokenHash]: Balance;
 };
 
-export type WalletInfoWithExtra = WalletInfo & {
-  namespaces?: Namespace[];
-  singleNamespace?: boolean;
-  needsDerivationPath?: boolean;
-};
+export type WalletInfoWithExtra = WalletInfo;
diff --git a/widget/embedded/src/utils/wallets.ts b/widget/embedded/src/utils/wallets.ts
@@ -87,8 +87,7 @@ export function mapWalletTypesToWalletInfo(
         img: image,
         installLink,
         showOnMobile,
-        namespaces,
-        singleNamespace,
+        needsNamespace,
         supportedChains,
         needsDerivationPath,
         properties,
@@ -106,8 +105,7 @@ export function mapWalletTypesToWalletInfo(
         state,
         type,
         showOnMobile,
-        namespaces,
-        singleNamespace,
+        needsNamespace,
         blockchainTypes,
         needsDerivationPath,
         properties,

diff --git a/widget/ui/src/components/Wallet/Wallet.types.ts b/widget/ui/src/components/Wallet/Wallet.types.ts
@@ -1,3 +1,4 @@
+import type { LegacyWalletInfo } from '@rango-dev/wallets-core/legacy';
 import type { InstallObjects, WalletType } from '@rango-dev/wallets-shared';
 import type { TransactionType } from 'rango-types';
 
@@ -16,6 +17,8 @@ export type WalletInfo = {
   type: string;
   showOnMobile?: boolean;
   blockchainTypes: TransactionType[];
+  needsNamespace?: LegacyWalletInfo['needsNamespace'];
+  needsDerivationPath?: LegacyWalletInfo['needsDerivationPath'];
 };
 
 export interface Info {