feat!: witnesser witness method now takes a complete serializable Transaction

BREAKING CHANGE: Witnesser witness method now takes a complete serializable Transaction

Author: AngelCastilloB

packages/key-management/src/InMemoryKeyAgent.ts

@@ -161,6 +161,7 @@ export class InMemoryKeyAgent extends KeyAgentBase implements KeyAgent {
   async #decryptRootPrivateKey(noCache?: true) {
     const passphrase = await getPassphraseRethrowTypedError(() => this.#getPassphrase(noCache));
     let decryptedRootKeyBytes: Uint8Array;
+
     try {
       decryptedRootKeyBytes = await emip3decrypt(
         new Uint8Array((this.serializableData as SerializableInMemoryKeyAgentData).encryptedRootPrivateKeyBytes),

packages/key-management/src/types.ts

@@ -1,5 +1,5 @@
 import * as Crypto from '@cardano-sdk/crypto';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 import { HexBlob, OpaqueString, Shutdown } from '@cardano-sdk/util';
 import { Logger } from 'ts-log';
 import type { Runtime } from 'webextension-polyfill';
@@ -222,12 +222,13 @@ export interface Witnesser {
   /**
    * Generates the witness data for a given transaction.
    *
-   * @param txInternals The transaction body along with its hash for which the witness data is to be generated.
+   * @param transaction The transaction along with its hash for which the witness data is to be generated.
+   * @param context The witness sign transaction context
    * @param options Optional additional parameters that may influence how the witness data is generated.
    * @returns A promise that resolves to the generated witness data for the transaction.
    */
   witness(
-    txInternals: Cardano.TxBodyWithHash,
+    transaction: Serialization.Transaction,
     context: SignTransactionContext,
     options?: WitnessOptions
   ): Promise<Cardano.Witness>;

packages/key-management/src/util/createWitnesser.ts

@@ -7,7 +7,7 @@ import {
   WitnessOptions,
   Witnesser
 } from '../types';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 import { HexBlob } from '@cardano-sdk/util';
 
 /** A witnesser that uses a {@link KeyAgent} to generate witness data for a transaction. */
@@ -19,11 +19,20 @@ export class Bip32Ed25519Witnesser implements Witnesser {
   }
 
   async witness(
-    txInternals: Cardano.TxBodyWithHash,
+    tx: Serialization.Transaction,
     context: SignTransactionContext,
     options: WitnessOptions
   ): Promise<Cardano.Witness> {
-    return { signatures: await this.#keyAgent.signTransaction(txInternals, context, options) };
+    return {
+      signatures: await this.#keyAgent.signTransaction(
+        {
+          body: tx.body().toCore(),
+          hash: tx.getId()
+        },
+        context,
+        options
+      )
+    };
   }
 
   async signBlob(

packages/key-management/test/util/createWitnesser.test.ts

@@ -1,5 +1,5 @@
 import { AsyncKeyAgent, SignBlobResult, Witnesser, util } from '../../src';
-import { Cardano } from '@cardano-sdk/core';
+import { Cardano, Serialization } from '@cardano-sdk/core';
 import { HexBlob } from '@cardano-sdk/util';
 
 describe('createBip32Ed25519Witnesser', () => {
@@ -24,14 +24,20 @@ describe('createBip32Ed25519Witnesser', () => {
   });
 
   it('signTransaction is unchanged', async () => {
+    const transaction = new Serialization.Transaction(
+      Serialization.TransactionBody.fromCore({ fee: 20_000n, inputs: [], outputs: [], validityInterval: {} }),
+      new Serialization.TransactionWitnessSet()
+    );
+
     const txInternals = {
-      body: { fee: 20_000n, inputs: [], outputs: [], validityInterval: {} } as Cardano.HydratedTxBody,
-      hash: Cardano.TransactionId('8561258e210352fba2ac0488afed67b3427a27ccf1d41ec030c98a8199bc22ec')
+      body: transaction.body().toCore(),
+      hash: Cardano.TransactionId('3643bb5fe745ba0532977f82ecf54699963c97adef2626f7c780225d218e9ba6')
     };
+
     const options = { knownAddresses: [], txInKeyPathMap: {} };
     const result = {} as Cardano.Signatures;
     asyncKeyAgent.signTransaction.mockResolvedValueOnce(result);
-    await expect(witnesser.witness(txInternals, options)).resolves.toEqual({ signatures: result });
+    await expect(witnesser.witness(transaction, options)).resolves.toEqual({ signatures: result });
     expect(asyncKeyAgent.signTransaction).toBeCalledWith(txInternals, options, void 0);
   });
 });

packages/tx-construction/src/tx-builder/finalizeTx.ts

@@ -1,4 +1,4 @@
-import { Cardano, TxCBOR } from '@cardano-sdk/core';
+import { Cardano, Serialization, TxCBOR } from '@cardano-sdk/core';
 import { FinalizeTxDependencies, SignedTx, TxContext } from './types';
 import {
   SignTransactionContext,
@@ -15,7 +15,14 @@ const getSignatures = async (
   signingOptions?: SignTransactionOptions,
   extraSigners?: TransactionSigner[]
 ) => {
-  const { signatures } = await witnesser.witness(txInternals, signingContext, signingOptions);
+  const { signatures } = await witnesser.witness(
+    new Serialization.Transaction(
+      Serialization.TransactionBody.fromCore(txInternals.body),
+      new Serialization.TransactionWitnessSet()
+    ),
+    signingContext,
+    signingOptions
+  );
 
   if (extraSigners) {
     for (const extraSigner of extraSigners) {