refactor!: renamed field handle to handleResolutions

iadmytro · mkazlauskas · commit 5e3a40b6f0fa · 2023-09-12T11:12:28.000+03:00
diff --git a/packages/cardano-services-client/src/version.ts b/packages/cardano-services-client/src/version.ts
@@ -7,6 +7,6 @@ export const apiVersion = {
   rewards: '1.0.0',
   root: '2.0.0',
   stakePool: '1.0.0',
-  txSubmit: '1.0.0',
+  txSubmit: '2.0.0',
   utxo: '2.0.0'
 };
diff --git a/packages/cardano-services-client/version.json b/packages/cardano-services-client/version.json
@@ -6,6 +6,6 @@
   "rewards": "1.0.0",
   "root": "2.0.0",
   "stakePool": "1.0.0",
-  "txSubmit": "1.0.0",
+  "txSubmit": "2.0.0",
   "utxo": "2.0.0"
 }
diff --git a/packages/cardano-services/src/TxSubmit/openApi.json b/packages/cardano-services/src/TxSubmit/openApi.json
@@ -6,7 +6,7 @@
       "name": "Apache 2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     },
-    "version": "1.0.0"
+    "version": "2.0.0"
   },
   "paths": {
     "/v1.0.0/tx-submit/health": {
diff --git a/packages/cardano-services/test/Program/services/ogmios.test.ts b/packages/cardano-services/test/Program/services/ogmios.test.ts
@@ -302,7 +302,7 @@ describe('Service dependency abstractions', () => {
           await provider.initialize();
           await provider.start();
           const res = await provider.submitTx({
-            context: { handles: [handleProviderMocks.getAliceHandleProviderResponse] },
+            context: { handleResolutions: [handleProviderMocks.getAliceHandleProviderResponse] },
             signedTransaction: bufferToHexString(Buffer.from(new Uint8Array([])))
           });
           expect(res).toBeUndefined();
@@ -318,7 +318,7 @@ describe('Service dependency abstractions', () => {
 
           await expect(
             provider.submitTx({
-              context: { handles: [handleProviderMocks.getWrongHandleProviderResponse] },
+              context: { handleResolutions: [handleProviderMocks.getWrongHandleProviderResponse] },
               signedTransaction: bufferToHexString(Buffer.from(new Uint8Array([])))
             })
           ).rejects.toBeInstanceOf(ProviderError);
diff --git a/packages/core/src/Provider/TxSubmitProvider/types.ts b/packages/core/src/Provider/TxSubmitProvider/types.ts
@@ -6,7 +6,7 @@ type SerializedTransaction = Cardano.util.HexBlob;
 
 export interface SubmitTxArgs {
   signedTransaction: SerializedTransaction;
-  context?: { handles: HandleResolution[] };
+  context?: { handleResolutions: HandleResolution[] };
 }
 
 export interface TxSubmitProvider extends Provider {
diff --git a/packages/ogmios/src/Provider/TxSubmitProvider/OgmiosTxSubmitProvider.ts b/packages/ogmios/src/Provider/TxSubmitProvider/OgmiosTxSubmitProvider.ts
@@ -93,7 +93,7 @@ export class OgmiosTxSubmitProvider extends RunnableModule implements TxSubmitPr
   }
 
   private async throwIfHandleResolutionConflict(context: SubmitTxArgs['context']): Promise<void> {
-    if (context?.handles && context.handles.length > 0) {
+    if (context?.handleResolutions && context.handleResolutions.length > 0) {
       if (!this.#handleProvider) {
         throw new ProviderError(
           ProviderFailure.NotImplemented,
@@ -103,14 +103,14 @@ export class OgmiosTxSubmitProvider extends RunnableModule implements TxSubmitPr
       }
 
       const handleInfoList = await this.#handleProvider.resolveHandles({
-        handles: context.handles.map((handle) => handle.handle)
+        handles: context.handleResolutions.map((hndRes) => hndRes.handle)
       });
 
       for (const [index, handleInfo] of handleInfoList.entries()) {
-        if (!handleInfo || handleInfo.cardanoAddress !== context.handles[index].cardanoAddress) {
+        if (!handleInfo || handleInfo.cardanoAddress !== context.handleResolutions[index].cardanoAddress) {
           const handleOwnerChangeError = new HandleOwnerChangeError(
-            context.handles[index].handle,
-            context.handles[index].cardanoAddress,
+            context.handleResolutions[index].handle,
+            context.handleResolutions[index].cardanoAddress,
             handleInfo ? handleInfo.cardanoAddress : null
           );
           throw new ProviderError(ProviderFailure.Conflict, handleOwnerChangeError);
diff --git a/packages/ogmios/test/Provider/TxSubmitProvider/OgmiosTxSubmitProvider.test.ts b/packages/ogmios/test/Provider/TxSubmitProvider/OgmiosTxSubmitProvider.test.ts
@@ -149,7 +149,7 @@ describe('OgmiosTxSubmitProvider', () => {
       await expect(
         provider.submitTx({
           context: {
-            handles: [mockHandleResolution]
+            handleResolutions: [mockHandleResolution]
           },
           signedTransaction: emptyUintArrayAsHexString
         })
@@ -172,7 +172,7 @@ describe('OgmiosTxSubmitProvider', () => {
 
       const res = await provider.submitTx({
         context: {
-          handles: [mockHandleResolution]
+          handleResolutions: [mockHandleResolution]
         },
         signedTransaction: emptyUintArrayAsHexString
       });
@@ -199,7 +199,7 @@ describe('OgmiosTxSubmitProvider', () => {
       await expect(
         provider.submitTx({
           context: {
-            handles: [mockHandleResolution]
+            handleResolutions: [mockHandleResolution]
           },
           signedTransaction: emptyUintArrayAsHexString
         })
diff --git a/packages/tx-construction/src/tx-builder/OutputBuilder.ts b/packages/tx-construction/src/tx-builder/OutputBuilder.ts
@@ -148,7 +148,7 @@ export class TxOutputBuilder implements OutputBuilder {
       const resolution = await this.#handleProvider.resolveHandles({ handles: [this.#partialOutput.handle] });
 
       if (resolution[0] !== null) {
-        txOut.handle = resolution[0];
+        txOut.handleResolution = resolution[0];
         txOut.address = resolution[0].cardanoAddress;
       } else {
         // Throw an error because the handle resolved to null so we don't have
diff --git a/packages/tx-construction/src/tx-builder/TxBuilder.ts b/packages/tx-construction/src/tx-builder/TxBuilder.ts
@@ -67,10 +67,10 @@ class LazyTxSigner implements UnsignedTx {
   async inspect(): Promise<TxInspection> {
     const {
       tx,
-      ctx: { ownAddresses, auxiliaryData, handles },
+      ctx: { ownAddresses, auxiliaryData, handleResolutions },
       inputSelection
     } = await this.#build();
-    return { ...tx, auxiliaryData, handles, inputSelection, ownAddresses };
+    return { ...tx, auxiliaryData, handleResolutions, inputSelection, ownAddresses };
   }
 
   async sign(): Promise<SignedTx> {
@@ -89,7 +89,7 @@ export class GenericTxBuilder implements TxBuilder {
   #requestedPortfolio?: TxBuilderStakePool[];
   #logger: Logger;
   #handleProvider?: HandleProvider;
-  #handles: HandleResolution[];
+  #handleResolutions: HandleResolution[];
 
   constructor(dependencies: TxBuilderDependencies) {
     this.#outputValidator =
@@ -105,7 +105,7 @@ export class GenericTxBuilder implements TxBuilder {
     };
     this.#logger = dependencies.logger;
     this.#handleProvider = dependencies.handleProvider;
-    this.#handles = [];
+    this.#handleResolutions = [];
   }
 
   async inspect(): Promise<PartialTx> {
@@ -118,16 +118,16 @@ export class GenericTxBuilder implements TxBuilder {
   }
 
   addOutput(txOut: OutputBuilderTxOut): TxBuilder {
-    if (txOut.handle) {
-      this.#handles = [...this.#handles, txOut.handle];
+    if (txOut.handleResolution) {
+      this.#handleResolutions = [...this.#handleResolutions, txOut.handleResolution];
     }
-    const txOutNoHandle = omit(txOut, 'handle');
+    const txOutNoHandle = omit(txOut, ['handle', 'handleResolution']);
     this.partialTxBody = { ...this.partialTxBody, outputs: [...(this.partialTxBody.outputs || []), txOutNoHandle] };
     return this;
   }
 
   removeOutput(txOut: OutputBuilderTxOut): TxBuilder {
-    this.#handles = this.#handles.filter((handle) => handle !== txOut.handle);
+    this.#handleResolutions = this.#handleResolutions.filter((hndRes) => hndRes.handle !== txOut.handle);
     this.partialTxBody = {
       ...this.partialTxBody,
       outputs: this.partialTxBody.outputs?.filter((output) => !deepEquals(output, txOut))
@@ -215,7 +215,7 @@ export class GenericTxBuilder implements TxBuilder {
               {
                 auxiliaryData,
                 certificates: this.partialTxBody.certificates,
-                handles: this.#handles,
+                handleResolutions: this.#handleResolutions,
                 outputs: new Set(this.partialTxBody.outputs || []),
                 signingOptions,
                 witness: { extraSigners }
@@ -225,7 +225,7 @@ export class GenericTxBuilder implements TxBuilder {
             return {
               ctx: {
                 auxiliaryData,
-                handles: this.#handles,
+                handleResolutions: this.#handleResolutions,
                 ownAddresses,
                 signingOptions,
                 witness: { extraSigners }
diff --git a/packages/tx-construction/src/tx-builder/finalizeTx.ts b/packages/tx-construction/src/tx-builder/finalizeTx.ts
@@ -30,7 +30,7 @@ const getSignatures = async (
 
 export const finalizeTx = async (
   tx: Cardano.TxBodyWithHash,
-  { ownAddresses, witness, signingOptions, auxiliaryData, isValid, handles }: TxContext,
+  { ownAddresses, witness, signingOptions, auxiliaryData, isValid, handleResolutions }: TxContext,
   { inputResolver, keyAgent }: FinalizeTxDependencies,
   stubSign = false
 ): Promise<SignedTx> => {
@@ -58,7 +58,7 @@ export const finalizeTx = async (
   return {
     cbor: TxCBOR.serialize(transaction),
     context: {
-      handles: handles ?? []
+      handleResolutions: handleResolutions ?? []
     },
     tx: transaction
   };
diff --git a/packages/tx-construction/src/tx-builder/initializeTx.ts b/packages/tx-construction/src/tx-builder/initializeTx.ts
@@ -58,7 +58,7 @@ export const initializeTx = async (
         unsignedTx,
         {
           auxiliaryData: props.auxiliaryData,
-          handles: props.handles ?? [],
+          handleResolutions: props.handleResolutions ?? [],
           ownAddresses: addresses,
           signingOptions: props.signingOptions,
           witness: props.witness
diff --git a/packages/tx-construction/src/tx-builder/types.ts b/packages/tx-construction/src/tx-builder/types.ts
@@ -89,7 +89,7 @@ export type TxBodyValidationError = TxOutValidationError | InputSelectionError;
  * appear in the final TxOut type since it's extracted before then and passed
  * as `ctx`.
  */
-export type OutputBuilderTxOut = Cardano.TxOut & { handle?: HandleResolution };
+export type OutputBuilderTxOut = Cardano.TxOut & { handle?: Handle; handleResolution?: HandleResolution };
 
 /**
  * Helps build transaction outputs from its constituent parts.
@@ -136,19 +136,19 @@ export interface TxContext {
   auxiliaryData?: Cardano.AuxiliaryData;
   witness?: InitializeTxWitness;
   isValid?: boolean;
-  handles?: HandleResolution[];
+  handleResolutions?: HandleResolution[];
 }
 
 export type TxInspection = Cardano.TxBodyWithHash &
-  Pick<TxContext, 'ownAddresses' | 'auxiliaryData' | 'handles'> & {
+  Pick<TxContext, 'ownAddresses' | 'auxiliaryData' | 'handleResolutions'> & {
     inputSelection: SelectionSkeleton;
   };
 
 export interface SignedTx {
   cbor: TxCBOR;
   tx: Cardano.Tx;
   context: {
-    handles: HandleResolution[];
+    handleResolutions: HandleResolution[];
   };
 }
 
diff --git a/packages/tx-construction/src/types.ts b/packages/tx-construction/src/types.ts
@@ -34,7 +34,7 @@ export interface InitializeTxProps {
   auxiliaryData?: Cardano.AuxiliaryData;
   witness?: InitializeTxWitness;
   signingOptions?: SignTransactionOptions;
-  handles?: HandleResolution[];
+  handleResolutions?: HandleResolution[];
 }
 
 export interface InitializeTxPropsValidationResult {
diff --git a/packages/tx-construction/test/tx-builder/TxBuilder.test.ts b/packages/tx-construction/test/tx-builder/TxBuilder.test.ts
@@ -419,7 +419,7 @@ describe('GenericTxBuilder', () => {
       it('resolves handle to address', async () => {
         const txOut = await txBuilder.buildOutput().handle('alice').coin(output1Coin).build();
 
-        expect(txOut.handle).toBe(resolvedHandle);
+        expect(txOut.handle).toBe(resolvedHandle.handle);
         expect(txOut.address).toBe(resolvedHandle.cardanoAddress);
       });
 
@@ -484,13 +484,13 @@ describe('GenericTxBuilder', () => {
     const tx = txBuilder
       .addOutput({
         ...mocks.utxo[0][1],
-        handle: resolvedHandle
+        handleResolution: resolvedHandle
       })
       .build();
-    const { handles } = await tx.inspect();
-    expect(handles).toEqual([resolvedHandle]);
+    const { handleResolutions } = await tx.inspect();
+    expect(handleResolutions).toEqual([resolvedHandle]);
     const { context } = await tx.sign();
-    expect(context.handles).toEqual([resolvedHandle]);
+    expect(context.handleResolutions).toEqual([resolvedHandle]);
   });
 
   it('can build transactions that are not modified by subsequent builder changes', async () => {
diff --git a/packages/wallet/test/PersonalWallet/methods.test.ts b/packages/wallet/test/PersonalWallet/methods.test.ts
@@ -493,7 +493,7 @@ describe('PersonalWallet methods', () => {
 
         const txOut = await txBuilder.addOutput(txOutput).build().sign();
         const submitTxArgsMock = {
-          context: { handles: [mocks.resolvedHandle] },
+          context: { handleResolutions: [mocks.resolvedHandle] },
           signedTransaction: txOut.cbor
         };
         const txPending = firstValueFrom(wallet.transactions.outgoing.pending$);

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@`
`6`	`6`	`"rewards": "1.0.0",`
`7`	`7`	`"root": "2.0.0",`
`8`	`8`	`"stakePool": "1.0.0",`
`9`		`- "txSubmit": "1.0.0",`
	`9`	`+ "txSubmit": "2.0.0",`
`10`	`10`	`"utxo": "2.0.0"`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ type SerializedTransaction = Cardano.util.HexBlob;`
`6`	`6`
`7`	`7`	`export interface SubmitTxArgs {`
`8`	`8`	`signedTransaction: SerializedTransaction;`
`9`		`- context?: { handles: HandleResolution[] };`
	`9`	`+ context?: { handleResolutions: HandleResolution[] };`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`export interface TxSubmitProvider extends Provider {`