feat: encapsulate ENABLE_TX_POOL flag in TransactionPoolService (#4581)

Signed-off-by: nikolay <n.atanasow94@gmail.com>

Author: natanasow

packages/relay/src/lib/precheck.ts

@@ -74,8 +74,7 @@ export class Precheck {
     this.gasPrice(parsedTx, networkGasPriceInWeiBars);
     const mirrorAccountInfo = await this.verifyAccount(parsedTx, requestDetails);
     const signerNonce =
-      mirrorAccountInfo.ethereum_nonce +
-      (ConfigService.get('ENABLE_TX_POOL') ? await this.transactionPoolService.getPendingCount(parsedTx.from!) : 0);
+      mirrorAccountInfo.ethereum_nonce + (await this.transactionPoolService.getPendingCount(parsedTx.from!));
     this.nonce(parsedTx, signerNonce);
     this.balance(parsedTx, mirrorAccountInfo.balance);
     await this.receiverAccount(parsedTx, requestDetails);

packages/relay/src/lib/services/ethService/accountService/AccountService.ts

@@ -319,7 +319,7 @@ export class AccountService implements IAccountService {
       return constants.ZERO_HEX;
     } else if (this.common.blockTagIsLatestOrPending(blockNumOrTag)) {
       const mnNonce = await this.getAccountLatestEthereumNonce(address, requestDetails);
-      if (ConfigService.get('ENABLE_TX_POOL') && blockNumOrTag == constants.BLOCK_PENDING) {
+      if (blockNumOrTag == constants.BLOCK_PENDING) {
         return numberTo0x(Number(mnNonce) + (await this.transactionPoolService.getPendingCount(address)));
       }
       return mnNonce;

packages/relay/src/lib/services/ethService/transactionService/TransactionService.ts

@@ -260,9 +260,7 @@ export class TransactionService implements ITransactionService {
     await this.validateRawTransaction(parsedTx, networkGasPriceInWeiBars, requestDetails);
 
     // Save the transaction to the transaction pool before submitting it to the network
-    if (ConfigService.get('ENABLE_TX_POOL')) {
-      await this.transactionPoolService.saveTransaction(parsedTx.from!, parsedTx);
-    }
+    await this.transactionPoolService.saveTransaction(parsedTx.from!, parsedTx);
 
     /**
      * Note: If the USE_ASYNC_TX_PROCESSING feature flag is enabled,
@@ -498,9 +496,7 @@ export class TransactionService implements ITransactionService {
     );
 
     // Remove the transaction from the transaction pool after submission
-    if (ConfigService.get('ENABLE_TX_POOL')) {
-      await this.transactionPoolService.removeTransaction(originalCallerAddress, parsedTx.serialized);
-    }
+    await this.transactionPoolService.removeTransaction(originalCallerAddress, parsedTx.serialized);
 
     sendRawTransactionError = error;
 

packages/relay/src/lib/services/transactionPoolService/transactionPoolService.ts

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
+import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
 import { Transaction } from 'ethers';
 import { Logger } from 'pino';
 
@@ -13,6 +14,13 @@ import {
  * Acts as a facade for the underlying storage layer and coordinates transaction lifecycle.
  */
 export class TransactionPoolService implements ITransactionPoolService {
+  /**
+   * Return if the transaction pool is enabled based on ENABLE_TX_POOL env
+   */
+  public static isEnabled(): boolean {
+    return ConfigService.get('ENABLE_TX_POOL');
+  }
+
   /**
    * The logger used for logging transaction pool operations.
    *
@@ -46,6 +54,10 @@ export class TransactionPoolService implements ITransactionPoolService {
    * @returns A promise that resolves once the transaction is stored.
    */
   async saveTransaction(address: string, tx: Transaction): Promise<void> {
+    if (!TransactionPoolService.isEnabled()) {
+      return;
+    }
+
     const addressLowerCased = address.toLowerCase();
     const rlpHex = tx.serialized;
 
@@ -70,6 +82,10 @@ export class TransactionPoolService implements ITransactionPoolService {
    * @returns A promise that resolves to the new pending transaction count for the address.
    */
   async removeTransaction(address: string, rlpHex: string): Promise<void> {
+    if (!TransactionPoolService.isEnabled()) {
+      return;
+    }
+
     const addressLowerCased = address.toLowerCase();
 
     try {

packages/relay/tests/lib/eth/eth_sendRawTransaction.spec.ts

@@ -23,6 +23,7 @@ import { formatTransactionIdWithoutQueryParams } from '../../../src/formatters';
 import { SDKClient } from '../../../src/lib/clients';
 import constants from '../../../src/lib/constants';
 import { SDKClientError } from '../../../src/lib/errors/SDKClientError';
+import { TransactionPoolService } from '../../../src/lib/services';
 import { CacheService } from '../../../src/lib/services/cacheService/cacheService';
 import HAPIService from '../../../src/lib/services/hapiService/hapiService';
 import { HbarLimitService } from '../../../src/lib/services/hbarLimitService';
@@ -63,6 +64,15 @@ describe('@ethSendRawTransaction eth_sendRawTransaction spec', async function ()
     sdkClientStub = sinon.createStubInstance(SDKClient);
     getSdkClientStub = sinon.stub(hapiServiceInstance, 'getSDKClient').returns(sdkClientStub);
     restMock.onGet('network/fees').reply(200, JSON.stringify(DEFAULT_NETWORK_FEES));
+    ethImpl['transactionService']['precheck']['transactionPoolService'] = new TransactionPoolService(
+      {
+        getList: sinon.stub(),
+        addToList: sinon.stub(),
+        removeFromList: sinon.stub(),
+        removeAll: sinon.stub(),
+      },
+      pino({ level: 'silent' }),
+    );
   });
 
   this.afterEach(() => {

packages/relay/tests/lib/openrpc.spec.ts

@@ -24,6 +24,7 @@ import { HbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLi
 import { IPAddressHbarSpendingPlanRepository } from '../../src/lib/db/repositories/hbarLimiter/ipAddressHbarSpendingPlanRepository';
 import { EthImpl } from '../../src/lib/eth';
 import { NetImpl } from '../../src/lib/net';
+import { TransactionPoolService } from '../../src/lib/services';
 import { CacheService } from '../../src/lib/services/cacheService/cacheService';
 import ClientService from '../../src/lib/services/hapiService/hapiService';
 import { HbarLimitService } from '../../src/lib/services/hbarLimitService';
@@ -129,6 +130,15 @@ describe('Open RPC Specification', function () {
     sdkClientStub = sinon.createStubInstance(SDKClient);
     sinon.stub(clientServiceInstance, 'getSDKClient').returns(sdkClientStub);
     ethImpl = new EthImpl(clientServiceInstance, mirrorNodeInstance, logger, '0x12a', cacheService);
+    ethImpl['transactionService']['precheck']['transactionPoolService'] = new TransactionPoolService(
+      {
+        getList: sinon.stub(),
+        addToList: sinon.stub(),
+        removeFromList: sinon.stub(),
+        removeAll: sinon.stub(),
+      },
+      pino({ level: 'silent' }),
+    );
     ns = { eth: ethImpl, net: new NetImpl(), web3: new Web3Impl() };
 
     // mocked data

packages/relay/tests/lib/services/transactionPoolService/transactionPoolService.spec.ts

@@ -7,8 +7,13 @@ import * as sinon from 'sinon';
 
 import { TransactionPoolService } from '../../../../src/lib/services/transactionPoolService/transactionPoolService';
 import { PendingTransactionStorage } from '../../../../src/lib/types/transactionPool';
+import { overrideEnvsInMochaDescribe, withOverriddenEnvsInMochaTest } from '../../../helpers';
 
 describe('TransactionPoolService Test Suite', function () {
+  overrideEnvsInMochaDescribe({
+    ENABLE_TX_POOL: true,
+  });
+
   this.timeout(10000);
 
   let logger: Logger;
@@ -59,6 +64,14 @@ describe('TransactionPoolService Test Suite', function () {
   });
 
   describe('saveTransaction', () => {
+    withOverriddenEnvsInMochaTest({ ENABLE_TX_POOL: false }, () => {
+      it(`should not execute .addToList if ENABLE_TX_POOL is set to false`, async function () {
+        mockStorage.addToList.resolves();
+        await transactionPoolService.saveTransaction(testAddress, testTransaction);
+        expect(mockStorage.addToList.notCalled).to.be.true;
+      });
+    });
+
     it('should successfully save transaction to pool', async () => {
       mockStorage.addToList.resolves();
 
@@ -89,6 +102,14 @@ describe('TransactionPoolService Test Suite', function () {
   });
 
   describe('removeTransaction', () => {
+    withOverriddenEnvsInMochaTest({ ENABLE_TX_POOL: false }, () => {
+      it(`should not execute .removeFromList if ENABLE_TX_POOL is set to false`, async function () {
+        mockStorage.removeFromList.resolves();
+        await transactionPoolService.removeTransaction(testAddress, testTxHash);
+        expect(mockStorage.removeFromList.notCalled).to.be.true;
+      });
+    });
+
     it('should successfully remove transaction from pool', async () => {
       mockStorage.removeFromList.resolves();