chore: rework precheck methods

Signed-off-by: Logan Nguyen <[email protected]>

chore: rename signerAccountInfo

Signed-off-by: Logan Nguyen <[email protected]>

chore: removed unused requestDetails in precheck.ts

Signed-off-by: Logan Nguyen <[email protected]>

fix: fixed precheck balance test

Signed-off-by: Logan Nguyen <[email protected]>

Author: quiet-node

packages/relay/src/lib/precheck.ts

@@ -7,7 +7,7 @@ import { Logger } from 'pino';
 import { prepend0x } from '../formatters';
 import { MirrorNodeClient } from './clients';
 import constants from './constants';
-import { JsonRpcError, predefined } from './errors/JsonRpcError';
+import { predefined } from './errors/JsonRpcError';
 import { CommonService } from './services';
 import { RequestDetails } from './types';
 
@@ -69,12 +69,12 @@ export class Precheck {
     this.transactionSize(parsedTx);
     this.transactionType(parsedTx);
     this.gasLimit(parsedTx);
-    const mirrorAccountInfo = await this.verifyAccount(parsedTx, requestDetails);
-    this.nonce(parsedTx, mirrorAccountInfo.ethereum_nonce);
     this.chainId(parsedTx);
     this.value(parsedTx);
     this.gasPrice(parsedTx, networkGasPriceInWeiBars);
-    this.balance(parsedTx, mirrorAccountInfo);
+    const signerAccountInfo = await this.verifyAccount(parsedTx, requestDetails);
+    this.nonce(parsedTx, signerAccountInfo.ethereum_nonce);
+    this.balance(parsedTx, signerAccountInfo.balance.balance);
     await this.receiverAccount(parsedTx, requestDetails);
   }
 
@@ -87,15 +87,6 @@ export class Precheck {
   async verifyAccount(tx: Transaction, requestDetails: RequestDetails): Promise<any> {
     const accountInfo = await this.mirrorNodeClient.getAccount(tx.from!, requestDetails);
     if (accountInfo == null) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Failed to retrieve address '${
-            tx.from
-          }' account details from mirror node on verify account precheck for sendRawTransaction(transaction=${JSON.stringify(
-            tx,
-          )})`,
-        );
-      }
       throw predefined.RESOURCE_NOT_FOUND(`address '${tx.from}'.`);
     }
 
@@ -108,32 +99,22 @@ export class Precheck {
    * @param accountInfoNonce - The nonce of the account.
    */
   nonce(tx: Transaction, accountInfoNonce: number): void {
-    if (this.logger.isLevelEnabled('trace')) {
-      this.logger.trace(
-        `Nonce precheck for sendRawTransaction(tx.nonce=${tx.nonce}, accountInfoNonce=${accountInfoNonce})`,
-      );
-    }
-
     if (accountInfoNonce > tx.nonce) {
       throw predefined.NONCE_TOO_LOW(tx.nonce, accountInfoNonce);
     }
   }
 
   /**
-   * Checks the chain ID of the transaction.
-   * @param tx - The transaction.
+   * Validates that the transaction's chain ID matches the network's chain ID.
+   * Legacy unprotected transactions (pre-EIP155) are exempt from this check.
+   *
+   * @param {Transaction} tx - The transaction to validate.
+   * @throws {JsonRpcError} If the transaction's chain ID doesn't match the network's chain ID.
    */
   chainId(tx: Transaction): void {
     const txChainId = prepend0x(Number(tx.chainId).toString(16));
     const passes = this.isLegacyUnprotectedEtx(tx) || txChainId === this.chain;
     if (!passes) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Failed chainId precheck for sendRawTransaction(transaction=%s, chainId=%s)`,
-          JSON.stringify(tx),
-          txChainId,
-        );
-      }
       throw predefined.UNSUPPORTED_CHAIN_ID(txChainId, this.chain);
     }
   }
