feat: import LockService as constructor params instead of passing down

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

Author: quiet-node

packages/relay/src/lib/clients/sdkClient.ts

@@ -68,12 +68,14 @@ export class SDKClient {
    * @param logger - The logger instance for logging information, warnings, and errors.
    * @param eventEmitter - The eventEmitter used for emitting and handling events within the class.
    * @param hbarLimitService - The HbarLimitService that tracks hbar expenses and limits.
+   * @param lockService - Service for managing access control locks.
    */
   constructor(
     hederaNetwork: string,
     logger: Logger,
     private readonly eventEmitter: EventEmitter<TypedEvents>,
     hbarLimitService: HbarLimitService,
+    public readonly lockService: LockService,
   ) {
     const client =
       hederaNetwork in constants.CHAIN_IDS
@@ -135,7 +137,6 @@ export class SDKClient {
    * @param {string} originalCallerAddress - The address of the original caller making the request.
    * @param {number} networkGasPriceInWeiBars - The predefined gas price of the network in weibar.
    * @param {number} currentNetworkExchangeRateInCents - The exchange rate in cents of the current network.
-   * @param {LockService} lockService - The service for managing transaction locks.
    * @param {string | null} lockSessionKey - The session key for the acquired lock, null if no lock was acquired.
    * @returns {Promise<{ txResponse: TransactionResponse; fileId: FileId | null }>}
    * @throws {SDKClientError} Throws an error if no file ID is created or if the preemptive fee check fails.
@@ -147,7 +148,6 @@ export class SDKClient {
     originalCallerAddress: string,
     networkGasPriceInWeiBars: number,
     currentNetworkExchangeRateInCents: number,
-    lockService: LockService,
     lockSessionKey: string | null,
   ): Promise<{ txResponse: TransactionResponse; fileId: FileId | null }> {
     const jumboTxEnabled = ConfigService.get('JUMBO_TX_ENABLED');
@@ -194,7 +194,6 @@ export class SDKClient {
         requestDetails,
         true,
         originalCallerAddress,
-        lockService,
         lockSessionKey,
       ),
     };
@@ -272,7 +271,6 @@ export class SDKClient {
    * @param requestDetails - The request details for logging and tracking.
    * @param shouldThrowHbarLimit - Flag to indicate whether to check HBAR limits.
    * @param originalCallerAddress - The address of the original caller making the request.
-   * @param lockService - The service for managing transaction locks.
    * @param estimatedTxFee - The optional total estimated transaction fee.
    * @param lockSessionKey - The session key for the acquired lock, null if no lock was acquired.
    * @returns - A promise that resolves to the transaction response.
@@ -284,7 +282,6 @@ export class SDKClient {
     requestDetails: RequestDetails,
     shouldThrowHbarLimit: boolean,
     originalCallerAddress: string,
-    lockService?: LockService,
     lockSessionKey?: string | null,
     estimatedTxFee?: number,
   ): Promise<TransactionResponse> {
@@ -343,9 +340,9 @@ export class SDKClient {
       }
       return transactionResponse;
     } finally {
-      // Eventually release the transaction mutex lock if it was acquired by the sender
-      if (lockService && lockSessionKey) {
-        await lockService.releaseLock(originalCallerAddress, lockSessionKey);
+      // Eventually release the transaction lock if it was acquired by the sender using lockSessionKey
+      if (lockSessionKey) {
+        await this.lockService.releaseLock(originalCallerAddress, lockSessionKey);
       }
 
       if (transactionId?.length) {

packages/relay/src/lib/eth.ts

@@ -108,12 +108,6 @@ export class EthImpl implements Eth {
    */
   private readonly transactionService: ITransactionService;
 
-  /**
-   * The service responsible for managing locks to ensure proper resource synchronization.
-   * @private
-   */
-  private readonly lockService: LockService;
-
   /**
    * Constructs an instance of the service responsible for handling Ethereum JSON-RPC methods
    * using Hedera Hashgraph as the underlying network.
@@ -123,13 +117,15 @@ export class EthImpl implements Eth {
    * @param {Logger} logger - Logger instance for logging system messages.
    * @param {string} chain - The chain identifier for the current blockchain environment.
    * @param {CacheService} cacheService - Service for managing cached data.
+   * @param {LockService} lockService - Service for managing access control locks.
    */
   constructor(
     hapiService: HAPIService,
     mirrorNodeClient: MirrorNodeClient,
     logger: Logger,
     chain: string,
     public readonly cacheService: CacheService,
+    public readonly lockService: LockService,
   ) {
     this.chain = chain;
     this.logger = logger;
@@ -141,7 +137,6 @@ export class EthImpl implements Eth {
     this.contractService = new ContractService(cacheService, this.common, hapiService, logger, mirrorNodeClient);
     this.accountService = new AccountService(cacheService, this.common, logger, mirrorNodeClient);
     this.blockService = new BlockService(cacheService, chain, this.common, mirrorNodeClient, logger);
-    this.lockService = new LockService(logger);
 
     this.transactionService = new TransactionService(
       cacheService,

packages/relay/src/lib/relay.ts

@@ -32,6 +32,7 @@ import {
   RpcNamespaceRegistry,
 } from './types';
 import { Web3Impl } from './web3';
+import { LockService } from './services';
 
 export class Relay {
   /**
@@ -153,8 +154,8 @@ export class Relay {
       register,
       duration,
     );
-
-    const hapiService = new HAPIService(logger, register, hbarLimitService);
+    const lockService = new LockService(logger);
+    const hapiService = new HAPIService(logger, register, hbarLimitService, lockService);
 
     this.operatorAccountId = hapiService.getOperatorAccountId();
 
@@ -181,6 +182,7 @@ export class Relay {
       logger.child({ name: 'relay-eth' }),
       chainId,
       this.cacheService,
+      lockService,
     );
 
     (this.ethImpl as EthImpl).eventEmitter.on('eth_execution', (args: IEthExecutionEventPayload) => {

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

@@ -281,7 +281,6 @@ export class TransactionService implements ITransactionService {
           transactionBuffer,
           parsedTx,
           networkGasPriceInWeiBars,
-          this.lockService,
           lockSessionKey,
           requestDetails,
         );
@@ -296,7 +295,6 @@ export class TransactionService implements ITransactionService {
         transactionBuffer,
         parsedTx,
         networkGasPriceInWeiBars,
-        this.lockService,
         lockSessionKey,
         requestDetails,
       );
@@ -495,7 +493,6 @@ export class TransactionService implements ITransactionService {
    * @param {Buffer} transactionBuffer - The raw transaction data as a buffer.
    * @param {EthersTransaction} parsedTx - The parsed Ethereum transaction object.
    * @param {number} networkGasPriceInWeiBars - The current network gas price in wei bars.
-   * @param {LockService} lockService - The service for managing locks.
    * @param {string | null} lockSessionKey - The session key for the acquired lock, null if no lock was acquired.
    * @param {RequestDetails} requestDetails - Details of the request for logging and tracking purposes.
    * @returns {Promise<string | JsonRpcError>} A promise that resolves to the transaction hash if successful, or a JsonRpcError if an error occurs.
@@ -504,7 +501,6 @@ export class TransactionService implements ITransactionService {
     transactionBuffer: Buffer,
     parsedTx: EthersTransaction,
     networkGasPriceInWeiBars: number,
-    lockService: LockService,
     lockSessionKey: string | null,
     requestDetails: RequestDetails,
   ): Promise<string | JsonRpcError> {
@@ -520,7 +516,6 @@ export class TransactionService implements ITransactionService {
       transactionBuffer,
       originalCallerAddress,
       networkGasPriceInWeiBars,
-      lockService,
       lockSessionKey,
       requestDetails,
     );
@@ -668,7 +663,6 @@ export class TransactionService implements ITransactionService {
    * @param transactionBuffer The raw transaction buffer
    * @param originalCallerAddress The address of the original caller
    * @param networkGasPriceInWeiBars The current network gas price in wei bars
-   * @param lockService The service for managing locks
    * @param lockSessionKey The session key for the acquired lock, null if no lock was acquired
    * @param requestDetails The request details for logging and tracking
    * @returns {Promise<{txSubmitted: boolean, submittedTransactionId: string, error: any}>} A promise that resolves to an object containing transaction submission details
@@ -677,7 +671,6 @@ export class TransactionService implements ITransactionService {
     transactionBuffer: Buffer,
     originalCallerAddress: string,
     networkGasPriceInWeiBars: number,
-    lockService: LockService,
     lockSessionKey: string | null,
     requestDetails: RequestDetails,
   ): Promise<{
@@ -698,7 +691,6 @@ export class TransactionService implements ITransactionService {
         originalCallerAddress,
         networkGasPriceInWeiBars,
         await this.getCurrentNetworkExchangeRateInCents(requestDetails),
-        lockService,
         lockSessionKey,
       );
 

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

@@ -94,8 +94,14 @@ export default class HAPIService {
    * @param logger - The logger instance used for logging.
    * @param register - The registry instance for metrics and other services.
    * @param hbarLimitService - An HBAR Rate Limit service that tracks hbar expenses and limits.
+   * @param lockService - Service for managing access control locks.
    */
-  constructor(logger: Logger, register: Registry, hbarLimitService: HbarLimitService) {
+  constructor(
+    logger: Logger,
+    register: Registry,
+    hbarLimitService: HbarLimitService,
+    public readonly lockService: LockService,
+  ) {
     this.logger = logger;
     this.hbarLimitService = hbarLimitService;
     this.eventEmitter = new EventEmitter<TypedEvents>();
@@ -191,6 +197,7 @@ export default class HAPIService {
       this.logger.child({ name: `consensus-node` }),
       this.eventEmitter,
       this.hbarLimitService,
+      this.lockService,
     );
   }
 
@@ -243,7 +250,6 @@ export default class HAPIService {
     originalCallerAddress: string,
     networkGasPriceInWeiBars: number,
     currentNetworkExchangeRateInCents: number,
-    lockService: LockService,
     lockSessionKey: string | null,
   ): Promise<{ txResponse: TransactionResponse; fileId: FileId | null }> {
     return this.getSDKClient().submitEthereumTransaction(
@@ -253,7 +259,6 @@ export default class HAPIService {
       originalCallerAddress,
       networkGasPriceInWeiBars,
       currentNetworkExchangeRateInCents,
-      lockService,
       lockSessionKey,
     );
   }

packages/relay/tests/lib/eth/eth-helpers.ts

@@ -16,6 +16,7 @@ import { CommonService } 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';
+import { LockService } from '../../../src/lib/services/lockService/LockService';
 
 export function contractResultsByNumberByIndexURL(number: number, index: number): string {
   return `contracts/results?block.number=${number}&transaction.index=${index}&limit=100&order=asc`;
@@ -59,11 +60,13 @@ export function generateEthTestEnv(fixedFeeHistory = false) {
     duration,
   );
 
-  const hapiServiceInstance = new HAPIService(logger, registry, hbarLimitService);
+  const lockService = new LockService(logger);
+
+  const hapiServiceInstance = new HAPIService(logger, registry, hbarLimitService, lockService);
 
   const commonService = new CommonService(mirrorNodeInstance, logger, cacheService);
 
-  const ethImpl = new EthImpl(hapiServiceInstance, mirrorNodeInstance, logger, '0x12a', cacheService);
+  const ethImpl = new EthImpl(hapiServiceInstance, mirrorNodeInstance, logger, '0x12a', cacheService, lockService);
 
   return {
     cacheService,

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

@@ -36,7 +36,6 @@ import { generateEthTestEnv } from './eth-helpers';
 use(chaiAsPromised);
 
 let sdkClientStub: sinon.SinonStubbedInstance<SDKClient>;
-let getSdkClientStub: sinon.SinonStub;
 
 describe('@ethSendRawTransaction eth_sendRawTransaction spec', async function () {
   this.timeout(10000);
@@ -61,11 +60,9 @@ describe('@ethSendRawTransaction eth_sendRawTransaction spec', async function ()
     await cacheService.clear();
     restMock.reset();
     sdkClientStub = sinon.createStubInstance(SDKClient);
-    getSdkClientStub = sinon.stub(hapiServiceInstance, 'getSDKClient').returns(sdkClientStub);
     restMock.onGet('network/fees').reply(200, JSON.stringify(DEFAULT_NETWORK_FEES));
   });
   this.afterEach(() => {
-    getSdkClientStub.restore();
     restMock.resetHandlers();
   });
 

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

@@ -27,6 +27,7 @@ import { NetImpl } from '../../src/lib/net';
 import { CacheService } from '../../src/lib/services/cacheService/cacheService';
 import ClientService from '../../src/lib/services/hapiService/hapiService';
 import { HbarLimitService } from '../../src/lib/services/hbarLimitService';
+import { LockService } from '../../src/lib/services/lockService/LockService';
 import { RequestDetails } from '../../src/lib/types';
 import { Web3Impl } from '../../src/lib/web3';
 import {
@@ -125,10 +126,11 @@ describe('Open RPC Specification', function () {
       duration,
     );
 
-    clientServiceInstance = new ClientService(logger, registry, hbarLimitService);
+    const lockService = new LockService(logger);
+
+    clientServiceInstance = new ClientService(logger, registry, hbarLimitService, lockService);
     sdkClientStub = sinon.createStubInstance(SDKClient);
-    sinon.stub(clientServiceInstance, 'getSDKClient').returns(sdkClientStub);
-    ethImpl = new EthImpl(clientServiceInstance, mirrorNodeInstance, logger, '0x12a', cacheService);
+    ethImpl = new EthImpl(clientServiceInstance, mirrorNodeInstance, logger, '0x12a', cacheService, lockService);
     ns = { eth: ethImpl, net: new NetImpl(), web3: new Web3Impl() };
 
     // mocked data