fix(hardware-ledger): transaction outputs format are now computed independently

Author: AngelCastilloB

packages/hardware-ledger/src/LedgerKeyAgent.ts

@@ -1,5 +1,6 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import * as Crypto from '@cardano-sdk/crypto';
+import * as Ledger from '@cardano-foundation/ledgerjs-hw-app-cardano';
 import {
   AlgorithmId,
   CBORValue,
@@ -720,13 +721,21 @@ export class LedgerKeyAgent extends KeyAgentBase {
       const dRepPublicKey = await this.derivePublicKey(util.DREP_KEY_DERIVATION_PATH);
       const dRepKeyHashHex = (await Crypto.Ed25519PublicKey.fromHex(dRepPublicKey).hash()).hex();
 
+      const outputsFormat = txBody
+        .outputs()
+        .map((out) => (out.isBabbageOutput() ? Ledger.TxOutputFormat.MAP_BABBAGE : Ledger.TxOutputFormat.ARRAY_LEGACY));
+      const collateralReturnFormat = txBody.collateralReturn()?.isBabbageOutput()
+        ? Ledger.TxOutputFormat.MAP_BABBAGE
+        : Ledger.TxOutputFormat.ARRAY_LEGACY;
+
       const ledgerTxData = await toLedgerTx(body, {
         accountIndex: this.accountIndex,
         chainId: this.chainId,
+        collateralReturnFormat,
         dRepKeyHashHex,
         knownAddresses,
-        txInKeyPathMap,
-        useBabbageOutputs: txBody.hasBabbageOutput()
+        outputsFormat,
+        txInKeyPathMap
       });
 
       const deviceConnection = await LedgerKeyAgent.checkDeviceConnection(

packages/hardware-ledger/src/transformers/collateralOutput.ts

@@ -3,4 +3,4 @@ import { LedgerTxTransformerContext } from '../types';
 import { toTxOut } from './txOut';
 
 export const mapCollateralTxOut = (collateralTxOut: Cardano.TxOut | undefined, context: LedgerTxTransformerContext) =>
-  collateralTxOut ? toTxOut(collateralTxOut, context) : null;
+  collateralTxOut ? toTxOut({ index: 0, isCollateral: true, txOut: collateralTxOut }, context) : null;

packages/hardware-ledger/src/transformers/txOut.ts

@@ -56,27 +56,33 @@ const getScriptHex = (output: Serialization.TransactionOutput): HexBlob | null =
   return scriptRef.toCbor();
 };
 
-export const toTxOut: Transform<Cardano.TxOut, Ledger.TxOutput, LedgerTxTransformerContext> = (txOut, context) => {
+export const toTxOut: Transform<
+  { txOut: Cardano.TxOut; index: number; isCollateral: boolean },
+  Ledger.TxOutput,
+  LedgerTxTransformerContext
+> = (elem, context) => {
+  const { txOut, index, isCollateral } = elem;
   const output = Serialization.TransactionOutput.fromCore(txOut);
   const scriptHex = getScriptHex(output);
+  const format = isCollateral ? context?.collateralReturnFormat : context?.outputsFormat[index];
+  const isBabbageFormat = format === Ledger.TxOutputFormat.MAP_BABBAGE;
 
-  return context?.useBabbageOutputs
-    ? {
-        amount: txOut.value.coins,
-        datum: txOut.datumHash ? toDatumHash(txOut.datumHash) : txOut.datum ? toInlineDatum(txOut.datum) : null,
-        destination: toDestination(txOut, context),
-        format: Ledger.TxOutputFormat.MAP_BABBAGE,
-        referenceScriptHex: scriptHex,
-        tokenBundle: mapTokenMap(txOut.value.assets)
-      }
-    : {
-        amount: txOut.value.coins,
-        datumHashHex: txOut.datumHash ? txOut.datumHash : null,
-        destination: toDestination(txOut, context),
-        format: Ledger.TxOutputFormat.ARRAY_LEGACY,
-        tokenBundle: mapTokenMap(txOut.value.assets)
-      };
+  return {
+    amount: txOut.value.coins,
+    destination: toDestination(txOut, context),
+    tokenBundle: mapTokenMap(txOut.value.assets),
+    ...(isBabbageFormat
+      ? {
+          datum: txOut.datumHash ? toDatumHash(txOut.datumHash) : txOut.datum ? toInlineDatum(txOut.datum) : null,
+          format: Ledger.TxOutputFormat.MAP_BABBAGE,
+          referenceScriptHex: scriptHex
+        }
+      : {
+          datumHashHex: txOut.datumHash ?? null,
+          format: Ledger.TxOutputFormat.ARRAY_LEGACY
+        })
+  };
 };
 
 export const mapTxOuts = (txOuts: Cardano.TxOut[], context: LedgerTxTransformerContext): Ledger.TxOutput[] =>
-  txOuts.map((txOut) => toTxOut(txOut, context));
+  txOuts.map((txOut, index) => toTxOut({ index, isCollateral: false, txOut }, context));

packages/hardware-ledger/src/types.ts

@@ -1,6 +1,7 @@
 import { Cardano } from '@cardano-sdk/core';
 import { HID } from 'node-hid';
 import { SignTransactionContext } from '@cardano-sdk/key-management';
+import { TxOutputFormat } from '@cardano-foundation/ledgerjs-hw-app-cardano';
 import TransportNodeHid from '@ledgerhq/hw-transport-node-hid-noevents';
 import TransportWebUSB from '@ledgerhq/hw-transport-webusb';
 
@@ -21,6 +22,8 @@ export type LedgerTxTransformerContext = {
   chainId: Cardano.ChainId;
   /** Non-hardened account in cip1852 */
   accountIndex: number;
-  /** Whether to use Babbage output format or not. */
-  useBabbageOutputs: boolean;
+  /** The outputs format in the same order as they appear in the transaction. */
+  outputsFormat: Array<TxOutputFormat>;
+  /** The collateral return output format. */
+  collateralReturnFormat: TxOutputFormat | undefined;
 } & SignTransactionContext;

packages/hardware-ledger/test/testData.ts

@@ -1,4 +1,5 @@
 import * as Crypto from '@cardano-sdk/crypto';
+import * as Ledger from '@cardano-foundation/ledgerjs-hw-app-cardano';
 import { AddressType, KeyRole } from '@cardano-sdk/key-management';
 import { Base64Blob, HexBlob } from '@cardano-sdk/util';
 import { Cardano, Serialization } from '@cardano-sdk/core';
@@ -342,6 +343,7 @@ export const CONTEXT_WITH_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
     networkId: Cardano.NetworkId.Testnet,
     networkMagic: 999
   },
+  collateralReturnFormat: Ledger.TxOutputFormat.MAP_BABBAGE,
   dRepKeyHashHex: Crypto.Ed25519KeyHashHex(dRepCredential.hash),
   knownAddresses: [
     {
@@ -357,8 +359,8 @@ export const CONTEXT_WITH_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
       type: AddressType.Internal
     }
   ],
-  txInKeyPathMap: {},
-  useBabbageOutputs: true
+  outputsFormat: [Ledger.TxOutputFormat.ARRAY_LEGACY, Ledger.TxOutputFormat.MAP_BABBAGE],
+  txInKeyPathMap: {}
 };
 
 export const CONTEXT_WITHOUT_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
@@ -367,9 +369,10 @@ export const CONTEXT_WITHOUT_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
     networkId: Cardano.NetworkId.Testnet,
     networkMagic: 999
   },