@@ -181,14 +162,6 @@ export class Precheck {
         }
       }
 
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Failed gas price precheck for sendRawTransaction(transaction=%s, gasPrice=%s, requiredGasPrice=%s)`,
-          JSON.stringify(tx),
-          txGasPrice,
-          networkGasPrice,
-        );
-      }
       throw predefined.GAS_PRICE_TOO_LOW(txGasPrice, networkGasPrice);
     }
   }
@@ -204,59 +177,15 @@ export class Precheck {
 
   /**
    * Checks the balance of the sender account.
-   * @param tx - The transaction.
-   * @param account - The account information.
+   * @param {Transaction} tx - The transaction.
+   * @param {number} accountBalance - The account balance in tinybars.
    */
-  balance(tx: Transaction, account: any): void {
-    const result = {
-      passes: false,
-      error: predefined.INSUFFICIENT_ACCOUNT_BALANCE,
-    };
-
+  balance(tx: Transaction, accountBalance: number): void {
     const txGasPrice = BigInt(tx.gasPrice || tx.maxFeePerGas! + tx.maxPriorityFeePerGas!);
     const txTotalValue = tx.value + txGasPrice * tx.gasLimit;
+    const accountBalanceInWeiBars = BigInt(accountBalance.toString()) * BigInt(constants.TINYBAR_TO_WEIBAR_COEF);
 
-    if (account == null) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Failed to retrieve account details from mirror node on balance precheck for sendRawTransaction(transaction=${JSON.stringify(
-            tx,
-          )}, totalValue=${txTotalValue})`,
-        );
-      }
-      throw predefined.RESOURCE_NOT_FOUND(`tx.from '${tx.from}'.`);
-    }
-
-    let tinybars: bigint;
-    try {
-      tinybars = BigInt(account.balance.balance.toString()) * BigInt(constants.TINYBAR_TO_WEIBAR_COEF);
-      result.passes = tinybars >= txTotalValue;
-    } catch (error: any) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Error on balance precheck for sendRawTransaction(transaction=%s, totalValue=%s, error=%s)`,
-          JSON.stringify(tx),
-          txTotalValue,
-          error.message,
-        );
-      }
-      if (error instanceof JsonRpcError) {
-        // preserve original error
-        throw error;
-      } else {
-        throw predefined.INTERNAL_ERROR(`balance precheck: ${error.message}`);
-      }
-    }
-
-    if (!result.passes) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Failed balance precheck for sendRawTransaction(transaction=%s, totalValue=%s, accountTinyBarBalance=%s)`,
-          JSON.stringify(tx),
-          txTotalValue,
-          tinybars,
-        );
-      }
+    if (accountBalanceInWeiBars < txTotalValue) {
       throw predefined.INSUFFICIENT_ACCOUNT_BALANCE;
     }
   }
@@ -267,29 +196,11 @@ export class Precheck {
    */
   gasLimit(tx: Transaction): void {
     const gasLimit = Number(tx.gasLimit);
-    const failBaseLog = 'Failed gasLimit precheck for sendRawTransaction(transaction=%s).';
-
     const intrinsicGasCost = Precheck.transactionIntrinsicGasCost(tx.data);
 
     if (gasLimit > constants.MAX_TRANSACTION_FEE_THRESHOLD) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `${failBaseLog} Gas Limit was too high: %s, block gas limit: %s`,
-          JSON.stringify(tx),
-          gasLimit,
-          constants.MAX_TRANSACTION_FEE_THRESHOLD,
-        );
-      }
       throw predefined.GAS_LIMIT_TOO_HIGH(gasLimit, constants.MAX_TRANSACTION_FEE_THRESHOLD);
     } else if (gasLimit < intrinsicGasCost) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `${failBaseLog} Gas Limit was too low: %s, intrinsic gas cost: %s`,
-          JSON.stringify(tx),
-          gasLimit,
-          intrinsicGasCost,
-        );
-      }
       throw predefined.GAS_LIMIT_TOO_LOW(gasLimit, intrinsicGasCost);
     }
   }
@@ -356,12 +267,7 @@ export class Precheck {
   transactionType(tx: Transaction) {
     // Blob transactions are not supported as per HIP 866
     if (tx.type === 3) {
-      if (this.logger.isLevelEnabled('trace')) {
-        this.logger.trace(
-          `Transaction with type=${tx.type} is unsupported for sendRawTransaction(transaction=${JSON.stringify(tx)})`,
-        );
-      }
-      throw predefined.UNSUPPORTED_TRANSACTION_TYPE;
+      throw predefined.UNSUPPORTED_TRANSACTION_TYPE(tx.type);
     }
   }