fixup! fix(core): proposal procedure now correctly deserializes info action procedures

Author: mirceahasegan

packages/tx-construction/src/createTransactionInternals.ts

@@ -27,11 +27,11 @@ export const createPreInputSelectionTxBody = ({
   requiredExtraSignatures,
   outputs
 }: Omit<CreateTxInternalsProps, 'inputSelection'> & { outputs?: Cardano.TxOut[] }): {
-  body: TxBodyPreInputSelection;
+  txBody: TxBodyPreInputSelection;
   auxiliaryData?: Cardano.AuxiliaryData;
 } => ({
   auxiliaryData,
-  body: {
+  txBody: {
     auxiliaryDataHash: auxiliaryData ? Cardano.computeAuxiliaryDataHash(auxiliaryData) : undefined,
     certificates,
     mint,
@@ -68,6 +68,6 @@ export const includeChangeAndInputs = ({
 };
 
 export const createTransactionInternals = (props: CreateTxInternalsProps): Cardano.TxBodyWithHash => {
-  const { body } = createPreInputSelectionTxBody({ ...props });
-  return includeChangeAndInputs({ bodyPreInputSelection: body, inputSelection: props.inputSelection });
+  const { txBody } = createPreInputSelectionTxBody({ ...props });
+  return includeChangeAndInputs({ bodyPreInputSelection: txBody, inputSelection: props.inputSelection });
 };

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

@@ -8,9 +8,8 @@ import {
   util
 } from '@cardano-sdk/key-management';
 import { Cardano, HandleProvider, HandleResolution, metadatum } from '@cardano-sdk/core';
-import { GreedyInputSelector, SelectionSkeleton } from '@cardano-sdk/input-selection';
-import { InitializeTxProps, RewardAccountWithPoolId } from '../types';
 import {
+  CustomizeCb,
   InsufficientRewardAccounts,
   OutOfSyncRewardAccounts,
   OutputBuilderTxOut,
@@ -24,8 +23,10 @@ import {
   TxOutValidationError,
   UnsignedTx
 } from './types';
+import { GreedyInputSelector, SelectionSkeleton } from '@cardano-sdk/input-selection';
 import { Logger } from 'ts-log';
 import { OutputBuilderValidator, TxOutputBuilder } from './OutputBuilder';
+import { RewardAccountWithPoolId } from '../types';
 import { coldObservableProvider } from '@cardano-sdk/util-rxjs';
 import { contextLogger, deepEquals } from '@cardano-sdk/util';
 import { createOutputValidator } from '../output-validation';
@@ -102,7 +103,7 @@ export class GenericTxBuilder implements TxBuilder {
   #logger: Logger;
   #handleProvider?: HandleProvider;
   #handleResolutions: HandleResolution[];
-  #customizeCb: InitializeTxProps['customizeCb'];
+  #customizeCb: CustomizeCb;
 
   constructor(dependencies: TxBuilderDependencies) {
     this.#outputValidator =
@@ -195,8 +196,9 @@ export class GenericTxBuilder implements TxBuilder {
     return this;
   }
 
-  customize(cb: InitializeTxProps['customizeCb']): void {
+  customize(cb: CustomizeCb): TxBuilder {
     this.#customizeCb = cb;
+    return this;
   }
 
   build(): UnsignedTx {

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

@@ -36,7 +36,7 @@ export const initializeTx = async (
     });
 
   // Create transaction body that can be customized by the user via the customizeCb
-  const { body: b, auxiliaryData } = createPreInputSelectionTxBody({
+  const { txBody, auxiliaryData } = createPreInputSelectionTxBody({
     auxiliaryData: props.auxiliaryData,
     certificates: props.certificates,
     collaterals: props.collaterals,
@@ -53,7 +53,7 @@ export const initializeTx = async (
       .filter(({ quantity }) => !!quantity)
   });
 
-  const bodyPreInputSelection = props.customizeCb ? props.customizeCb(b) : b;
+  const bodyPreInputSelection = props.customizeCb ? props.customizeCb({ txBody }) : txBody;
 
   const constraints = defaultSelectionConstraints({
     buildTx: async (inputSelection) => {

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

@@ -9,7 +9,7 @@ import {
 import { Cardano, Handle, HandleProvider, HandleResolution, TxCBOR } from '@cardano-sdk/core';
 import { CustomError } from 'ts-custom-error';
 import { Hash32ByteBase16 } from '@cardano-sdk/crypto';
-import { InitializeTxProps, InitializeTxWitness, TxBuilderProviders } from '../types';
+import { InitializeTxWitness, TxBodyPreInputSelection, TxBuilderProviders } from '../types';
 import { InputSelectionError, InputSelector, SelectionSkeleton } from '@cardano-sdk/input-selection';
 import { Logger } from 'ts-log';
 import { OutputBuilderValidator } from './OutputBuilder';
@@ -181,6 +181,10 @@ export interface PartialTx {
   extraSigners?: TransactionSigner[];
   signingOptions?: SignTransactionOptions;
 }
+
+type CustomizeCbProps = { txBody: Readonly<TxBodyPreInputSelection> };
+export type CustomizeCb = (props: CustomizeCbProps) => TxBodyPreInputSelection;
+
 export interface TxBuilder {
   /**
    * @returns a partial transaction that has properties set by calling other TxBuilder methods. Does not validate the transaction.
@@ -243,7 +247,7 @@ export interface TxBuilder {
    * the `delegatePortfolio` method.
    * This method is not available when using web extension remote apis.
    */
-  customize(cb: InitializeTxProps['customizeCb']): void;
+  customize(cb: CustomizeCb): TxBuilder;
 
   /**
    * Create a snapshot of current transaction properties.

packages/tx-construction/src/types.ts

@@ -3,6 +3,7 @@ import { Cardano, HandleResolution } from '@cardano-sdk/core';
 import { GroupedAddress, SignTransactionOptions, TransactionSigner } from '@cardano-sdk/key-management';
 import { SelectionSkeleton } from '@cardano-sdk/input-selection';
 
+import { CustomizeCb } from './tx-builder';
 import { MinimumCoinQuantityPerOutput } from './output-validation';
 
 export type InitializeTxResult = Cardano.TxBodyWithHash & { inputSelection: SelectionSkeleton };
@@ -48,7 +49,7 @@ export interface InitializeTxProps {
   signingOptions?: Pick<SignTransactionOptions, 'additionalKeyPaths'>;
   handleResolutions?: HandleResolution[];
   /** callback function that allows updating the transaction before input selection */
-  customizeCb?: (txBody: Readonly<TxBodyPreInputSelection>) => TxBodyPreInputSelection;
+  customizeCb?: CustomizeCb;
 }
 
 export interface InitializeTxPropsValidationResult {

packages/tx-construction/test/tx-builder/TxBuilder.test.ts

@@ -498,16 +498,18 @@ describe('GenericTxBuilder', () => {
     });
 
     it('can add a custom fields which are accounted for by input selector', async () => {
-      txBuilder.addOutput(mocks.utxo[0][1]);
-      txBuilder.customize((txBody) => {
-        const outputs = [...txBody.outputs, { ...mocks.utxo[1][1], value: { coins: 100n } }];
-        return {
-          ...txBody,
-          outputs,
-          withdrawals: [...(txBody.withdrawals || []), { quantity: 13n, stakeAddress: mocks.rewardAccount }]
-        };
-      });
-      const txProps = await txBuilder.build().inspect();
+      const txProps = await txBuilder
+        .addOutput(mocks.utxo[0][1])
+        .customize(({ txBody }) => {
+          const outputs = [...txBody.outputs, { ...mocks.utxo[1][1], value: { coins: 100n } }];
+          return {
+            ...txBody,
+            outputs,
+            withdrawals: [...(txBody.withdrawals || []), { quantity: 13n, stakeAddress: mocks.rewardAccount }]
+          };
+        })
+        .build()
+        .inspect();
 
       // Check if the custom fields were included the built transaction
       expect(txProps.body.outputs.filter(({ value: { coins } }) => coins === 100n).length).toBe(1);
@@ -536,11 +538,14 @@ describe('GenericTxBuilder', () => {
           type: Cardano.CredentialType.KeyHash
         }
       };
-      txBuilder.customize((txBody) => {
-        const certificates = [...(txBody.certificates || []), stakeVoteRegDelegCert];
-        return { ...txBody, certificates };
-      });
-      const txProps = await txBuilder.build().inspect();
+      const txProps = await txBuilder
+        .customize(({ txBody }) => {
+          const certificates = [...(txBody.certificates || []), stakeVoteRegDelegCert];
+          return { ...txBody, certificates };
+        })
+        .build()
+        .inspect();
+
       expect(txProps.body.certificates?.length).toEqual(1);
       expect(txProps.body.certificates![0]).toEqual(stakeVoteRegDelegCert);
     });
@@ -556,12 +561,14 @@ describe('GenericTxBuilder', () => {
         }
       };
 
-      txBuilder.customize((txBody) => {
-        const certificates = [...(txBody.certificates || []), stakeRegDelegCert];
-        return { ...txBody, certificates };
-      });
+      const txProps = await txBuilder
+        .customize(({ txBody }) => {
+          const certificates = [...(txBody.certificates || []), stakeRegDelegCert];
+          return { ...txBody, certificates };
+        })
+        .build()
+        .inspect();
 
-      const txProps = await txBuilder.build().inspect();
       expect(txProps.body.certificates?.length).toEqual(1);
       expect(txProps.body.certificates![0]).toEqual(stakeRegDelegCert);
 
@@ -596,15 +603,17 @@ describe('GenericTxBuilder', () => {
         ]
       };
 
-      txBuilder.customize((txBody) => {
-        const votingProcedures: Cardano.TxBody['votingProcedures'] = [
-          ...(txBody.votingProcedures || []),
-          votingProcedure
-        ];
-        return { ...txBody, votingProcedures };
-      });
+      const txProps = await txBuilder
+        .customize(({ txBody }) => {
+          const votingProcedures: Cardano.TxBody['votingProcedures'] = [
+            ...(txBody.votingProcedures || []),
+            votingProcedure
+          ];
+          return { ...txBody, votingProcedures };
+        })
+        .build()
+        .inspect();
 
-      const txProps = await txBuilder.build().inspect();
       expect(txProps.body.votingProcedures?.length).toBe(1);
       expect(txProps.body.votingProcedures![0]).toEqual(votingProcedure);
     });