+  collateralReturnFormat: Ledger.TxOutputFormat.ARRAY_LEGACY,
   knownAddresses: [],
-  txInKeyPathMap: {},
-  useBabbageOutputs: true
+  outputsFormat: [Ledger.TxOutputFormat.ARRAY_LEGACY, Ledger.TxOutputFormat.MAP_BABBAGE],
+  txInKeyPathMap: {}
 };
 
 export const votes = [

packages/hardware-ledger/test/transformers/certificates.test.ts

@@ -73,20 +73,21 @@ export const createTxInKeyPathMapMock = (knownAddresses: GroupedAddress[]): TxIn
 const mockContext: LedgerTxTransformerContext = {
   accountIndex: 0,
   chainId: createChainId(1, 764_824_073),
+  collateralReturnFormat: Ledger.TxOutputFormat.ARRAY_LEGACY,
+
   dRepKeyHashHex: undefined,
 
   handleResolutions: [],
-
   knownAddresses: [
     createGroupedAddress(address1, ownRewardAccount, AddressType.External, 0, stakeKeyPath),
     createGroupedAddress(address2, ownRewardAccount, AddressType.External, 1, stakeKeyPath)
   ],
+  outputsFormat: [Ledger.TxOutputFormat.ARRAY_LEGACY, Ledger.TxOutputFormat.MAP_BABBAGE],
   sender: undefined,
   txInKeyPathMap: createTxInKeyPathMapMock([
     createGroupedAddress(address1, ownRewardAccount, AddressType.External, 0, stakeKeyPath),
     createGroupedAddress(address2, ownRewardAccount, AddressType.External, 1, stakeKeyPath)
-  ]),
-  useBabbageOutputs: true
+  ])
 };
 
 const EXAMPLE_URL = 'https://example.com';

