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

Author: AngelCastilloB

packages/hardware-trezor/src/TrezorKeyAgent.ts

@@ -251,7 +251,8 @@ export class TrezorKeyAgent extends KeyAgentBase {
         chainId: this.chainId,
         knownAddresses,
         tagCborSets: txBody.hasTaggedSets(),
-        txInKeyPathMap
+        txInKeyPathMap,
+        useBabbageOutputs: txBody.hasBabbageOutput()
       });
 
       const signingMode = TrezorKeyAgent.matchSigningMode(trezorTxData);

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

@@ -40,42 +40,14 @@ const getScriptHex = (output: Serialization.TransactionOutput): HexBlob | undefi
   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;
-};
-
 const getInlineDatum = (datum: Cardano.PlutusData): string => Serialization.PlutusData.fromCore(datum).toCbor();
 
 export const toTxOut: Transform<Cardano.TxOut, Trezor.CardanoOutput, TrezorTxTransformerContext> = (txOut, context) => {
   const destination = toDestination(txOut, context);
   const output = Serialization.TransactionOutput.fromCore(txOut);
   const scriptHex = getScriptHex(output);
 
-  return isBabbage(output)
+  return context?.useBabbageOutputs
     ? {
         ...destination,
         amount: txOut.value.coins.toString(),

packages/hardware-trezor/src/types.ts

@@ -13,6 +13,8 @@ export type TrezorTxTransformerContext = {
   accountIndex: number;
   /** Whether sets should be encoded as tagged set in CBOR */
   tagCborSets: boolean;
+  /** Whether to use Babbage output format or not. */
+  useBabbageOutputs: boolean;
 } & SignTransactionContext;
 
 export type TrezorTxOutputDestination =

packages/hardware-trezor/test/testData.ts

@@ -171,7 +171,8 @@ export const contextWithKnownAddresses: TrezorTxTransformerContext = {
   },
   knownAddresses: [knownAddress],
   tagCborSets: false,
-  txInKeyPathMap: {}
+  txInKeyPathMap: {},
+  useBabbageOutputs: false
 };
 
 export const contextWithKnownAddressesWithoutStakingCredentials: TrezorTxTransformerContext = {
@@ -182,7 +183,8 @@ export const contextWithKnownAddressesWithoutStakingCredentials: TrezorTxTransfo
   },
   knownAddresses: [knownAddressWithoutStakingPath],
   tagCborSets: false,
-  txInKeyPathMap: {}
+  txInKeyPathMap: {},
+  useBabbageOutputs: false
 };
 
 export const contextWithoutKnownAddresses: TrezorTxTransformerContext = {
@@ -193,7 +195,8 @@ export const contextWithoutKnownAddresses: TrezorTxTransformerContext = {
   },
   knownAddresses: [],
   tagCborSets: false,
-  txInKeyPathMap: {}
+  txInKeyPathMap: {},
+  useBabbageOutputs: false
 };
 
 export const coreWithdrawalWithKeyHashCredential = {

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

@@ -204,7 +204,8 @@ describe('tx', () => {
           ...contextWithKnownAddresses,
           txInKeyPathMap: {
             [TxInId(babbageTxBodyWithScripts.inputs[0])]: knownAddressPaymentKeyPath
-          }
+          },
+          useBabbageOutputs: true
         })
       ).toEqual({
         additionalWitnessRequests: [
@@ -327,7 +328,8 @@ describe('tx', () => {
           txInKeyPathMap: {
             [TxInId(plutusTxWithBabbage.inputs[0])]: knownAddressPaymentKeyPath,
             [TxInId(plutusTxWithBabbage.collaterals[0])]: knownAddressPaymentKeyPath
-          }
+          },
+          useBabbageOutputs: true
         })
       ).toEqual({
         additionalWitnessRequests: [
@@ -361,7 +363,7 @@ describe('tx', () => {
           address:
             'addr_test1qz2fxv2umyhttkxyxp8x0dlpdt3k6cwng5pxj3jhsydzer3jcu5d8ps7zex2k2xt3uqxgjqnnj83ws8lhrn648jjxtwq2ytjqp',
           amount: '10',
-          format: Trezor.PROTO.CardanoTxOutputSerializationFormat.ARRAY_LEGACY
+          format: Trezor.PROTO.CardanoTxOutputSerializationFormat.MAP_BABBAGE
         },
         fee: '10',
         inputs: [

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

@@ -156,14 +156,16 @@ describe('txOut', () => {
     });
 
     it('can map a set of transaction outputs with both output formats', async () => {
-      const txOuts = mapTxOuts(
-        [txOutWithDatumHashAndOwnedAddress, txOutWithReferenceScriptAndDatumHash],
-        contextWithKnownAddresses
-      );
+      const legacyTxOuts = mapTxOuts([txOutWithDatumHashAndOwnedAddress], contextWithKnownAddresses);
 
-      expect(txOuts.length).toEqual(2);
+      const babbageTxOuts = mapTxOuts([txOutWithReferenceScriptAndDatumHash], {
+        ...contextWithKnownAddresses,
+        useBabbageOutputs: true
+      });
 
-      expect(txOuts).toEqual([
+      expect(legacyTxOuts.length).toEqual(1);
+
+      expect(legacyTxOuts).toEqual([
         {
           addressParameters: {
             addressType: Trezor.PROTO.CardanoAddressType.BASE,
@@ -173,7 +175,12 @@ describe('txOut', () => {
           amount: '10',
           datumHash: '0f3abbc8fc19c2e61bab6059bf8a466e6e754833a08a62a6c56fe0e78f19d9d5',
           format: Trezor.PROTO.CardanoTxOutputSerializationFormat.ARRAY_LEGACY
-        },
+        }
+      ]);
+
+      expect(babbageTxOuts.length).toEqual(1);
+
+      expect(babbageTxOuts).toEqual([
         {
           addressParameters: {
             addressType: Trezor.PROTO.CardanoAddressType.BASE,
@@ -332,7 +339,7 @@ describe('txOut', () => {
     });
 
     it('can map simple transaction with inline datum', async () => {
-      const out = toTxOut(txOutWithInlineDatum, contextWithKnownAddresses);
+      const out = toTxOut(txOutWithInlineDatum, { ...contextWithKnownAddresses, useBabbageOutputs: true });
 
       expect(out).toEqual({
         address:
@@ -344,7 +351,10 @@ describe('txOut', () => {
     });
 
     it('can map simple transaction with inline datum to owned address', async () => {
-      const out = toTxOut(txOutWithInlineDatumAndOwnedAddress, contextWithKnownAddresses);
+      const out = toTxOut(txOutWithInlineDatumAndOwnedAddress, {
+        ...contextWithKnownAddresses,
+        useBabbageOutputs: true
+      });
 
       expect(out).toEqual({
         addressParameters: {
@@ -359,7 +369,10 @@ describe('txOut', () => {
     });
 
     it('can map a simple transaction output with reference script and datum hash', async () => {
-      const out = toTxOut(txOutWithReferenceScriptAndDatumHash, contextWithKnownAddresses);
+      const out = toTxOut(txOutWithReferenceScriptAndDatumHash, {
+        ...contextWithKnownAddresses,
+        useBabbageOutputs: true
+      });
       expect(out).toEqual({
         addressParameters: {
           addressType: Trezor.PROTO.CardanoAddressType.BASE,
@@ -374,7 +387,10 @@ describe('txOut', () => {
     });
 
     it('can map a simple transaction output with reference script and inline datum', async () => {
-      const out = toTxOut(txOutWithReferenceScriptAndInlineDatum, contextWithKnownAddresses);
+      const out = toTxOut(txOutWithReferenceScriptAndInlineDatum, {
+        ...contextWithKnownAddresses,
+        useBabbageOutputs: true
+      });
       expect(out).toEqual({
         addressParameters: {
           addressType: Trezor.PROTO.CardanoAddressType.BASE,