chore: made Account.signTransaction returns TransactionRequest (#3895)

Author: Torres-ssf

.changeset/good-horses-speak.md

@@ -0,0 +1,5 @@
+---
+"@fuel-ts/account": patch
+---
+
+chore: made `Account.signTransaction` returns `TransactionRequest`

packages/account/src/account.ts

@@ -885,14 +885,30 @@ export class Account extends AbstractAccount implements WithAddress {
    * @param transactionRequestLike - The transaction request to sign.
    * @returns A promise that resolves to the signature of the transaction.
    */
-  async signTransaction(transactionRequestLike: TransactionRequestLike): Promise<string> {
+  async signTransaction(
+    transactionRequestLike: TransactionRequestLike,
+    connectorOptions: AccountSendTxParams = {}
+  ): Promise<string | TransactionRequest> {
     if (!this._connector) {
       throw new FuelError(
         ErrorCode.MISSING_CONNECTOR,
         'A connector is required to sign transactions.'
       );
     }
-    return this._connector.signTransaction(this.address.toString(), transactionRequestLike);
+
+    const transactionRequest = transactionRequestify(transactionRequestLike);
+
+    const { transactionRequest: requestToSign, connectorsSendTxParams } =
+      await this.setTransactionStateForConnectors({
+        transactionRequest,
+        connectorOptions,
+      });
+
+    return this._connector.signTransaction(
+      this.address.toString(),
+      requestToSign,
+      connectorsSendTxParams
+    );
   }
 
   /**
@@ -906,30 +922,20 @@ export class Account extends AbstractAccount implements WithAddress {
     transactionRequestLike: TransactionRequestLike,
     { estimateTxDependencies = true, ...connectorOptions }: AccountSendTxParams = {}
   ): Promise<TransactionResponse> {
-    let transactionRequest = transactionRequestify(transactionRequestLike);
+    const transactionRequest = transactionRequestify(transactionRequestLike);
 
     // Check if the account is using a connector, and therefore we do not have direct access to the
     // private key.
     if (this._connector) {
-      const { onBeforeSend, skipCustomFee = false } = connectorOptions;
-
-      transactionRequest = await this.prepareTransactionForSend(transactionRequest);
-
-      const params: FuelConnectorSendTxParams = {
-        onBeforeSend,
-        skipCustomFee,
-        provider: {
-          url: this.provider.url,
-          cache: await serializeProviderCache(this.provider),
-        },
-        transactionState: transactionRequest.flag.state,
-        transactionSummary: await this.prepareTransactionSummary(transactionRequest),
-      };
+      const response = await this.setTransactionStateForConnectors({
+        transactionRequest,
+        connectorOptions,
+      });
 
       const transaction: string | TransactionResponse = await this._connector.sendTransaction(
         this.address.toString(),
-        transactionRequest,
-        params
+        response.transactionRequest,
+        response.connectorsSendTxParams
       );
 
       return typeof transaction === 'string'
@@ -940,6 +946,7 @@ export class Account extends AbstractAccount implements WithAddress {
     if (estimateTxDependencies) {
       await this.provider.estimateTxDependencies(transactionRequest);
     }
+
     return this.provider.sendTransaction(transactionRequest, {
       estimateTxDependencies: false,
     });
@@ -1113,4 +1120,32 @@ export class Account extends AbstractAccount implements WithAddress {
       );
     }
   }
+
+  /** @hidden * */
+  private async setTransactionStateForConnectors(params: {
+    transactionRequest: TransactionRequest;
+    connectorOptions: AccountSendTxParams;
+  }): Promise<{
+    transactionRequest: TransactionRequest;
+    connectorsSendTxParams: FuelConnectorSendTxParams;
+  }> {
+    const { transactionRequest: requestToPrepare, connectorOptions } = params;
+
+    const { onBeforeSend, skipCustomFee = false } = connectorOptions;
+
+    const transactionRequest = await this.prepareTransactionForSend(requestToPrepare);
+
+    const connectorsSendTxParams: FuelConnectorSendTxParams = {
+      onBeforeSend,
+      skipCustomFee,
+      provider: {
+        url: this.provider.url,
+        cache: await serializeProviderCache(this.provider),
+      },
+      transactionState: requestToPrepare.flag.state,
+      transactionSummary: await this.prepareTransactionSummary(requestToPrepare),
+    };
+
+    return { transactionRequest, connectorsSendTxParams };
+  }
 }

packages/account/src/connectors/fuel-connector.ts

@@ -4,7 +4,7 @@ import type { HashableMessage } from '@fuel-ts/hasher';
 import { EventEmitter } from 'events';
 
 import type { Asset } from '../assets/types';
-import type { TransactionRequestLike, TransactionResponse } from '../providers';
+import type { TransactionRequest, TransactionRequestLike, TransactionResponse } from '../providers';
 
 import { FuelConnectorEventTypes } from './types';
 import type {
@@ -41,7 +41,11 @@ interface Connector {
   signMessage(address: string, message: HashableMessage): Promise<string>;
   // #endregion fuel-connector-method-signMessage
   // #region fuel-connector-method-signTransaction
-  signTransaction(address: string, transaction: TransactionRequestLike): Promise<string>;
+  signTransaction(
+    address: string,
+    transaction: TransactionRequestLike,
+    params?: FuelConnectorSendTxParams
+  ): Promise<string | TransactionRequest>;
   // #endregion fuel-connector-method-signTransaction
   // #region fuel-connector-method-sendTransaction
   sendTransaction(
@@ -185,7 +189,11 @@ export abstract class FuelConnector extends EventEmitter implements Connector {
    *
    * @returns Transaction signature
    */
-  async signTransaction(_address: string, _transaction: TransactionRequestLike): Promise<string> {
+  async signTransaction(
+    _address: string,
+    _transaction: TransactionRequestLike,
+    _params?: FuelConnectorSendTxParams
+  ): Promise<string | TransactionRequest> {
     throw new FuelError(FuelError.CODES.NOT_IMPLEMENTED, 'Method not implemented.');
   }
 

packages/account/src/connectors/types/connector-types.ts

@@ -10,6 +10,7 @@ export enum FuelConnectorMethods {
   accounts = 'accounts',
   currentAccount = 'currentAccount',
   // Signature methods
+  signTransaction = 'signTransaction',
   signMessage = 'signMessage',
   sendTransaction = 'sendTransaction',
   // Assets metadata methods

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

@@ -324,7 +324,7 @@ export abstract class BaseTransactionRequest implements BaseTransactionRequestLi
     const accounts = Array.isArray(account) ? account : [account];
     await Promise.all(
       accounts.map(async (acc) => {
-        this.addWitness(await acc.signTransaction(<TransactionRequestLike>this));
+        this.addWitness((await acc.signTransaction(<TransactionRequestLike>this)) as string);
       })
     );