packages/hardware-ledger/test/transformers/tx.test.ts

@@ -15,8 +15,7 @@ describe('tx', () => {
           txInKeyPathMap: {
             [TxInId(tx.body.inputs[0])]: paymentKeyPath,
             [TxInId(tx.body.collaterals![0])]: paymentKeyPath
-          },
-          useBabbageOutputs: false
+          }
         })
       ).toEqual({
         auxiliaryData: {
@@ -181,6 +180,7 @@ describe('tx', () => {
       expect(
         await toLedgerTx(babbageTxWithoutScript.body, {
           ...CONTEXT_WITH_KNOWN_ADDRESSES,
+          outputsFormat: [Ledger.TxOutputFormat.MAP_BABBAGE],
           txInKeyPathMap: {
             [TxInId(babbageTxWithoutScript.body.inputs[0])]: paymentKeyPath
           }
@@ -266,12 +266,7 @@ describe('tx', () => {
         ]
       };
 
-      expect(
-        await toLedgerTx(txBodyWithRegistrationCert, {
-          ...CONTEXT_WITH_KNOWN_ADDRESSES,
-          useBabbageOutputs: false
-        })
-      ).toEqual({
+      expect(await toLedgerTx(txBodyWithRegistrationCert, CONTEXT_WITH_KNOWN_ADDRESSES)).toEqual({
         auxiliaryData: {
           params: {
             hashHex: '2ceb364d93225b4a0f004a0975a13eb50c3cc6348474b4fe9121f8dc72ca0cfa'

packages/hardware-ledger/test/transformers/txOut.test.ts

@@ -18,7 +18,14 @@ describe('txOut', () => {
           txOutWithReferenceScriptWithInlineDatum,
           txOutWithReferenceScriptWithInlineDatum
         ],
-        CONTEXT_WITH_KNOWN_ADDRESSES
+        {
+          ...CONTEXT_WITH_KNOWN_ADDRESSES,
+          outputsFormat: [
+            Ledger.TxOutputFormat.MAP_BABBAGE,
+            Ledger.TxOutputFormat.MAP_BABBAGE,
+            Ledger.TxOutputFormat.MAP_BABBAGE
+          ]
+        }
       );
 
       expect(txOuts.length).toEqual(3);
@@ -64,7 +71,7 @@ describe('txOut', () => {
 
   describe('toTxOut', () => {
     it('can map a simple txOut to third party address', async () => {
-      const out = toTxOut(txOut, { ...CONTEXT_WITH_KNOWN_ADDRESSES, useBabbageOutputs: false });
+      const out = toTxOut({ index: 0, isCollateral: false, txOut }, CONTEXT_WITH_KNOWN_ADDRESSES);
 
       expect(out).toEqual({
         amount: 10n,
@@ -114,7 +121,7 @@ describe('txOut', () => {
     });
 
     it('can map a simple txOut to owned address', async () => {
-      const out = toTxOut(txOutToOwnedAddress, { ...CONTEXT_WITH_KNOWN_ADDRESSES, useBabbageOutputs: false });
+      const out = toTxOut({ index: 0, isCollateral: false, txOut: txOutToOwnedAddress }, CONTEXT_WITH_KNOWN_ADDRESSES);
 
       expect(out).toEqual({
         amount: 10n,
@@ -179,7 +186,10 @@ describe('txOut', () => {
     });
 
     it('can map a txOut with a reference script - datum hash', async () => {
-      const out = toTxOut(txOutWithReferenceScript, CONTEXT_WITH_KNOWN_ADDRESSES);
+      const out = toTxOut(
+        { index: 1, isCollateral: false, txOut: txOutWithReferenceScript },
+        CONTEXT_WITH_KNOWN_ADDRESSES
+      );
 
       expect(out).toEqual({
         amount: 10n,
@@ -216,7 +226,10 @@ describe('txOut', () => {
     });
 
     it('can map a txOut with a reference script - inline datum', async () => {
-      const out = toTxOut(txOutWithReferenceScriptWithInlineDatum, CONTEXT_WITH_KNOWN_ADDRESSES);
+      const out = toTxOut(
+        { index: 1, isCollateral: false, txOut: txOutWithReferenceScriptWithInlineDatum },
+        CONTEXT_WITH_KNOWN_ADDRESSES
+      );
 
       expect(out).toEqual({
         amount: 10n,