[DDW-639] Fund5 voting registration with Ledger

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## vNext
+
+### Features
+
+- Added voting registration with Ledger ([PR 2538](https://github.com/input-output-hk/daedalus/pull/2538))
+
 ## 4.2.0-FC1
 
 ### Features

package.json

@@ -167,7 +167,7 @@
     "yarn-lockfile": "1.1.1"
   },
   "dependencies": {
-    "@cardano-foundation/ledgerjs-hw-app-cardano": "3.0.0",
+    "@cardano-foundation/ledgerjs-hw-app-cardano": "3.1.0",
     "@iohk-jormungandr/wallet-js": "0.5.0-pre7",
     "aes-js": "3.1.2",
     "bech32": "2.0.0",

source/common/types/hardware-wallets.types.js

@@ -163,6 +163,21 @@ export type LedgerSignTransactionOutputsType =
   | []
   | Array<LedgerOutputTypeAddress | LedgerOutputTypeChange>;
 
+export type LedgerAuxiliaryDataType = {
+  type: string,
+  params: {
+    votingPublicKeyHex: string,
+    stakingPath: BIP32Path,
+    rewardsDestination: {
+      type: number,
+      params: {
+        stakingPath: BIP32Path,
+      },
+    },
+    nonce: string,
+  },
+};
+
 export type TrezorSignTransactionInputType = {
   path: string,
   prev_hash: number,
@@ -230,11 +245,11 @@ export type LedgerSignTransactionRequest = {
   protocolMagic: number,
   certificates: Array<?Certificate>,
   withdrawals: Array<?Withdrawal>,
-  auxiliaryData: ?string,
   reset?: boolean,
   devicePath: ?string,
-  validityIntervalStartStr?: string,
+  validityIntervalStartStr?: ?string, // It is disabled for now
   signingMode: string,
+  auxiliaryData: ?LedgerAuxiliaryDataType,
 };
 
 export type TrezorSignTransactionRequest = {
@@ -254,6 +269,11 @@ export type TrezorSignTransactionRequest = {
 export type LedgerSignTransactionResponse = {
   txHashHex: string,
   witnesses: Array<Witness>,
+  auxiliaryDataSupplement?: {
+    catalystRegistrationSignatureHex: string,
+    auxiliaryDataHashHex: string,
+    type: 'catalyst_registration',
+  },
 };
 
 export type TrezorSignTransactionResponse = {

source/main/ipc/getHardwareWalletChannel.js

@@ -682,7 +682,7 @@ export const handleHardwareWalletRequests = async (
     }
   });
 
-  // @TODO - validityIntervalStartStr is not working with Cardano App 2.1.0
+  // @TODO - validityIntervalStart is not working with Cardano App 2.1.0
   signTransactionLedgerChannel.onRequest(async (params) => {
     const {
       inputs,
@@ -695,7 +695,6 @@ export const handleHardwareWalletRequests = async (
       withdrawals,
       auxiliaryData,
       devicePath,
-      // validityIntervalStartStr,
       signingMode,
     } = params;
     logger.info('[HW-DEBUG] SIGN Ledger transaction');
@@ -721,7 +720,6 @@ export const handleHardwareWalletRequests = async (
           certificates,
           withdrawals,
           auxiliaryData,
-          // validityIntervalStart,
         },
       });
       return Promise.resolve(signedTransaction);

source/renderer/app/actions/voting-actions.js

@@ -5,7 +5,7 @@ export default class VotingActions {
   selectWallet: Action<string> = new Action();
   sendTransaction: Action<{
     amount: number,
-    passphrase: string,
+    passphrase: ?string,
   }> = new Action();
   generateQrCode: Action<number> = new Action();
   saveAsPDF: Action<any> = new Action();

source/renderer/app/api/api.js

@@ -159,6 +159,7 @@ import type {
   CreateExternalTransactionResponse,
   GetWithdrawalsRequest,
   GetWithdrawalsResponse,
+  VotingMetadataType,
   ICOPublicKeyParams,
 } from './transactions/types';
 
@@ -1027,6 +1028,7 @@ export default class AdaApi {
     rewardsBalance: BigNumber,
     payments?: CoinSelectionsPaymentRequestType,
     delegation?: CoinSelectionsDelegationRequestType,
+    metadata?: VotingMetadataType,
   }): Promise<CoinSelectionsResponse> => {
     logger.debug('AdaApi::selectCoins called', {
       parameters: filterLogData(request),
@@ -1038,6 +1040,7 @@ export default class AdaApi {
       walletBalance,
       availableBalance,
       rewardsBalance,
+      metadata,
     } = request;
     try {
       let data;
@@ -1061,6 +1064,7 @@ export default class AdaApi {
             },
           ],
           withdrawal: TransactionWithdrawal,
+          metadata: metadata || null,
         };
       } else {
         throw new Error('Missing parameters!');
@@ -1169,6 +1173,7 @@ export default class AdaApi {
         fee: fee.dividedBy(LOVELACES_PER_ADA),
         deposits: deposits.dividedBy(LOVELACES_PER_ADA),
         depositsReclaimed: depositsReclaimed.dividedBy(LOVELACES_PER_ADA),
+        metadata: response.metadata || null,
       };
 
       logger.debug('AdaApi::selectCoins success', { extendedResponse });

source/renderer/app/api/transactions/requests/selectCoins.js

@@ -5,13 +5,15 @@ import type {
   TransactionPaymentData,
   CoinSelectionAmount,
   TransactionWithdrawalType,
+  VotingMetadataType,
 } from '../types';
 import type { DelegationAction } from '../../../types/stakingTypes';
 import { request } from '../../utils/request';
 
 export type PaymentsType = {
   payments: Array<TransactionPaymentData>,
   withdrawal?: TransactionWithdrawalType,
+  metadata?: VotingMetadataType,
 };
 
 export type DelegationType = {
@@ -60,6 +62,7 @@ export type SelectCoinsResponseType = {
     quantity: number,
     unit: WalletUnits.LOVELACE,
   }>,
+  metadata?: string,
 };
 
 export const selectCoins = (

source/renderer/app/api/transactions/types.js

@@ -5,6 +5,7 @@ import { WalletUnits } from '../../domains/Wallet';
 import type { DelegationAction } from '../../types/stakingTypes';
 import type { ApiTokens } from '../assets/types';
 import type { TransactionMetadata } from '../../types/TransactionMetadata';
+import type { PathRoleIdentityType } from '../../utils/hardwareWalletUtils';
 
 export type TransactionAmount = {
   quantity: number,
@@ -239,6 +240,7 @@ export type CoinSelectionsPaymentRequestType = {
   address: string,
   amount: number,
   assets?: ApiTokens,
+  metadata?: VotingMetadataType,
 };
 
 export type CoinSelectionsRequest =
@@ -253,6 +255,7 @@ export type CoinSelectionsResponse = {
   depositsReclaimed: BigNumber,
   withdrawals: Array<CoinSelectionWithdrawal>,
   fee: BigNumber,
+  metadata: ?string,
 };
 
 export type CreateExternalTransactionRequest = {
@@ -282,3 +285,54 @@ export type ICOPublicKeyParams = {
 };
 
 export type CoinSelectionAssetsType = Array<Asset>;
+
+export type VotingMetaIndexType = 61284 | 61285;
+
+export const VotingMetaIndexes: {
+  VOTING_REGISTRATION: VotingMetaIndexType,
+  VOTING_SIGNATURE: VotingMetaIndexType,
+} = {
+  VOTING_REGISTRATION: 61284,
+  VOTING_SIGNATURE: 61285,
+};
+
+export type VotingMetaKeyValuePairString = {
+  [key: 'string']: string,
+};
+export type VotingMetaKeyValuePairInt = {
+  [key: 'int']: number,
+};
+export type VotingMetaKeyValuePairBytes = {
+  [key: 'bytes']: string,
+};
+export type VotingMetaKeyValuePairMap = {
+  [key: 'int']: number,
+};
+
+export type VotingMetaKeyType = 'string' | 'int' | 'bytes' | 'list' | 'map';
+
+export type VotingMetaKeyValuePair = {
+  [key: 'k' | 'v']:
+    | VotingMetaKeyValuePairString
+    | VotingMetaKeyValuePairInt
+    | VotingMetaKeyValuePairBytes,
+};
+
+export type VotingMetaRegistrationType = {
+  [key: 'map']: Array<VotingMetaKeyValuePair>,
+};
+
+export type VotingMetadataType = {
+  [key: VotingMetaIndexType]: VotingMetaRegistrationType,
+};
+
+export type VotingDataType = {
+  stakeAddress: string,
+  stakeAddressHex: string,
+  votingKey: string,
+  stakeKey: string,
+  role: PathRoleIdentityType,
+  index: string,
+  metadata: VotingMetadataType,
+  nonce: number,
+};

source/renderer/app/components/voting/VotingRegistrationDialogWizard.js

@@ -13,6 +13,8 @@ import StakePool from '../../domains/StakePool';
 import LocalizableError from '../../i18n/LocalizableError';
 import Wallet from '../../domains/Wallet';
 
+import type { HwDeviceStatus } from '../../domains/Wallet';
+
 type Props = {
   stepsList: Array<string>,
   activeStep: number,
@@ -35,9 +37,12 @@ type Props = {
   isTransactionConfirmed: boolean,
   transactionConfirmations: number,
   transactionError: ?LocalizableError,
+  isTrezor: boolean,
+  isHardwareWallet: boolean,
   onDownloadPDF: Function,
   onRestart: Function,
   onExternalLinkClick: Function,
+  hwDeviceStatus: HwDeviceStatus,
 };
 
 @observer
@@ -68,6 +73,9 @@ export default class VotingRegistrationDialogWizard extends Component<Props> {
       onExternalLinkClick,
       onClose,
       onBack,
+      hwDeviceStatus,
+      isTrezor,
+      isHardwareWallet,
     } = this.props;
 
     const selectedWalletId = get(selectedWallet, 'id', null);
@@ -87,6 +95,8 @@ export default class VotingRegistrationDialogWizard extends Component<Props> {
             onSelectWallet={onSelectWallet}
             isWalletAcceptable={isWalletAcceptable}
             getStakePoolById={getStakePoolById}
+            isTrezor={isTrezor}
+            isHardwareWallet={isHardwareWallet}
           />
         );
         break;
@@ -103,6 +113,10 @@ export default class VotingRegistrationDialogWizard extends Component<Props> {
             onConfirm={onSubmit}
             onBack={onBack}
             onExternalLinkClick={onExternalLinkClick}
+            hwDeviceStatus={hwDeviceStatus}
+            selectedWallet={selectedWallet}
+            isTrezor={isTrezor}
+            isHardwareWallet={isHardwareWallet}
           />
         );
         break;

source/renderer/app/components/voting/voting-registration-wizard-steps/VotingRegistrationStepsChooseWallet.js

@@ -83,6 +83,8 @@ type Props = {
   selectedWalletId: ?string,
   isWalletAcceptable: Function,
   getStakePoolById: Function,
+  isHardwareWallet: boolean,
+  isTrezor: boolean,
 };
 
 type State = {
@@ -122,6 +124,8 @@ export default class VotingRegistrationStepsChooseWallet extends Component<
       isWalletAcceptable,
       numberOfStakePools,
       getStakePoolById,
+      isHardwareWallet,
+      isTrezor,
     } = this.props;
 
     const buttonLabel = intl.formatMessage(messages.continueButtonLabel);
@@ -130,24 +134,18 @@ export default class VotingRegistrationStepsChooseWallet extends Component<
       (wallet: Wallet) => wallet && wallet.id === selectedWalletId
     );
 
-    const { amount, reward, isLegacy, isHardwareWallet, isRestoring } =
-      selectedWallet || {};
+    const { amount, reward, isLegacy, isRestoring } = selectedWallet || {};
 
     let errorMessage;
     if (
       selectedWallet &&
-      !isWalletAcceptable(
-        isLegacy,
-        isHardwareWallet,
-        isRestoring,
-        amount,
-        reward
-      )
+      !isWalletAcceptable(isLegacy, isRestoring, amount, reward)
     ) {
       // Wallet is a legacy wallet
       if (isLegacy) errorMessage = messages.errorLegacyWallet;
-      // Wallet is a hardware wallet
-      else if (isHardwareWallet) errorMessage = messages.errorHardwareWallet;
+      // Wallet is a hardware wallet (Trezor device type)
+      else if (isHardwareWallet && isTrezor)
+        errorMessage = messages.errorHardwareWallet;
       // Wallet is restoring
       else if (isRestoring) errorMessage = messages.errorRestoringWallet;
       // Wallet only has Reward balance