[DDW-735] Hardware wallets support for all non-public Testnet magics (#2672)

* [DDW-735] Introduce an Hardware Wallets support for all non-public testnets

* [DDW-735] CHANGELOG update

* [DDW-735] Shelley QA network magic added to cardano-node.types and code cleanup

* [DDW-735] Improve network magics declaration and HW network handlers

* [DDW-735] Removing unnecessary isNonPublicTestnet flag

* [DDW-735] Mark staging HW actions as mainnet like actions

* [DDW-735] CHANGELOG update

Co-authored-by: Nikola Glumac <[email protected]>

Author: tomislavhoracek

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Fixed transaction timestamps localization ([PR 2702](https://github.com/input-output-hk/daedalus/pull/2702))
 
+### Chores
+
+- Added hardware wallet support for all non-public testnets ([PR 2672](https://github.com/input-output-hk/daedalus/pull/2672))
+
 ## 4.4.0
 
 ### Features

source/common/types/cardano-node.types.js

@@ -1,4 +1,13 @@
 // @flow
+import {
+  MAINNET,
+  TESTNET,
+  STAGING,
+  SHELLEY_QA,
+  ALONZO_PURPLE,
+  SELFNODE,
+} from './environment.types';
+
 export type TlsConfig = {
   hostname: string,
   port: number,
@@ -142,17 +151,26 @@ export type CardanoStatus = {
   cardanoWalletPID: number,
 };
 
-// Cardano Mainet network magic
-export const MAINNET_MAGIC = [1, null];
-
-// Cardano Byron Testnet network magic
-export const TESTNET_MAGIC = [1097911063, 0];
-
-// Cardano Staging network magic
-export const STAGING_MAGIC = [633343913, 1];
+export type NetworkMagicType = Array<?number>;
 
-// Cardano Alonzo Purple network magic
-export const ALONZO_PURPLE_MAGIC = [8, 0];
-
-// Cardano Selfnode network magic
-export const SELFNODE_MAGIC = MAINNET_MAGIC;
+export const NetworkMagics: {
+  mainnet: NetworkMagicType,
+  testnet: NetworkMagicType,
+  staging: NetworkMagicType,
+  alonzo_purple: NetworkMagicType,
+  shelley_qa: NetworkMagicType,
+  selfnode: NetworkMagicType,
+} = {
+  // Cardano Mainet network magic
+  [MAINNET]: [1, null],
+  // Cardano Staging network magic
+  [STAGING]: [633343913, 1],
+  // Cardano Byron Testnet network magic
+  [TESTNET]: [1097911063, 0],
+  // Cardano Alonzo Purple network magic
+  [ALONZO_PURPLE]: [8, 0],
+  // Cardano Shelley QA network magic
+  [SHELLEY_QA]: [3, 0],
+  // Cardano Selfnode network magic
+  [SELFNODE]: [1, null],
+};

source/common/types/environment.types.js

@@ -12,6 +12,7 @@ export type Environment = {
   isStaging: boolean,
   isTestnet: boolean,
   isAlonzoPurple: boolean,
+  isShelleyQA: boolean,
   isSelfnode: boolean,
   isDevelopment: boolean,
   isWatchMode: boolean,

source/common/utils/environmentCheckers.js

@@ -2,6 +2,7 @@
 import { upperFirst } from 'lodash';
 import {
   ALONZO_PURPLE,
+  SHELLEY_QA,
   DEVELOPMENT,
   LINUX,
   MAC_OS,
@@ -54,6 +55,7 @@ export const checkIsMainnet = (network: string) => network === MAINNET;
 export const checkIsTestnet = (network: string) => network === TESTNET;
 export const checkIsAlonzoPurple = (network: string) =>
   network === ALONZO_PURPLE;
+export const checkIsShelleyQA = (network: string) => network === SHELLEY_QA;
 export const checkIsStaging = (network: string) => network === STAGING;
 export const checkIsSelfnode = (network: string) => network === SELFNODE;
 export const checkIsDevelopment = (network: string) => network === DEVELOPMENT;

source/main/environment.js

@@ -7,6 +7,7 @@ import { DEVELOPMENT, OS_NAMES } from '../common/types/environment.types';
 import {
   evaluateNetwork,
   checkIsAlonzoPurple,
+  checkIsShelleyQA,
   checkIsDev,
   checkIsTest,
   checkIsProduction,
@@ -34,6 +35,7 @@ const isMainnet = checkIsMainnet(NETWORK);
 const isStaging = checkIsStaging(NETWORK);
 const isTestnet = checkIsTestnet(NETWORK);
 const isAlonzoPurple = checkIsAlonzoPurple(NETWORK);
+const isShelleyQA = checkIsShelleyQA(NETWORK);
 const isSelfnode = checkIsSelfnode(NETWORK);
 const isDevelopment = checkIsDevelopment(NETWORK);
 const isWatchMode = process.env.IS_WATCH_MODE;
@@ -75,6 +77,7 @@ export const environment: Environment = Object.assign(
     isStaging,
     isTestnet,
     isAlonzoPurple,
+    isShelleyQA,
     isSelfnode,
     isDevelopment,
     isWatchMode,

source/renderer/app/config/hardwareWalletsConfig.js

@@ -1,4 +1,8 @@
-const { isMainnet, isTestnet } = global.environment;
+// @flow
+import { get, map } from 'lodash';
+import { NetworkMagics } from '../../../common/types/cardano-node.types';
+import type { NetworkMagicType } from '../../../common/types/cardano-node.types';
+import type { Network } from '../../../common/types/environment.types';
 
 export const HARDENED_HEX = 0x80000000;
 export const HARDENED = 2147483648;
@@ -7,25 +11,18 @@ export const BYRON_PURPOSE_INDEX = 44;
 export const ADA_COIN_TYPE = 1815;
 export const DEFAULT_ADDRESS_INDEX = 0;
 
+const { isMainnet, isStaging, isSelfnode } = global.environment;
+const hardwareWalletNetworksConfig = {};
+map(NetworkMagics, (networkMagic: NetworkMagicType, network: Network) => {
+  const isMainnetLikeNetwork = isMainnet || isSelfnode || isStaging;
+  hardwareWalletNetworksConfig[network] = {
+    networkId: isMainnetLikeNetwork ? 1 : networkMagic[1],
+    protocolMagic: isMainnetLikeNetwork ? 764824073 : networkMagic[0],
+  };
+});
+
 export const HW_SHELLEY_CONFIG = {
-  NETWORK: {
-    MAINNET: {
-      name: 'mainnet',
-      networkId: 1,
-      protocolMagic: 764824073,
-      trezorProtocolMagic: 764824073,
-      eraStartSlot: 4492800,
-      ttl: 3600,
-    },
-    TESTNET: {
-      name: 'testnet',
-      networkId: 0,
-      protocolMagic: 1097911063,
-      trezorProtocolMagic: 1097911063,
-      eraStartSlot: 4492800,
-      ttl: 3600,
-    },
-  },
+  NETWORK: hardwareWalletNetworksConfig,
   DEFAULT_DERIVATION_PATH: [
     HARDENED + SHELLEY_PURPOSE_INDEX,
     HARDENED + ADA_COIN_TYPE,
@@ -41,13 +38,7 @@ export const HW_SHELLEY_CONFIG = {
 };
 
 export const HW_BYRON_CONFIG = {
-  NETWORK: {
-    MAINNET: {
-      name: 'mainnet',
-      networkId: 1,
-      protocolMagic: 764824073,
-    },
-  },
+  NETWORK: hardwareWalletNetworksConfig,
   DEFAULT_DERIVATION_PATH: [
     HARDENED + BYRON_PURPOSE_INDEX,
     HARDENED + ADA_COIN_TYPE,
@@ -80,6 +71,11 @@ export const isTrezorEnabled = true;
 export const isLedgerEnabled = true;
 
 export const isHardwareWalletSupportEnabled =
-  (isMainnet || isTestnet) && (isTrezorEnabled || isLedgerEnabled);
+  isTrezorEnabled || isLedgerEnabled;
 
 export const isHardwareWalletIndicatorEnabled = false;
+
+export const getHardwareWalletsNetworkConfig = (network: Network) => {
+  const networkConfig = get(HW_SHELLEY_CONFIG, ['NETWORK', network], {});
+  return networkConfig;
+};

source/renderer/app/stores/HardwareWalletsStore.js

@@ -12,7 +12,6 @@ import { HwDeviceStatuses } from '../domains/Wallet';
 import WalletAddress from '../domains/WalletAddress';
 import { toJS } from '../../../common/utils/helper';
 import {
-  HW_SHELLEY_CONFIG,
   SHELLEY_PURPOSE_INDEX,
   ADA_COIN_TYPE,
   MINIMAL_TREZOR_FIRMWARE_VERSION,
@@ -21,6 +20,7 @@ import {
   isHardwareWalletSupportEnabled,
   isTrezorEnabled,
   isLedgerEnabled,
+  getHardwareWalletsNetworkConfig,
 } from '../config/hardwareWalletsConfig';
 import { TIME_TO_LIVE } from '../config/txnsConfig';
 import {
@@ -160,6 +160,9 @@ const useCardanoAppInterval = (
     addressVerification
   );
 
+const { network, isDev } = global.environment;
+const hardwareWalletsNetworkConfig = getHardwareWalletsNetworkConfig(network);
+
 export default class HardwareWalletsStore extends Store {
   @observable selectCoinsRequest: Request<CoinSelectionsResponse> = new Request(
     this.api.ada.selectCoins
@@ -262,7 +265,7 @@ export default class HardwareWalletsStore extends Store {
 
   initLedger = async () => {
     logger.debug(
-      `[HW-DEBUG] HWStore - initLedger() | isHardwareWalletSupportEnabled=${isHardwareWalletSupportEnabled} isLedgerEnabled=${isLedgerEnabled}`
+      `[HW-DEBUG] HWStore - initLedger() | isHardwareWalletSupportEnabled=${isHardwareWalletSupportEnabled.toString()} isLedgerEnabled=${isLedgerEnabled.toString()}`
     );
     if (isHardwareWalletSupportEnabled && isLedgerEnabled) {
       logger.debug('[HW-DEBUG] HWStore - start ledger');
@@ -1131,7 +1134,6 @@ export default class HardwareWalletsStore extends Store {
   }) => {
     logger.debug('[HW-DEBUG] - VERIFY Address');
     const { address, path, isTrezor } = params;
-    const { isMainnet } = this.environment;
 
     this.hwDeviceStatus = HwDeviceStatuses.VERIFYING_ADDRESS;
     this.tempAddressToVerify = params;
@@ -1142,12 +1144,8 @@ export default class HardwareWalletsStore extends Store {
         addressType: AddressType.BASE,
         spendingPathStr: address.spendingPath,
         stakingPathStr: `${SHELLEY_PURPOSE_INDEX}'/${ADA_COIN_TYPE}'/0'/2/0`,
-        networkId: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.networkId
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.networkId,
-        protocolMagic: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.protocolMagic
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.protocolMagic,
+        networkId: hardwareWalletsNetworkConfig.networkId,
+        protocolMagic: hardwareWalletsNetworkConfig.protocolMagic,
       });
 
       if (derivedAddress === address.id) {
@@ -1239,7 +1237,6 @@ export default class HardwareWalletsStore extends Store {
   }) => {
     logger.debug('[HW-DEBUG] - SHOW Address');
     const { address, path, isTrezor } = params;
-    const { isMainnet } = this.environment;
 
     try {
       await showAddressChannel.request({
@@ -1248,12 +1245,8 @@ export default class HardwareWalletsStore extends Store {
         addressType: AddressType.BASE,
         spendingPathStr: address.spendingPath,
         stakingPathStr: `${SHELLEY_PURPOSE_INDEX}'/${ADA_COIN_TYPE}'/0'/2/0`,
-        networkId: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.networkId
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.networkId,
-        protocolMagic: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.protocolMagic
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.protocolMagic,
+        networkId: hardwareWalletsNetworkConfig.networkId,
+        protocolMagic: hardwareWalletsNetworkConfig.protocolMagic,
       });
       runInAction(
         'HardwareWalletsStore:: Address show process finished',
@@ -1818,7 +1811,6 @@ export default class HardwareWalletsStore extends Store {
     const fee = formattedAmountToLovelace(flatFee.toString());
     const ttl = this._getTtl();
     const absoluteSlotNumber = this._getAbsoluteSlotNumber();
-    const { isMainnet } = this.environment;
 
     try {
       const signedTransaction = await signTransactionTrezorChannel.request({
@@ -1827,12 +1819,8 @@ export default class HardwareWalletsStore extends Store {
         fee: fee.toString(),
         ttl: ttl.toString(),
         validityIntervalStartStr: absoluteSlotNumber.toString(),
-        networkId: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.networkId
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.networkId,
-        protocolMagic: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.trezorProtocolMagic
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.trezorProtocolMagic,
+        networkId: hardwareWalletsNetworkConfig.networkId,
+        protocolMagic: hardwareWalletsNetworkConfig.protocolMagic,
         certificates: certificatesData,
         withdrawals: withdrawalsData,
         devicePath: recognizedDevicePath,
@@ -2061,7 +2049,6 @@ export default class HardwareWalletsStore extends Store {
 
     const fee = formattedAmountToLovelace(flatFee.toString());
     const ttl = this._getTtl();
-    const { isMainnet } = this.environment;
 
     let unsignedTxAuxiliaryData = null;
     if (this.votingData) {
@@ -2089,12 +2076,8 @@ export default class HardwareWalletsStore extends Store {
         fee: fee.toString(),
         ttl: ttl.toString(),
         validityIntervalStartStr: null,
-        networkId: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.networkId
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.networkId,
-        protocolMagic: isMainnet
-          ? HW_SHELLEY_CONFIG.NETWORK.MAINNET.protocolMagic
-          : HW_SHELLEY_CONFIG.NETWORK.TESTNET.protocolMagic,
+        networkId: hardwareWalletsNetworkConfig.networkId,
+        protocolMagic: hardwareWalletsNetworkConfig.protocolMagic,
         certificates: certificatesData,
         withdrawals: withdrawalsData,
         signingMode: TransactionSigningMode.ORDINARY_TRANSACTION,
@@ -2715,7 +2698,7 @@ export default class HardwareWalletsStore extends Store {
 
   // For testing / development ONLY
   _resetHardwareWallets = async () => {
-    if (global.environment.isDev) {
+    if (isDev) {
       await Promise.all(
         this.stores.wallets.all.map(async (wallet) => {
           if (wallet.isHardwareWallet) {

source/renderer/app/stores/WalletsStore.js

@@ -33,13 +33,6 @@ import {
 import { IS_WALLET_PUBLIC_KEY_SHARING_ENABLED } from '../config/walletsConfig';
 import { introspectAddressChannel } from '../ipc/introspect-address';
 import { saveQRCodeImageChannel } from '../ipc/saveQRCodeImageChannel';
-import {
-  TESTNET_MAGIC,
-  SELFNODE_MAGIC,
-  STAGING_MAGIC,
-  MAINNET_MAGIC,
-  ALONZO_PURPLE_MAGIC,
-} from '../../../common/types/cardano-node.types';
 import type { AddressStyle } from '../../../common/types/address-introspection.types';
 import type { AssetToken } from '../api/assets/types';
 import type {
@@ -61,6 +54,7 @@ import type {
   TransportDevice,
   HardwareWalletExtendedPublicKeyResponse,
 } from '../../../common/types/hardware-wallets.types';
+import { NetworkMagics } from '../../../common/types/cardano-node.types';
 
 /* eslint-disable consistent-return */
 
@@ -1029,28 +1023,12 @@ export default class WalletsStore extends Store {
   };
 
   isValidAddress = async (address: string) => {
-    const {
-      isMainnet,
-      isSelfnode,
-      isStaging,
-      isTestnet,
-      isAlonzoPurple,
-    } = this.environment;
-    let expectedNetworkTag: ?Array<?number> | ?number;
+    const { network } = this.environment;
+    const expectedNetworkTag = get(NetworkMagics, [network]);
     const validAddressStyles: AddressStyle[] = ['Byron', 'Icarus', 'Shelley'];
     this.isAddressFromSameWallet = false;
 
-    if (isMainnet) {
-      expectedNetworkTag = MAINNET_MAGIC;
-    } else if (isStaging) {
-      expectedNetworkTag = STAGING_MAGIC;
-    } else if (isTestnet) {
-      expectedNetworkTag = TESTNET_MAGIC;
-    } else if (isAlonzoPurple) {
-      expectedNetworkTag = ALONZO_PURPLE_MAGIC;
-    } else if (isSelfnode) {
-      expectedNetworkTag = SELFNODE_MAGIC;
-    } else {
+    if (!expectedNetworkTag) {
       throw new Error('Unexpected environment');
     }
     try {