feat(extension): use new trezor package of SDK in Lace [LW-6522] (#451)

DominikGuzei · web-flow · commit 3853b0ac2ce0 · 2023-11-02T17:15:40.000+01:00
* feat(extension): use new trezor package of SDK in Lace LW-6522
* feat(extension): fixed integration issues with new trezor-hardware package LW-6522
* feat(extension): wip updating to latest SDK packages LW-6522
* feat(extension): upgrade Lace codebase to latest SDK packages LW-6522
* feat(extension): fix issues with sanchonet refactoring LW-6522
* feat(extension): fix import of trezor hardware wallet code LW-6522
* feat(extension): update yarn lock file LW-6522
* feat(extension): disable trezor wallet in default env LW-6522
* feat(extension): update to latest hardware trezor package LW-6522
* feat(extension): update to latest sdk packages LW-6522
* feat(extension): fix unit tests LW-6522
* feat(extension): try to make sanchonet env var available to ci build LW-6522
* feat(extension): remove sanchonet support LW-6522

---------

Signed-off-by: Dominik Guzei &lt;dominik.guzei@gmail.com&gt;
diff --git a/apps/browser-extension-wallet/package.json b/apps/browser-extension-wallet/package.json
@@ -40,14 +40,14 @@
   },
   "dependencies": {
     "@ant-design/icons": "^4.7.0",
-    "@cardano-sdk/cardano-services-client": "0.14.3",
+    "@cardano-sdk/cardano-services-client": "0.14.4",
     "@cardano-sdk/core": "0.21.0",
     "@cardano-sdk/dapp-connector": "0.11.1",
-    "@cardano-sdk/input-selection": "0.12.3",
-    "@cardano-sdk/tx-construction": "0.14.1",
+    "@cardano-sdk/input-selection": "0.12.4",
+    "@cardano-sdk/tx-construction": "0.14.2",
     "@cardano-sdk/util": "0.14.2",
-    "@cardano-sdk/wallet": "0.25.0",
-    "@cardano-sdk/web-extension": "0.16.2",
+    "@cardano-sdk/wallet": "0.25.1",
+    "@cardano-sdk/web-extension": "0.16.3",
     "@emurgo/cip14-js": "~3.0.1",
     "@koralabs/handles-public-api-interfaces": "^1.6.6",
     "@lace/cardano": "0.1.0",
diff --git a/apps/browser-extension-wallet/src/config.ts b/apps/browser-extension-wallet/src/config.ts
@@ -3,9 +3,7 @@ import { Wallet } from '@lace/cardano';
 import { EnvironmentTypes } from '@stores';
 
 type CardanoServiceUrls = {
-  Mainnet: string;
-  Preprod: string;
-  Preview: string;
+  [key in Wallet.ChainName]: string;
 };
 
 type CExplorerUrlPaths = {
@@ -85,8 +83,7 @@ export const config = (): Config => {
     CEXPLORER_BASE_URL: {
       Mainnet: `${process.env.CEXPLORER_URL_MAINNET}`,
       Preprod: `${process.env.CEXPLORER_URL_PREPROD}`,
-      Preview: `${process.env.CEXPLORER_URL_PREVIEW}`,
-      Sanchonet: `${process.env.CEXPLORER_URL_SANCHONET}`
+      Preview: `${process.env.CEXPLORER_URL_PREVIEW}`
     },
     CEXPLORER_URL_PATHS: {
       Tx: 'tx',
diff --git a/apps/browser-extension-wallet/src/features/ada-handle/config.ts b/apps/browser-extension-wallet/src/features/ada-handle/config.ts
@@ -3,9 +3,8 @@ import { Wallet } from '@lace/cardano';
 
 export const ADA_HANDLE_POLICY_ID = Wallet.ADA_HANDLE_POLICY_ID;
 export const isAdaHandleEnabled = process.env.USE_ADA_HANDLE === 'true';
-export const HANDLE_SERVER_URLS: Record<Cardano.NetworkMagics, string> = {
+export const HANDLE_SERVER_URLS: Record<Exclude<Cardano.NetworkMagics, Cardano.NetworkMagics.Sanchonet>, string> = {
   [Cardano.NetworkMagics.Mainnet]: 'https://api.handle.me',
   [Cardano.NetworkMagics.Preprod]: 'https://preprod.api.handle.me',
-  [Cardano.NetworkMagics.Preview]: 'https://preview.api.handle.me',
-  [Cardano.NetworkMagics.Sanchonet]: 'https://sanchonet.api.handle.me'
+  [Cardano.NetworkMagics.Preview]: 'https://preview.api.handle.me'
 };
diff --git a/apps/browser-extension-wallet/src/features/address-book/context/AddressBookProvider.tsx b/apps/browser-extension-wallet/src/features/address-book/context/AddressBookProvider.tsx
@@ -15,11 +15,10 @@ interface AddressBookProviderProps {
 
 export type AddressRecordParams = Pick<AddressBookSchema, 'address' | 'name' | 'handleResolution'>;
 
-export const cardanoNetworkMap = {
+export const cardanoNetworkMap: { [key in Wallet.ChainName]: Wallet.Cardano.NetworkMagics } = {
   Mainnet: Wallet.Cardano.NetworkMagics.Mainnet,
   Preprod: Wallet.Cardano.NetworkMagics.Preprod,
-  Preview: Wallet.Cardano.NetworkMagics.Preview,
-  Sanchonet: Wallet.Cardano.NetworkMagics.Sanchonet
+  Preview: Wallet.Cardano.NetworkMagics.Preview
 };
 
 const handleRecordValidation = (list: AddressBookSchema[], record: AddressRecordParams) => {
diff --git a/apps/browser-extension-wallet/src/features/dapp/components/__tests__/Connect.test.tsx b/apps/browser-extension-wallet/src/features/dapp/components/__tests__/Connect.test.tsx
@@ -99,13 +99,6 @@ describe('Connect Component: ', () => {
       });
       rerender(<WrappedConnectComponent />);
       await waitFor(assert);
-
-      mockUseWalletStore.mockReturnValueOnce({
-        environmentName: 'Sanchonet'
-      });
-
-      rerender(<WrappedConnectComponent />);
-      await waitFor(assert);
     });
 
     test('should render default warning modal for any other than Mainnet env and https protocol', async () => {
@@ -126,13 +119,6 @@ describe('Connect Component: ', () => {
       });
       rerender(<WrappedConnectComponent />);
       await waitFor(assert);
-
-      mockUseWalletStore.mockReturnValueOnce({
-        environmentName: 'Sanchonet'
-      });
-
-      rerender(<WrappedConnectComponent />);
-      await waitFor(assert);
     });
   });
 });
diff --git a/apps/browser-extension-wallet/src/hooks/__tests__/useCollateral.test.tsx b/apps/browser-extension-wallet/src/hooks/__tests__/useCollateral.test.tsx
@@ -15,7 +15,7 @@ import { BehaviorSubject } from 'rxjs';
 import { cleanup, renderHook } from '@testing-library/react-hooks';
 import { AppSettingsProvider } from '@providers';
 import { StoreProvider } from '@src/stores';
-import { COLLATERAL_ADA_AMOUNT, COLLATERAL_AMOUNT_LOVELACES, useCollateral } from '../useCollateral';
+import { COLLATERAL_ADA_AMOUNT, COLLATERAL_AMOUNT_LOVELACES, useCollateral } from '@hooks';
 import { APP_MODE_BROWSER } from '@src/utils/constants';
 import { I18nextProvider } from 'react-i18next';
 import i18n from '@lib/i18n';
diff --git a/apps/browser-extension-wallet/src/hooks/__tests__/useWalletManager.test.tsx b/apps/browser-extension-wallet/src/hooks/__tests__/useWalletManager.test.tsx
@@ -862,7 +862,7 @@ describe('Testing useWalletManager hook', () => {
       await expect(switchNetwork(chainId)).rejects.toThrow(new Error('Chain not supported'));
     });
     test('shoud throw in case the chain is not available', async () => {
-      const chainId = 'Sanchonet' as any;
+      const chainId = 'Dummy' as any;
       const {
         result: {
           current: { switchNetwork }
diff --git a/apps/browser-extension-wallet/src/lib/scripts/background/services/userIdService.test.ts b/apps/browser-extension-wallet/src/lib/scripts/background/services/userIdService.test.ts
@@ -1,6 +1,6 @@
 import { BackgroundStorage } from '@lib/scripts/types';
 import { mockKeyAgentsByChain } from '@src/utils/mocks/test-helpers';
-import { SESSION_LENGTH, USER_ID_BYTE_SIZE, UserIdService } from '.';
+import { SESSION_LENGTH, USER_ID_BYTE_SIZE, UserIdService } from './userIdService';
 import * as utils from '../util';
 import { UserTrackingType } from '@providers/AnalyticsProvider/analyticsTracker';
 
diff --git a/apps/browser-extension-wallet/src/lib/scripts/background/wallet.ts b/apps/browser-extension-wallet/src/lib/scripts/background/wallet.ts
@@ -40,7 +40,14 @@ const walletFactory: WalletFactory = {
         ...providers,
         stores: dependencies.stores,
         handleProvider: new KoraLabsHandleProvider({
-          serverUrl: HANDLE_SERVER_URLS[Cardano.ChainIds[chainName].networkMagic],
+          serverUrl:
+            HANDLE_SERVER_URLS[
+              // TODO: remove exclude to support sanchonet
+              Cardano.ChainIds[chainName].networkMagic as Exclude<
+                Cardano.NetworkMagics,
+                Cardano.NetworkMagics.Sanchonet
+              >
+            ],
           adapter: axiosFetchAdapter,
           policyId: ADA_HANDLE_POLICY_ID
         }),
diff --git a/apps/browser-extension-wallet/src/lib/scripts/migrations/versions/v0_6_0.ts b/apps/browser-extension-wallet/src/lib/scripts/migrations/versions/v0_6_0.ts
@@ -89,12 +89,6 @@ export const v0_6_0: Migration = {
               : {
                   keyAgentData: { ...newKeyAgentData, chainId: Wallet.Cardano.ChainIds.Preview, knownAddresses: [] }
                 },
-          Sanchonet:
-            keyAgentStoredChainName === 'Sanchonet'
-              ? { keyAgentData: newKeyAgentData }
-              : {
-                  keyAgentData: { ...newKeyAgentData, chainId: Wallet.Cardano.ChainIds.Sanchonet, knownAddresses: [] }
-                },
           Mainnet:
             keyAgentStoredChainName === 'Mainnet'
               ? { keyAgentData: newKeyAgentData }
diff --git a/apps/browser-extension-wallet/src/utils/mocks/test-helpers.tsx b/apps/browser-extension-wallet/src/utils/mocks/test-helpers.tsx
@@ -43,8 +43,7 @@ export const mockKeyAgentDataTestnet: Wallet.KeyManagement.SerializableKeyAgentD
 export const mockKeyAgentsByChain: Wallet.KeyAgentsByChain = {
   Mainnet: { keyAgentData: { ...mockKeyAgentDataTestnet, chainId: Wallet.Cardano.ChainIds.Mainnet } },
   Preprod: { keyAgentData: { ...mockKeyAgentDataTestnet, chainId: Wallet.Cardano.ChainIds.Preprod } },
-  Preview: { keyAgentData: { ...mockKeyAgentDataTestnet, chainId: Wallet.Cardano.ChainIds.Preview } },
-  Sanchonet: { keyAgentData: { ...mockKeyAgentDataTestnet, chainId: Wallet.Cardano.ChainIds.Sanchonet } }
+  Preview: { keyAgentData: { ...mockKeyAgentDataTestnet, chainId: Wallet.Cardano.ChainIds.Preview } }
 };
 
 export const mockInMemoryWallet = {
diff --git a/package.json b/package.json
@@ -15,13 +15,8 @@
     "Michael Chappell <michael.chappell@iohk.io> (https://iohk.io)"
   ],
   "workspaces": [
-    "packages/common",
-    "packages/cardano",
-    "packages/core",
-    "apps/*",
-    "packages/e2e-tests",
-    "packages/staking",
-    "packages/ui"
+    "packages/*",
+    "apps/*"
   ],
   "scripts": {
     "base-command-for-build-scripts": "wsrun --prefix -trame ${APP_NAME:+-p \"@lace/$APP_NAME\"} ${EXCLUDE_APP:+-x \"@lace/$APP_NAME\"} ${EXCLUDE_BROWSER:+-x \"@lace/browser-extension-wallet\"}",
diff --git a/packages/cardano/package.json b/packages/cardano/package.json
@@ -39,15 +39,15 @@
     "watch": "yarn build --watch"
   },
   "dependencies": {
-    "@cardano-sdk/cardano-services-client": "0.14.3",
+    "@cardano-sdk/cardano-services-client": "0.14.4",
     "@cardano-sdk/core": "0.21.0",
     "@cardano-sdk/crypto": "0.1.15",
-    "@cardano-sdk/hardware-ledger": "0.6.0",
-    "@cardano-sdk/hardware-trezor": "0.2.0",
+    "@cardano-sdk/hardware-ledger": "0.6.1",
+    "@cardano-sdk/hardware-trezor": "0.2.1",
     "@cardano-sdk/key-management": "0.14.0",
     "@cardano-sdk/util": "0.14.2",
-    "@cardano-sdk/wallet": "0.25.0",
-    "@cardano-sdk/web-extension": "0.16.2",
+    "@cardano-sdk/wallet": "0.25.1",
+    "@cardano-sdk/web-extension": "0.16.3",
     "@dcspark/cardano-multiplatform-lib-browser": "^3.1.1",
     "@lace/common": "0.1.0",
     "@stablelib/chacha20poly1305": "1.0.1",
@@ -68,7 +68,7 @@
     "webextension-polyfill": "0.8.0"
   },
   "devDependencies": {
-    "@cardano-sdk/util-dev": "0.17.1",
+    "@cardano-sdk/util-dev": "0.17.3",
     "@dcspark/cardano-multiplatform-lib-nodejs": "^3.1.1",
     "@emurgo/cardano-message-signing-browser": "1.0.1",
     "rollup-plugin-polyfill-node": "^0.8.0",
diff --git a/packages/cardano/src/wallet/lib/cardano-wallet.ts b/packages/cardano/src/wallet/lib/cardano-wallet.ts
@@ -23,7 +23,7 @@ import { WalletManagerActivateProps, WalletManagerUi } from '@cardano-sdk/web-ex
 import { ChainName, WalletManagerProviderTypes } from '../types';
 import * as Crypto from '@cardano-sdk/crypto';
 import { createWalletUtil } from '@cardano-sdk/wallet';
-// Using nodejs to satisfy the tests requirements, but this gets replaced by webpack to the browser version in the build
+// Using nodejs CML version to satisfy the tests requirements, but this gets replaced by webpack to the browser version in the build
 import * as CML from '@dcspark/cardano-multiplatform-lib-nodejs';
 
 export type KeyAgentsByChain = Record<ChainName, { keyAgentData: KeyManagement.SerializableKeyAgentData }>;
diff --git a/packages/cardano/src/wallet/lib/hardware-wallet.ts b/packages/cardano/src/wallet/lib/hardware-wallet.ts
@@ -3,12 +3,13 @@ import { Cardano } from '@cardano-sdk/core';
 import { ObservableWallet, setupWallet, SetupWalletProps } from '@cardano-sdk/wallet';
 import * as KeyManagement from '../../../../../node_modules/@cardano-sdk/key-management/dist/cjs';
 import { ChainName, DeviceConnection, CreateHardwareWalletArgs, HardwareWallets } from '../types';
-import { CardanoWalletByChain, KeyAgentsByChain } from './cardano-wallet';
+import { CardanoWalletByChain, KeyAgentsByChain } from '@src/wallet';
 import { WalletManagerUi } from '@cardano-sdk/web-extension';
 import * as Crypto from '@cardano-sdk/crypto';
 import * as HardwareLedger from '../../../../../node_modules/@cardano-sdk/hardware-ledger/dist/cjs';
 import * as HardwareTrezor from '../../../../../node_modules/@cardano-sdk/hardware-trezor/dist/cjs';
-// Using nodejs to satisfy the tests requirements, but this gets replaced by webpack to the browser version in the build
+import { TrezorConfig } from '@cardano-sdk/key-management';
+// Using nodejs CML version to satisfy the tests requirements, but this gets replaced by webpack to the browser version in the build
 import * as CML from '@dcspark/cardano-multiplatform-lib-nodejs';
 
 const isTrezorHWSupported = (): boolean => process.env.USE_TREZOR_HW === 'true';
@@ -94,12 +95,12 @@ const createWithTrezorDeviceConnection = async (
     accountIndex = 0,
     extendedAccountPublicKey,
     trezorConfig
-  }: Omit<
-    Parameters<typeof HardwareTrezor.TrezorKeyAgent['createWithDevice']>[0] & {
-      extendedAccountPublicKey?: Crypto.Bip32PublicKeyHex;
-    },
-    'deviceConnection'
-  >,
+  }: {
+    chainId: Cardano.ChainId;
+    accountIndex?: number;
+    extendedAccountPublicKey: Crypto.Bip32PublicKeyHex;
+    trezorConfig: TrezorConfig;
+  },
   dependencies: Parameters<typeof HardwareTrezor.TrezorKeyAgent['createWithDevice']>[1]
 ) => {
   // Throws an authentication error if called after the first key agent creation
diff --git a/packages/cardano/src/wallet/lib/providers.ts b/packages/cardano/src/wallet/lib/providers.ts
@@ -1,16 +1,18 @@
-import { WalletProvidersDependencies } from './cardano-wallet';
+import { WalletProvidersDependencies } from '@src/wallet';
 import { AxiosAdapter } from 'axios';
 import {
   AssetProvider,
   ChainHistoryProvider,
   NetworkInfoProvider,
+  Provider,
   RewardsProvider,
   StakePoolProvider,
   TxSubmitProvider,
   UtxoProvider
 } from '@cardano-sdk/core';
 
 import {
+  CreateHttpProviderConfig,
   assetInfoHttpProvider,
   chainHistoryHttpProvider,
   networkInfoHttpProvider,
@@ -36,7 +38,7 @@ export interface ProvidersConfig {
 }
 
 export const createProviders = ({ axiosAdapter, baseUrl }: ProvidersConfig): WalletProvidersDependencies => {
-  const httpProviderConfig = {
+  const httpProviderConfig: CreateHttpProviderConfig<Provider> = {
     baseUrl,
     logger: console,
     adapter: axiosAdapter
diff --git a/packages/cardano/src/wallet/test/mocks/TestKeyAgent.ts b/packages/cardano/src/wallet/test/mocks/TestKeyAgent.ts
@@ -3,6 +3,7 @@ import * as KeyManagement from '../../../../../../node_modules/@cardano-sdk/key-
 import * as Crypto from '@cardano-sdk/crypto';
 // Using nodejs to satisfy the tests requirements, but this gets replaced by webpack to the browser version in the build
 import * as CML from '@dcspark/cardano-multiplatform-lib-nodejs';
+
 interface TestKeyAgentProps {
   password?: string;
   mnemonicWords?: string[];
diff --git a/packages/cardano/src/wallet/types.ts b/packages/cardano/src/wallet/types.ts
@@ -46,7 +46,8 @@ export type Cip30SignTxAssetItem = {
 export enum WalletManagerProviderTypes {
   CARDANO_SERVICES_PROVIDER = 'cardano-services-provider'
 }
-export type ChainName = keyof typeof Cardano.ChainIds;
+// Exclude Sanchonet until in main branch
+export type ChainName = keyof Omit<typeof Cardano.ChainIds, 'Sanchonet'>;
 
 export interface CreateHardwareWalletArgs {
   deviceConnection: DeviceConnection;
diff --git a/packages/staking/package.json b/packages/staking/package.json
@@ -64,8 +64,8 @@
     "zustand": "^4.4.1"
   },
   "devDependencies": {
-    "@cardano-sdk/input-selection": "0.12.3",
-    "@cardano-sdk/tx-construction": "0.14.1",
+    "@cardano-sdk/input-selection": "0.12.4",
+    "@cardano-sdk/tx-construction": "0.14.2",
     "@cardano-sdk/util": "0.14.2",
     "@lace/cardano": "^0.1.0",
     "@lace/common": "^0.1.0",
@@ -97,10 +97,10 @@
     "wait-on": "^7.0.1"
   },
   "peerDependencies": {
-    "@cardano-sdk/input-selection": "0.12.3",
-    "@cardano-sdk/tx-construction": "0.14.1",
+    "@cardano-sdk/input-selection": "0.12.4",
+    "@cardano-sdk/tx-construction": "0.14.2",
     "@cardano-sdk/util": "0.14.2",
-    "@cardano-sdk/wallet": "0.25.0",
+    "@cardano-sdk/wallet": "0.25.1",
     "@lace/cardano": "^0.1.0",
     "@lace/common": "^0.1.0",
     "@lace/core": "0.1.0",
diff --git a/yarn.lock b/yarn.lock
