fix(ledger): fix output format mapping on ledger HW devices

Author: AngelCastilloB

packages/hardware-ledger/src/LedgerKeyAgent.ts

@@ -715,15 +715,18 @@ export class LedgerKeyAgent extends KeyAgentBase {
   ): Promise<Cardano.Signatures> {
     try {
       const body = txBody.toCore();
+
       const hash = txBody.hash() as unknown as HexBlob;
       const dRepPublicKey = await this.derivePublicKey(util.DREP_KEY_DERIVATION_PATH);
       const dRepKeyHashHex = (await Crypto.Ed25519PublicKey.fromHex(dRepPublicKey).hash()).hex();
+
       const ledgerTxData = await toLedgerTx(body, {
         accountIndex: this.accountIndex,
         chainId: this.chainId,
         dRepKeyHashHex,
         knownAddresses,
-        txInKeyPathMap
+        txInKeyPathMap,
+        useBabbageOutputs: txBody.hasBabbageOutput()
       });
 
       const deviceConnection = await LedgerKeyAgent.checkDeviceConnection(

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

@@ -56,39 +56,11 @@ const getScriptHex = (output: Serialization.TransactionOutput): HexBlob | null =
   return scriptRef.toCbor();
 };
 
-/**
- * There are currently two types of outputs supported by the ledger:
- *
- * legacy_transaction_output =
- *   [ address
- *   , amount : value
- *   , ? datum_hash : $hash32
- *   ]
- *
- * and
- *
- * post_alonzo_transaction_output =
- *   { 0 : address
- *   , 1 : value
- *   , ? 2 : datum_option ; New; datum option
- *   , ? 3 : script_ref   ; New; script reference
- *   }
- *
- * Legacy outputs are definite length arrays of three elements, however the new babbage outputs are definite length maps
- * of four elements.
- *
- * @param out The output to be verified.
- */
-const isBabbage = (out: Serialization.TransactionOutput): boolean => {
-  const reader = new Serialization.CborReader(out.toCbor());
-  return reader.peekState() === Serialization.CborReaderState.StartMap;
-};
-
 export const toTxOut: Transform<Cardano.TxOut, Ledger.TxOutput, LedgerTxTransformerContext> = (txOut, context) => {
   const output = Serialization.TransactionOutput.fromCore(txOut);
   const scriptHex = getScriptHex(output);
 
-  return isBabbage(output)
+  return context?.useBabbageOutputs
     ? {
         amount: txOut.value.coins,
         datum: txOut.datumHash ? toDatumHash(txOut.datumHash) : txOut.datum ? toInlineDatum(txOut.datum) : null,

packages/hardware-ledger/src/types.ts

@@ -21,4 +21,6 @@ export type LedgerTxTransformerContext = {
   chainId: Cardano.ChainId;
   /** Non-hardened account in cip1852 */
   accountIndex: number;
+  /** Whether to use Babbage output format or not. */
+  useBabbageOutputs: boolean;
 } & SignTransactionContext;

packages/hardware-ledger/test/testData.ts

@@ -357,7 +357,8 @@ export const CONTEXT_WITH_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
       type: AddressType.Internal
     }
   ],
-  txInKeyPathMap: {}
+  txInKeyPathMap: {},
+  useBabbageOutputs: true
 };
 
 export const CONTEXT_WITHOUT_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
@@ -367,7 +368,8 @@ export const CONTEXT_WITHOUT_KNOWN_ADDRESSES: LedgerTxTransformerContext = {
     networkMagic: 999
   },
   knownAddresses: [],
-  txInKeyPathMap: {}
+  txInKeyPathMap: {},
+  useBabbageOutputs: true
 };
 
 export const votes = [

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

@@ -85,7 +85,8 @@ const mockContext: LedgerTxTransformerContext = {
   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,7 +15,8 @@ describe('tx', () => {
           txInKeyPathMap: {
             [TxInId(tx.body.inputs[0])]: paymentKeyPath,
             [TxInId(tx.body.collaterals![0])]: paymentKeyPath
-          }
+          },
+          useBabbageOutputs: false
         })
       ).toEqual({
         auxiliaryData: {
@@ -267,7 +268,8 @@ describe('tx', () => {
 
       expect(
         await toLedgerTx(txBodyWithRegistrationCert, {
-          ...CONTEXT_WITH_KNOWN_ADDRESSES
+          ...CONTEXT_WITH_KNOWN_ADDRESSES,
+          useBabbageOutputs: false
         })
       ).toEqual({
         auxiliaryData: {

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

@@ -64,7 +64,7 @@ describe('txOut', () => {
 
   describe('toTxOut', () => {
     it('can map a simple txOut to third party address', async () => {
-      const out = toTxOut(txOut, CONTEXT_WITH_KNOWN_ADDRESSES);
+      const out = toTxOut(txOut, { ...CONTEXT_WITH_KNOWN_ADDRESSES, useBabbageOutputs: false });
 
       expect(out).toEqual({
         amount: 10n,
@@ -114,7 +114,7 @@ describe('txOut', () => {
     });
 
     it('can map a simple txOut to owned address', async () => {
-      const out = toTxOut(txOutToOwnedAddress, CONTEXT_WITH_KNOWN_ADDRESSES);
+      const out = toTxOut(txOutToOwnedAddress, { ...CONTEXT_WITH_KNOWN_ADDRESSES, useBabbageOutputs: false });
 
       expect(out).toEqual({
         amount: 10n,

packages/wallet/test/hardware/ledger/LedgerKeyAgent.test.ts

@@ -230,6 +230,15 @@ describe('LedgerKeyAgent', () => {
         expect(signatures.size).toBe(2);
       });
 
+      it('successfully signs ADA handle mint transaction', async () => {
+        const cbor =
+          '84a500818258207aa1264bcd0c06f34a49ed1dd7307a2bdec5a97bdeb546498759ad5b8ed42fd5010182a200583930195bde3deacb613b7e9eb6280b14db4e353e475e96d19f3f7a5e2d66195bde3deacb613b7e9eb6280b14db4e353e475e96d19f3f7a5e2d66011a00e4e1c0a2005839003d3246dc0c50ab3c74a8ffdd8068313ff99d341c461a8fe31f416d0a8fba06d60d71edc077cc5ebcb8ff82137afbce68df98271909332348011b000000025106a838021a00029309031a04a07bc6081a04a07a40a0f5f6';
+        const {
+          witness: { signatures }
+        } = await wallet.finalizeTx({ tx: cbor as any });
+        expect(signatures.size).toBe(1);
+      });
+
       it('throws if signed transaction hash doesnt match hash computed by the wallet', async () => {
         const originalHashFn = Serialization.TransactionBody.prototype.hash;
         jest