fixup! fix(wallet): base wallet should now use the original CBOR if provided

Author: AngelCastilloB

packages/core/src/Serialization/Transaction.ts

@@ -49,6 +49,26 @@ export class Transaction {
     this.#auxiliaryData = auxiliaryData;
   }
 
+  /**
+   * Creates a transaction object from the given transaction body with an empty witness set and no
+   * auxiliary data.
+   *
+   * @param body Data structure that contains all the elements of the transaction.
+   */
+  static fromBody(body: TransactionBody): Transaction {
+    return new Transaction(body, TransactionWitnessSet.fromCore({ signatures: new Map() }));
+  }
+
+  /**
+   * Creates a transaction object from the given transaction core body with an empty witness set and no
+   * auxiliary data.
+   *
+   * @param body Data structure that contains all the elements of the transaction.
+   */
+  static fromCoreBody(body: Cardano.TxBody): Transaction {
+    return new Transaction(TransactionBody.fromCore(body), TransactionWitnessSet.fromCore({ signatures: new Map() }));
+  }
+
   /**
    * Serializes a transaction into CBOR format.
    *

packages/e2e/src/util/handle-util.ts

@@ -146,13 +146,19 @@ export const mint = async (
 
   const unsignedTx = await wallet.initializeTx(txProps);
 
+  const witness = { redeemers: unsignedTx.redeemers, scripts: [policyScript], signatures: new Map() };
+
+  const serializableTx = new Serialization.Transaction(
+    Serialization.TransactionBody.fromCore(unsignedTx.body),
+    Serialization.TransactionWitnessSet.fromCore(witness),
+    Serialization.AuxiliaryData.fromCore(auxiliaryData)
+  );
+
   const finalizeProps: FinalizeTxProps = {
-    auxiliaryData,
     signingOptions: {
       extraSigners: [policySigner]
     },
-    tx: unsignedTx,
-    witness: { scripts: [policyScript] }
+    tx: serializableTx
   };
 
   const signedTx = await wallet.finalizeTx(finalizeProps);

packages/e2e/src/util/util.ts

@@ -213,7 +213,10 @@ export const submitCertificate = async (certificate: Cardano.Certificate, wallet
   };
 
   const unsignedTx = await wallet.wallet.initializeTx(txProps);
-  const signedTx = await wallet.wallet.finalizeTx({ tx: unsignedTx });
+
+  const signedTx = await wallet.wallet.finalizeTx({
+    tx: Serialization.Transaction.fromCoreBody(unsignedTx.body)
+  });
 
   await submitAndConfirm(wallet.wallet, signedTx);
 
@@ -287,12 +290,18 @@ export const burnTokens = async ({
 
   const unsignedTx = await wallet.initializeTx(txProps);
 
+  const witness = { redeemers: unsignedTx.redeemers, scripts, signatures: new Map() };
+
+  const serializableTx = new Serialization.Transaction(
+    Serialization.TransactionBody.fromCore(unsignedTx.body),
+    Serialization.TransactionWitnessSet.fromCore(witness)
+  );
+
   const finalizeProps: FinalizeTxProps = {
     signingOptions: {
       extraSigners
     },
-    tx: unsignedTx,
-    witness: { scripts }
+    tx: serializableTx
   };
 
   const signedTx = await wallet.finalizeTx(finalizeProps);

packages/e2e/test/wallet_epoch_0/PersonalWallet/mint.test.ts

@@ -1,5 +1,5 @@
 import { BaseWallet, FinalizeTxProps } from '@cardano-sdk/wallet';
-import { Cardano, nativeScriptPolicyId } from '@cardano-sdk/core';
+import { Cardano, Serialization, nativeScriptPolicyId } from '@cardano-sdk/core';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
 import { KeyRole, util } from '@cardano-sdk/key-management';
 import {
@@ -90,12 +90,16 @@ describe('PersonalWallet/mint', () => {
 
     const unsignedTx = await wallet.initializeTx(txProps);
 
+    const witness = { redeemers: unsignedTx.redeemers, scripts: [policyScript], signatures: new Map() };
+
     const finalizeProps: FinalizeTxProps = {
       signingOptions: {
         extraSigners: [alicePolicySigner]
       },
-      tx: unsignedTx,
-      witness: { scripts: [policyScript] }
+      tx: new Serialization.Transaction(
+        Serialization.TransactionBody.fromCore(unsignedTx.body),
+        Serialization.TransactionWitnessSet.fromCore(witness)
+      )
     };
 
     const signedTx = await wallet.finalizeTx(finalizeProps);

packages/e2e/test/wallet_epoch_0/PersonalWallet/multisignature.test.ts

@@ -1,6 +1,6 @@
 /* eslint-disable sonarjs/no-duplicate-string */
 import { BaseWallet, FinalizeTxProps } from '@cardano-sdk/wallet';
