[fix/4.22.100] Ledger app 5 catalyst registration adaptation

packages/yoroi-extension/app/api/ada/index.js

@@ -297,6 +297,7 @@ export type CreateLedgerSignTxDataRequest = {|
   signRequest: HaskellShelleyTxSignRequest,
   network: $ReadOnly<NetworkRow>,
   addressingMap: string => (void | $PropertyType<Addressing, 'addressing'>),
+  cip36: boolean,
 |};
 export type CreateLedgerSignTxDataResponse = {|
   ledgerSignTxPayload: SignTransactionRequest,
@@ -961,6 +962,7 @@ export default class AdaApi {
         byronNetworkMagic: config.ByronNetworkId,
         networkId: Number.parseInt(config.ChainNetworkId, 10),
         addressingMap: request.addressingMap,
+        cip36: request.cip36,
       });
 
       Logger.debug(`${nameof(AdaApi)}::${nameof(this.createLedgerSignTxData)} success: ` + stringifyData(ledgerSignTxPayload));
@@ -2382,6 +2384,8 @@ export default class AdaApi {
     const usedUtxos = signRequest.senderUtxos.map(utxo => (
       { txHash: utxo.tx_hash, index: utxo.tx_index }
     ));
+    const metadata = signRequest.unsignedTx.get_auxiliary_data();
+
     const transaction = CardanoShelleyTransaction.fromData({
       txid: txId,
       type: isIntraWallet ? 'self' : 'expend',
@@ -2397,8 +2401,8 @@ export default class AdaApi {
       block: null,
       certificates: [],
       ttl: new BigNumber(String(signRequest.unsignedTx.build().ttl())),
-      metadata: signRequest.metadata
-        ? Buffer.from(signRequest.metadata.to_bytes()).toString('hex')
+      metadata: metadata
+        ? Buffer.from(metadata.to_bytes()).toString('hex')
         : null,
       withdrawals: signRequest.withdrawals().map(withdrawal => ({
         address: withdrawal.address,

packages/yoroi-extension/app/api/ada/lib/cardanoCrypto/catalyst.js

@@ -102,3 +102,74 @@ export function generateRegistration(request: {|
     (hashedMetadata) => request.stakePrivateKey.sign(hashedMetadata).to_hex(),
   );
 }
+
+export function generateCip15RegistrationMetadata(
+  votingPublicKey: string,
+  stakingPublicKey: string,
+  rewardAddress: string,
+  nonce: number,
+  signer: Uint8Array => string,
+): RustModule.WalletV4.AuxiliaryData {
+
+  /**
+    * Catalyst follows a certain standard to prove the voting power
+    * A transaction is submitted with following metadata format for the registration process
+    * label: 61284
+    * {
+    *   1: "pubkey generated for catalyst app",
+    *   2: "stake key public key",
+    *   3: "address to receive rewards to"
+    *   4: "slot number"
+    * }
+    * label: 61285
+    * {
+    *   1: "signature of blake2b-256 hash of the metadata signed using stakekey"
+    * }
+    */
+
+  const registrationData = RustModule.WalletV4.encode_json_str_to_metadatum(
+    JSON.stringify({
+      '1': prefix0x(votingPublicKey),
+      '2': prefix0x(stakingPublicKey),
+      '3': prefix0x(rewardAddress),
+      '4': nonce,
+    }),
+    RustModule.WalletV4.MetadataJsonSchema.BasicConversions
+  );
+  const generalMetadata = RustModule.WalletV4.GeneralTransactionMetadata.new();
+  generalMetadata.insert(
+    RustModule.WalletV4.BigNum.from_str(CatalystLabels.DATA.toString()),
+    registrationData
+  );
+
+  const hashedMetadata = blake2b(256 / 8).update(
+    generalMetadata.to_bytes()
+  ).digest('binary');
+
+  generalMetadata.insert(
+    RustModule.WalletV4.BigNum.from_str(CatalystLabels.SIG.toString()),
+    RustModule.WalletV4.encode_json_str_to_metadatum(
+      JSON.stringify({
+        '1': prefix0x(signer(hashedMetadata)),
+      }),
+      RustModule.WalletV4.MetadataJsonSchema.BasicConversions
+    )
+  );
+
+  // This is how Ledger constructs the metadata. We must be consistent with it.
+  const metadataList = RustModule.WalletV4.MetadataList.new();
+  metadataList.add(
+    RustModule.WalletV4.TransactionMetadatum.from_bytes(
+      generalMetadata.to_bytes()
+    )
+  );
+  metadataList.add(
+    RustModule.WalletV4.TransactionMetadatum.new_list(
+      RustModule.WalletV4.MetadataList.new()
+    )
+  );
+
+  return RustModule.WalletV4.AuxiliaryData.from_bytes(
+    metadataList.to_bytes()
+  );
+}

packages/yoroi-extension/app/api/ada/transactions/shelley/ledgerTx.js

@@ -49,6 +49,7 @@ export async function createLedgerSignTxPayload(request: {|
   byronNetworkMagic: number,
   networkId: number,
   addressingMap: string => (void | $PropertyType<Addressing, 'addressing'>),
+  cip36: boolean,
 |}): Promise<SignTransactionRequest> {
   const txBody = request.signRequest.unsignedTx.build();
 
@@ -94,32 +95,54 @@ export async function createLedgerSignTxPayload(request: {|
     const { votingPublicKey, stakingKeyPath, nonce, paymentKeyPath, } =
       request.signRequest.ledgerNanoCatalystRegistrationTxSignData;
 
-    auxiliaryData = {
-      type: TxAuxiliaryDataType.CIP36_REGISTRATION,
-      params: {
-        format: CIP36VoteRegistrationFormat.CIP_36,
-        delegations: [
-          {
-            type: CIP36VoteDelegationType.KEY,
-            voteKeyHex: votingPublicKey.replace(/^0x/, ''),
-            weight: 1,
+    if (request.cip36) {
+      auxiliaryData = {
+        type: TxAuxiliaryDataType.CIP36_REGISTRATION,
+        params: {
+          format: CIP36VoteRegistrationFormat.CIP_36,
+          delegations: [
+            {
+              type: CIP36VoteDelegationType.KEY,
+              voteKeyHex: votingPublicKey.replace(/^0x/, ''),
+              weight: 1,
+            },
+          ],
+          stakingPath: stakingKeyPath,
+          paymentDestination: {
+            type: TxOutputDestinationType.DEVICE_OWNED,
+            params: {
+              type: AddressType.BASE_PAYMENT_KEY_STAKE_KEY,
+              params: {
+                spendingPath: paymentKeyPath,
+                stakingPath: stakingKeyPath,
+              },
+            },
           },
-        ],
-        stakingPath: stakingKeyPath,
-        paymentDestination: {
-          type: TxOutputDestinationType.DEVICE_OWNED,
-          params: {
-            type: AddressType.BASE_PAYMENT_KEY_STAKE_KEY,
+          nonce,
+          votingPurpose: 0,
+        }
+      };
+    } else {
+      auxiliaryData = {
+        type: TxAuxiliaryDataType.CIP36_REGISTRATION,
+        params: {
+          format: CIP36VoteRegistrationFormat.CIP_15,
+          voteKeyHex: votingPublicKey.replace(/^0x/, ''),
+          stakingPath: stakingKeyPath,
+          paymentDestination: {
+            type: TxOutputDestinationType.DEVICE_OWNED,
             params: {
-              spendingPath: paymentKeyPath,
-              stakingPath: stakingKeyPath,
+              type: AddressType.BASE_PAYMENT_KEY_STAKE_KEY,
+              params: {
+                spendingPath: paymentKeyPath,
+                stakingPath: stakingKeyPath,
+              },
             },
           },
-        },
-        nonce,
-        votingPurpose: 0,
-      }
-    };
+          nonce,
+        }
+      };
+    }
   } else if (request.signRequest.metadata != null) {
     auxiliaryData = {
       type: TxAuxiliaryDataType.ARBITRARY_HASH,

packages/yoroi-extension/app/api/ada/transactions/shelley/ledgerTx.test.js

@@ -351,6 +351,7 @@ test('Create Ledger transaction', async () => {
       }
       return undefined;
     },
+    cip36: true,
   });
 
   expect(response).toStrictEqual(({

packages/yoroi-extension/app/stores/ada/send/LedgerSendStore.js

@@ -45,7 +45,10 @@ import type {
 import { genAddressingLookup } from '../../stateless/addressStores';
 import type { ActionsMap } from '../../../actions/index';
 import type { StoresMap } from '../../index';
-import { generateRegistrationMetadata } from '../../../api/ada/lib/cardanoCrypto/catalyst';
+import {
+  generateRegistrationMetadata,
+  generateCip15RegistrationMetadata,
+} from '../../../api/ada/lib/cardanoCrypto/catalyst';
 
 /** Note: Handles Ledger Signing */
 export default class LedgerSendStore extends Store<StoresMap, ActionsMap> {
@@ -207,18 +210,29 @@ export default class LedgerSendStore extends Store<StoresMap, ActionsMap> {
         locale: this.stores.profile.currentLocale,
       });
 
+      let cip36: boolean = false;
+      if (request.signRequest.ledgerNanoCatalystRegistrationTxSignData) {
+        const getVersionResponse = await ledgerConnect.getVersion({
+          serial: request.expectedSerial,
+          dontCloseTab: true,
+        });
+        cip36 = getVersionResponse.compatibility.supportsCIP36Vote === true;
+      }
+
       const network = request.publicDeriver.getParent().getNetworkInfo();
 
       const { ledgerSignTxPayload } = await this.api.ada.createLedgerSignTxData({
         signRequest: request.signRequest,
         network,
         addressingMap: request.addressingMap,
+        cip36,
       });
 
       const ledgerSignTxResp: LedgerSignTxResponse =
         await ledgerConnect.signTransaction({
           serial: request.expectedSerial,
           params: ledgerSignTxPayload,
+          useOpenTab: true,
         });
 
       // There is no need of ledgerConnect after this line.
@@ -247,15 +261,27 @@ export default class LedgerSendStore extends Store<StoresMap, ActionsMap> {
         const { cip36VoteRegistrationSignatureHex } =
           ledgerSignTxResp.auxiliaryDataSupplement;
 
-        metadata = generateRegistrationMetadata(
-          votingPublicKey,
-          stakingKey,
-          paymentAddress,
-          nonce,
-          (_hashedMetadata) => {
-            return cip36VoteRegistrationSignatureHex;
-          },
-        );
+        if (cip36) {
+          metadata = generateRegistrationMetadata(
+            votingPublicKey,
+            stakingKey,
+            paymentAddress,
+            nonce,
+            (_hashedMetadata) => {
+              return cip36VoteRegistrationSignatureHex;
+            },
+          );
+        } else {
+          metadata = generateCip15RegistrationMetadata(
+            votingPublicKey,
+            stakingKey,
+            paymentAddress,
+            nonce,
+            (_hashedMetadata) => {
+              return cip36VoteRegistrationSignatureHex;
+            },
+          );
+        }
         // We can verify that
         //  Buffer.from(
         //    blake2b(256 / 8).update(metadata.to_bytes()).digest('binary')

packages/yoroi-extension/app/utils/hwConnectHandler.js

@@ -29,6 +29,7 @@ type ShowAddressRequestWrapper = {|
 
 export class LedgerConnect {
   locale: string;
+  tabId: ?number;
 
   constructor(params: {| locale: string |}) {
     this.locale = params.locale;
@@ -59,11 +60,14 @@ export class LedgerConnect {
   signTransaction: {|
     serial: ?string,
     params: SignTransactionRequest,
+    useOpenTab?: boolean,
   |} => Promise<SignTransactionResponse> = (request) => {
     return this._requestLedger(
       OPERATION_NAME.SIGN_TX,
       request.params,
       request.serial,
+      false,
+      request.useOpenTab === true,
     );
   }
 
@@ -78,12 +82,34 @@ export class LedgerConnect {
     );
   }
 
+  getVersion: {|
+    serial: ?string,
+    dontCloseTab?: boolean,
+  |} => Promise<GetVersionResponse> = (request) => {
+    return this._requestLedger(
+      OPERATION_NAME.GET_LEDGER_VERSION,
+      undefined,
+      request.serial,
+      true,
+    );
+  }
+
   async _requestLedger(
     action: string,
     params: any,
     serial: ?string,
+    dontCloseTab?: boolean = false,
+    useOpenTab?: boolean = false,
   ): any {
-    const tabId = await this._createLedgerTab();
+    let tabId;
+    if (useOpenTab && this.tabId != null) {
+      tabId = this.tabId;
+    } else {
+      tabId = await this._createLedgerTab();
+      if (dontCloseTab) {
+        this.tabId = tabId;
+      }
+    }
 
     return new Promise((resolve, reject) => {
       chrome.tabs.sendMessage(