chore: add object parameter support to TransactionResponse constructor (#3911)

Author: Torres-ssf

.changeset/stale-news-go.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/account": patch
+---
+
+chore: add object parameter support to `TransactionResponse` constructor

packages/account/src/providers/provider.test.ts

@@ -1103,7 +1103,11 @@ describe('Provider', () => {
     );
 
     const chainId = await provider.getChainId();
-    const response = new TransactionResponse('invalid transaction id', provider, chainId);
+    const response = new TransactionResponse({
+      transactionRequestOrId: 'invalid transaction id',
+      provider,
+      chainId,
+    });
 
     await expectToThrowFuelError(() => response.waitForResult(), {
       code: FuelError.CODES.INVALID_REQUEST,

packages/account/src/providers/provider.ts

@@ -1152,7 +1152,13 @@ export default class Provider {
     );
 
     const chainId = await this.getChainId();
-    return new TransactionResponse(transactionRequest, this, chainId, abis, subscription);
+    return new TransactionResponse({
+      transactionRequestOrId: transactionRequest,
+      provider: this,
+      chainId,
+      abis,
+      submitAndAwaitSubscription: subscription,
+    });
   }
 
   /**
@@ -2550,7 +2556,11 @@ export default class Provider {
 
   async getTransactionResponse(transactionId: string): Promise<TransactionResponse> {
     const chainId = await this.getChainId();
-    return new TransactionResponse(transactionId, this, chainId);
+    return new TransactionResponse({
+      transactionRequestOrId: transactionId,
+      provider: this,
+      chainId,
+    });
   }
 
   /**

packages/account/src/providers/transaction-response/transaction-response.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
 import { ErrorCode, FuelError } from '@fuel-ts/errors';
 import type { BN } from '@fuel-ts/math';
 import { bn } from '@fuel-ts/math';
@@ -115,6 +117,14 @@ export type TransactionResponseJson = {
   requestJson?: string;
 };
 
+export type TransactionResponseParams = {
+  transactionRequestOrId: string | TransactionRequest;
+  provider: Provider;
+  chainId: number;
+  abis?: JsonAbisFromAllCalls;
+  submitAndAwaitSubscription?: SubmitAndAwaitStatusSubscriptionIterable;
+};
+
 /**
  * Represents a response for a transaction.
  */
@@ -130,35 +140,85 @@ export class TransactionResponse {
   request?: TransactionRequest;
   status?: StatusChangeSubscription['statusChange'];
   abis?: JsonAbisFromAllCalls;
+  private submitTxSubscription?: SubmitAndAwaitStatusSubscriptionIterable;
   preConfirmationStatus?: StatusChangeSubscription['statusChange'];
 
   private waitingForStreamData = false;
   private statusResolvers: Map<StatusType, (() => void)[]> = new Map();
 
   /**
-   * Constructor for `TransactionResponse`.
+   * Creates a new TransactionResponse instance.
    *
-   * @param tx - The transaction ID or TransactionRequest.
+   * @param transactionRequestOrId - The transaction ID or TransactionRequest.
    * @param provider - The provider.
+   * @param chainId - The chain ID.
+   * @param abis - The ABIs.
+   * @param submitAndAwaitSubscription - The submit and await subscription.
+   *
+   * @deprecated Use the object-style constructor instead:
+   * `new TransactionResponse({ ... })`
    */
   constructor(
-    tx: string | TransactionRequest,
+    transactionRequestOrId: string | TransactionRequest,
     provider: Provider,
     chainId: number,
     abis?: JsonAbisFromAllCalls,
-    private submitTxSubscription?: SubmitAndAwaitStatusSubscriptionIterable
+    submitAndAwaitSubscription?: SubmitAndAwaitStatusSubscriptionIterable
+  );
+
+  /**
+   * Creates a new TransactionResponse instance.
+   *
+   * @param constructorParams - The constructor parameters.
+   */
+  constructor(constructorParams: TransactionResponseParams);
+
+  /**
+   * Constructor for `TransactionResponse`.
+   */
+  constructor(
+    constructorParams: string | TransactionRequest | TransactionResponseParams,
+    provider?: Provider,
+    chainId?: number,
+    abis?: JsonAbisFromAllCalls,
+    submitTxSubscription?: SubmitAndAwaitStatusSubscriptionIterable
   ) {
+    let tx: string | TransactionRequest;
+    let _provider: Provider;
+    let _chainId: number;
+    let _abis: JsonAbisFromAllCalls | undefined;
+
+    if (
+      typeof constructorParams === 'object' &&
+      'provider' in constructorParams &&
+      arguments.length === 1
+    ) {
+      // Object-style usage
+      tx = constructorParams.transactionRequestOrId;
+      _provider = constructorParams.provider;
+      _chainId = constructorParams.chainId;
+      _abis = constructorParams.abis;
+      this.submitTxSubscription = constructorParams.submitAndAwaitSubscription;
+    } else {
+      // Deprecated positional usage
+      tx = constructorParams as string | TransactionRequest;
+      _provider = provider as Provider;
+      _chainId = chainId as number;
+      _abis = abis;
+      this.submitTxSubscription = submitTxSubscription;
+    }
+
     // Transaction Request was not provided
     if (typeof tx === 'string') {
       this.id = tx;
     } else {
       // Transaction Request was provided
-      this.id = tx.getTransactionId(chainId);
+      this.id = tx.getTransactionId(_chainId);
       this.request = tx;
     }
 
-    this.provider = provider;
-    this.abis = abis;
+    this.provider = _provider;
+    this.abis = _abis;
     this.waitForResult = this.waitForResult.bind(this);
     this.waitForPreConfirmation = this.waitForPreConfirmation.bind(this);
   }

packages/account/src/providers/utils/transaction-response-serialization.ts

@@ -41,7 +41,12 @@ export const deserializeTransactionResponseJson = (json: TransactionResponseJson
   const provider = new Provider(providerUrl, { cache: providerCache });
   const { chainId } = providerCache.chain.consensusParameters;
 
-  const response = new TransactionResponse(id, provider, Number(chainId), abis);
+  const response = new TransactionResponse({
+    transactionRequestOrId: id,
+    provider,
+    chainId: Number(chainId),
+    abis,
+  });
 
   if (requestJson) {
     response.request = transactionRequestify(JSON.parse(requestJson));