-import { Cardano, nativeScriptPolicyId } from '@cardano-sdk/core';
+import { Cardano, Serialization, nativeScriptPolicyId } from '@cardano-sdk/core';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
 import { KeyRole, util } from '@cardano-sdk/key-management';
 import {
@@ -117,12 +117,16 @@ describe('PersonalWallet/multisignature', () => {
 
     const unsignedTx = await wallet.initializeTx(txProps);
 
+    const witness = { redeemers: unsignedTx.redeemers, scripts: [policyScript], signatures: new Map() };
+
     const finalizeProps: FinalizeTxProps = {
       signingOptions: {
         extraSigners: [alicePolicySigner, bobPolicySigner]
       },
-      tx: unsignedTx,
-      witness: { scripts: [policyScript] }
+      tx: new Serialization.Transaction(
+        Serialization.TransactionBody.fromCore(unsignedTx.body),
+        Serialization.TransactionWitnessSet.fromCore(witness)
+      )
     };
 
     const signedTx = await wallet.finalizeTx(finalizeProps);

packages/e2e/test/wallet_epoch_0/PersonalWallet/nft.test.ts

@@ -1,5 +1,5 @@
 /* eslint-disable sonarjs/no-duplicate-string */
-import { Asset, Cardano, metadatum, nativeScriptPolicyId } from '@cardano-sdk/core';
+import { Asset, Cardano, Serialization, metadatum, nativeScriptPolicyId } from '@cardano-sdk/core';
 import { Assets, BaseWallet, FinalizeTxProps } from '@cardano-sdk/wallet';
 import { InitializeTxProps } from '@cardano-sdk/tx-construction';
 import { KeyRole, TransactionSigner, util } from '@cardano-sdk/key-management';
@@ -168,13 +168,17 @@ describe('PersonalWallet.assets/nft', () => {
 
     const unsignedTx = await wallet.initializeTx(txProps);
 
+    const witness = { redeemers: unsignedTx.redeemers, scripts: [policyScript], signatures: new Map() };
+
     const finalizeProps: FinalizeTxProps = {
-      auxiliaryData,
       signingOptions: {
         extraSigners: [policySigner]
       },
-      tx: unsignedTx,
-      witness: { scripts: [policyScript] }
+      tx: new Serialization.Transaction(
+        Serialization.TransactionBody.fromCore(unsignedTx.body),
+        Serialization.TransactionWitnessSet.fromCore(witness),
+        Serialization.AuxiliaryData.fromCore(auxiliaryData)
+      )
     };
 
     const signedTx = await wallet.finalizeTx(finalizeProps);
@@ -284,12 +288,16 @@ describe('PersonalWallet.assets/nft', () => {
 
     const unsignedTx = await wallet.initializeTx(txProps);
 
+    const witness = { redeemers: unsignedTx.redeemers, scripts: [policyScript], signatures: new Map() };
+
     const finalizeProps: FinalizeTxProps = {
       signingOptions: {
         extraSigners: [policySigner]
       },
-      tx: unsignedTx,
-      witness: { scripts: [policyScript] }
+      tx: new Serialization.Transaction(
+        Serialization.TransactionBody.fromCore(unsignedTx.body),
+        Serialization.TransactionWitnessSet.fromCore(witness)
+      )
     };
 
     const signedTx = await wallet.finalizeTx(finalizeProps);
@@ -354,13 +362,17 @@ describe('PersonalWallet.assets/nft', () => {
 
         const unsignedTx = await wallet.initializeTx(txProps);
 
+        const witness = { redeemers: unsignedTx.redeemers, scripts: [policyScript], signatures: new Map() };
+
         const finalizeProps: FinalizeTxProps = {
-          auxiliaryData,
           signingOptions: {
             extraSigners: [policySigner]
           },
-          tx: unsignedTx,
-          witness: { scripts: [policyScript] }
+          tx: new Serialization.Transaction(
+            Serialization.TransactionBody.fromCore(unsignedTx.body),
+            Serialization.TransactionWitnessSet.fromCore(witness),
+            Serialization.AuxiliaryData.fromCore(auxiliaryData)
+          )
         };
 
         const signedTx = await wallet.finalizeTx(finalizeProps);

packages/e2e/test/wallet_epoch_0/PersonalWallet/phase2validation.test.ts

@@ -140,10 +140,15 @@ describe('PersonalWallet/phase2validation', () => {
     };
 
     const unsignedTx = await wallet.initializeTx(txProps);
+
+    const witness = { redeemers: [scriptRedeemer], scripts: [alwaysFailScript], signatures: new Map() };
+
     const finalizeProps: FinalizeTxProps = {
       isValid: false,
-      tx: unsignedTx,
-      witness: { redeemers: [scriptRedeemer], scripts: [alwaysFailScript] }
+      tx: new Serialization.Transaction(
+        Serialization.TransactionBody.fromCore(unsignedTx.body),
+        Serialization.TransactionWitnessSet.fromCore(witness)
+      )
     };
 
     const signedTx = await wallet.finalizeTx(finalizeProps);

packages/e2e/test/wallet_epoch_0/PersonalWallet/txChaining.test.ts

@@ -1,4 +1,5 @@
 import { ObservableWallet } from '@cardano-sdk/wallet';
+import { Serialization } from '@cardano-sdk/core';
 import { firstValueFrom } from 'rxjs';
 import { getEnv, getWallet, submitAndConfirm, walletReady, walletVariables } from '../../../src';
 import { logger } from '@cardano-sdk/util-dev';
@@ -29,7 +30,10 @@ describe('PersonalWallet/txChaining', () => {
       outputs: new Set([{ address, value: { coins: moreThanHalfOfTheBalanceCoins } }])
     });
 
-    const finalizedTx1 = await wallet.finalizeTx({ tx: tx1 });
+    const finalizedTx1 = await wallet.finalizeTx({
+      tx: Serialization.Transaction.fromCoreBody(tx1.body)
+    });
+
     await wallet.submitTx(finalizedTx1);
 
     const tx2 = await wallet.initializeTx({
@@ -40,7 +44,9 @@ describe('PersonalWallet/txChaining', () => {
     const usingTx1OutputAsInput = [...tx2.inputSelection.inputs].some(([txIn]) => txIn.txId === finalizedTx1.id);
     expect(usingTx1OutputAsInput).toBe(true);
 
-    const finalizedTx2 = await wallet.finalizeTx({ tx: tx2 });
+    const finalizedTx2 = await wallet.finalizeTx({
+      tx: Serialization.Transaction.fromCoreBody(tx2.body)
+    });
 
     // 1st tx must also be on-chain because the 2nd one uses output from the 1st one
     await submitAndConfirm(wallet, finalizedTx2);

packages/wallet/src/Wallets/BaseWallet.ts

@@ -586,38 +586,20 @@ export class BaseWallet implements ObservableWallet {
     return initializeTx(props, this.getTxBuilderDependencies());
   }
 
-  async finalizeTx({
-    tx,
-    bodyCbor,
-    signingOptions,
-    signingContext,
-    auxiliaryData,
-    isValid,
-    witness
-  }: FinalizeTxProps): Promise<Cardano.Tx> {
+  async finalizeTx({ tx, signingOptions, signingContext, isValid }: FinalizeTxProps): Promise<Cardano.Tx> {
     const knownAddresses = await firstValueFrom(this.addresses$);
     const dRepPublicKey = await this.governance.getPubDRepKey();
 
     const context = {
       ...signingContext,
       dRepPublicKey,
       knownAddresses,
-      txInKeyPathMap: await util.createTxInKeyPathMap(tx.body, knownAddresses, this.util)
+      txInKeyPathMap: await util.createTxInKeyPathMap(tx.body().toCore(), knownAddresses, this.util)
     };
 
-    const emptyWitness = { signatures: new Map() };
+    if (isValid !== undefined) tx.setIsValid(isValid);
 
-    // The Witnesser takes a serializable transaction. We cant build that from the hash alone, if
-    // the bodyCbor is available, use that instead of the coreTx type to build the transaction.
-    const transaction = new Serialization.Transaction(
-      bodyCbor ? Serialization.TransactionBody.fromCbor(bodyCbor) : Serialization.TransactionBody.fromCore(tx.body),
-      Serialization.TransactionWitnessSet.fromCore({ ...emptyWitness, ...witness }),
-      auxiliaryData ? Serialization.AuxiliaryData.fromCore(auxiliaryData) : undefined
-    );
-
-    if (isValid !== undefined) transaction.setIsValid(isValid);
-
-    const result = await this.witnesser.witness(transaction, context, signingOptions);
+    const result = await this.witnesser.witness(tx, context, signingOptions);
 
     this.#newTransactions.signed$.next(result);
 
@@ -827,12 +809,10 @@ export class BaseWallet implements ObservableWallet {
   /** Update the witness of a transaction with witness provided by this wallet */
   async updateWitness({ tx, sender }: UpdateWitnessProps): Promise<Cardano.Tx> {
     return this.finalizeTx({
-      auxiliaryData: tx.auxiliaryData,
       signingContext: {
         sender
       },
-      tx: { body: tx.body, hash: tx.id },
-      witness: tx.witness
+      tx: Serialization.Transaction.fromCore(tx)
     });
   }
 }

packages/wallet/src/cip30.ts

@@ -456,7 +456,6 @@ const baseCip30WalletApi = (
     logger.debug('signTx');
     const txDecoded = Serialization.Transaction.fromCbor(TxCBOR(tx));
 
-    const hash = txDecoded.getId();
     const coreTx = txDecoded.toCore();
     const shouldProceed = await confirmationCallback
       .signTx({
@@ -479,9 +478,8 @@ const baseCip30WalletApi = (
         const {
           witness: { signatures }
         } = await wallet.finalizeTx({
-          bodyCbor: txDecoded.body().toCbor(),
           signingContext: { sender },
-          tx: { ...coreTx, hash }
+          tx: txDecoded
         });
 
         // If partialSign is true, the wallet only tries to sign what it can. However, if

packages/wallet/src/types.ts

@@ -5,16 +5,17 @@ import {
   EraSummary,
   HandleResolution,
   NetworkInfoProvider,
+  Serialization,
   TxCBOR
 } from '@cardano-sdk/core';
 import { BalanceTracker, DelegationTracker, TransactionsTracker, UtxoTracker } from './services';
 import { Cip30DataSignature } from '@cardano-sdk/dapp-connector';
 import { Ed25519PublicKeyHex } from '@cardano-sdk/crypto';
 import { GroupedAddress, MessageSender, SignTransactionContext, WitnessedTx, cip8 } from '@cardano-sdk/key-management';
-import { HexBlob, Shutdown } from '@cardano-sdk/util';
 import { InitializeTxProps, InitializeTxResult, TxBuilder, TxContext } from '@cardano-sdk/tx-construction';
 import { Observable } from 'rxjs';
 import { PubStakeKeyAndStatus } from './services/PublicStakeKeysTracker';
+import { Shutdown } from '@cardano-sdk/util';
 
 export type Assets = Map<Cardano.AssetId, Asset.AssetInfo>;
 
@@ -43,11 +44,11 @@ export interface SyncStatus extends Shutdown {
   isSettled$: Observable<boolean>;
 }
 
-export type FinalizeTxProps = Omit<TxContext, 'signingContext'> & {
-  tx: Cardano.TxBodyWithHash;
-  bodyCbor?: HexBlob;
-  signingContext?: Partial<SignTransactionContext>;
-};
+export type FinalizeTxProps = Pick<TxContext, 'signingOptions'> &
+  Pick<TxContext, 'isValid'> & {
+    tx: Serialization.Transaction;
+    signingContext?: Partial<SignTransactionContext>;
+  };
 
 export type UpdateWitnessProps = {
   tx: Cardano.Tx;

packages/wallet/test/PersonalWallet/load.test.ts

@@ -25,6 +25,7 @@ import {
   HandleProvider,
   NetworkInfoProvider,
   RewardsProvider,
+  Serialization,
   UtxoProvider,
   coalesceValueQuantities
 } from '@cardano-sdk/core';
@@ -470,7 +471,7 @@ describe('BaseWallet creates big UTXO', () => {
     const unsignedTx = await wallet.initializeTx(txProps);
 
     const finalizeProps = {
-      tx: unsignedTx
+      tx: Serialization.Transaction.fromCoreBody(unsignedTx.body)
     };
 
     const signedTx = await wallet.finalizeTx(finalizeProps);