chore: refactor SDKClient and HAPIService (#4210)

Signed-off-by: Luis Mastrangelo <[email protected]>

Author: acuarica

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

@@ -5,14 +5,12 @@ import { Status } from '@hashgraph/sdk';
 export class SDKClientError extends Error {
   public status: Status = Status.Unknown;
   public nodeAccountId: string | undefined;
-  private validNetworkError: boolean = false;
   private failedTransactionId: string | undefined;
 
   constructor(e: any, message?: string, transactionId?: string, nodeId?: string | undefined) {
     super(e?.status?._code ? e.message : message);
 
     if (e?.status?._code) {
-      this.validNetworkError = true;
       this.status = e.status;
     }
     this.failedTransactionId = transactionId || '';
@@ -28,30 +26,6 @@ export class SDKClientError extends Error {
     return this.failedTransactionId;
   }
 
-  public isValidNetworkError(): boolean {
-    return this.validNetworkError;
-  }
-
-  public isInvalidAccountId(): boolean {
-    return this.isValidNetworkError() && this.statusCode === Status.InvalidAccountId._code;
-  }
-
-  public isInvalidContractId(): boolean {
-    return (
-      this.isValidNetworkError() &&
-      (this.statusCode === Status.InvalidContractId._code ||
-        this.message?.includes(Status.InvalidContractId.toString()))
-    );
-  }
-
-  public isContractDeleted(): boolean {
-    return this.statusCode == Status.ContractDeleted._code;
-  }
-
-  public isInsufficientTxFee(): boolean {
-    return this.statusCode === Status.InsufficientTxFee._code;
-  }
-
   public isContractRevertExecuted(): boolean {
     return this.statusCode == Status.ContractRevertExecuted._code;
   }

packages/relay/src/lib/errors/SDKClientError.ts

@@ -126,13 +126,14 @@ export class EthImpl implements Eth {
   ) {
     this.chain = chain;
     this.logger = logger;
+    this.eventEmitter = new EventEmitter<TypedEvents>();
+
     this.common = new CommonService(mirrorNodeClient, logger, cacheService);
     this.filterService = new FilterService(mirrorNodeClient, logger, cacheService, this.common);
     this.feeService = new FeeService(mirrorNodeClient, this.common, logger);
     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.eventEmitter = new EventEmitter<TypedEvents>();
     this.transactionService = new TransactionService(
       cacheService,
       chain,
@@ -563,7 +564,7 @@ export class EthImpl implements Eth {
   @rpcMethod
   @rpcParamLayoutConfig(RPC_LAYOUT.REQUEST_DETAILS_ONLY)
   signTransaction(): JsonRpcError {
-    return this.transactionService.signTransaction();
+    return predefined.UNSUPPORTED_METHOD;
   }
 
   /**
@@ -577,7 +578,7 @@ export class EthImpl implements Eth {
   @rpcMethod
   @rpcParamLayoutConfig(RPC_LAYOUT.REQUEST_DETAILS_ONLY)
   sign(): JsonRpcError {
-    return this.transactionService.sign();
+    return predefined.UNSUPPORTED_METHOD;
   }
 
   /**
@@ -591,7 +592,7 @@ export class EthImpl implements Eth {
   @rpcMethod
   @rpcParamLayoutConfig(RPC_LAYOUT.REQUEST_DETAILS_ONLY)
   sendTransaction(): JsonRpcError {
-    return this.transactionService.sendTransaction();
+    return predefined.UNSUPPORTED_METHOD;
   }
 
   /**

packages/relay/src/lib/eth.ts

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
-import { Client } from '@hashgraph/sdk';
+import { AccountId } from '@hashgraph/sdk';
 import { Logger } from 'pino';
 import { Gauge, Registry } from 'prom-client';
 
@@ -35,11 +35,9 @@ import { Web3Impl } from './web3';
 
 export class Relay {
   /**
-   * @private
-   * @readonly
-   * @property {Client} clientMain - The primary Hedera client used for interacting with the Hedera network.
+   * The primary Hedera client used for interacting with the Hedera network.
    */
-  private readonly clientMain: Client;
+  private readonly operatorAccountId: AccountId | null;
 
   /**
    * @private
@@ -158,7 +156,7 @@ export class Relay {
 
     const hapiService = new HAPIService(logger, register, hbarLimitService);
 
-    this.clientMain = hapiService.getMainClientInstance();
+    this.operatorAccountId = hapiService.getOperatorAccountId();
 
     this.web3Impl = new Web3Impl();
     this.netImpl = new NetImpl();
@@ -172,13 +170,10 @@ export class Relay {
       ConfigService.get('MIRROR_NODE_URL_WEB3') || ConfigService.get('MIRROR_NODE_URL'),
     );
 
-    this.metricService = new MetricService(
-      logger,
-      hapiService.getSDKClient(),
-      this.mirrorNodeClient,
-      register,
-      hbarLimitService,
-    );
+    const metricsCollector = ConfigService.get('GET_RECORD_DEFAULT_TO_CONSENSUS_NODE')
+      ? hapiService
+      : this.mirrorNodeClient;
+    this.metricService = new MetricService(logger, metricsCollector, register, hbarLimitService);
 
     this.ethImpl = new EthImpl(
       hapiService,
@@ -210,7 +205,7 @@ export class Relay {
       ipAddressHbarSpendingPlanRepository,
     );
 
-    this.initOperatorMetric(this.clientMain, this.mirrorNodeClient, logger, register);
+    this.initOperatorMetric(this.operatorAccountId, this.mirrorNodeClient, logger, register);
 
     this.populatePreconfiguredSpendingPlans().then();
 
@@ -265,14 +260,14 @@ export class Relay {
 
   /**
    * Initialize operator account metrics
-   * @param {Client} clientMain
-   * @param {MirrorNodeClient} mirrorNodeClient
-   * @param {Logger} logger
-   * @param {Registry} register
-   * @returns {Gauge} Operator Metric
+   * @param operatorAccountId
+   * @param mirrorNodeClient
+   * @param logger
+   * @param register
+   * @returns Operator Metric
    */
   private initOperatorMetric(
-    clientMain: Client,
+    operatorAccountId: AccountId | null,
     mirrorNodeClient: MirrorNodeClient,
     logger: Logger,
     register: Registry,
@@ -288,9 +283,9 @@ export class Relay {
         // Invoked when the registry collects its metrics' values.
         // Allows for updated account balance tracking
         try {
-          const operatorAccountId = clientMain.operatorAccountId!.toString();
+          const accountId = operatorAccountId!.toString();
           const account = await mirrorNodeClient.getAccount(
-            operatorAccountId,
+            accountId,
             new RequestDetails({ requestId: Utils.generateRequestId(), ipAddress: '' }),
           );
 
@@ -303,7 +298,7 @@ export class Relay {
               ? accountBalance.toNumber()
               : Number(accountBalance);
 
-          this.labels({ accountId: operatorAccountId }).set(numericBalance);
+          this.labels({ accountId }).set(numericBalance);
         } catch (e: any) {
           logger.error(e, `Error collecting operator balance. Skipping balance set`);
         }
@@ -338,7 +333,7 @@ export class Relay {
   async ensureOperatorHasBalance() {
     if (ConfigService.get('READ_ONLY')) return;
 
-    const operator = this.clientMain.operatorAccountId!.toString();
+    const operator = this.operatorAccountId!.toString();
     const balance = BigInt(await this.ethImpl.getBalance(operator, 'latest', {} as RequestDetails));
     if (balance === BigInt(0)) {
       throw new Error(`Operator account '${operator}' has no balance`);

packages/relay/src/lib/relay.ts

@@ -371,9 +371,9 @@ export class ContractService implements IContractService {
     }
     if (!transaction.from && transaction.value && (transaction.value as number) > 0) {
       if (ConfigService.get('OPERATOR_KEY_FORMAT') === 'HEX_ECDSA') {
-        transaction.from = this.hapiService.getMainClientInstance().operatorPublicKey?.toEvmAddress();
+        transaction.from = this.hapiService.getOperatorPublicKey()?.toEvmAddress();
       } else {
-        const operatorId = this.hapiService.getMainClientInstance().operatorAccountId!.toString();
+        const operatorId = this.hapiService.getOperatorAccountId()!.toString();
         const operatorAccount = await this.common.getAccount(operatorId, requestDetails);
         transaction.from = operatorAccount?.evm_address;
       }

packages/relay/src/lib/services/ethService/contractService/ContractService.ts

@@ -22,10 +22,4 @@ export interface ITransactionService {
   getTransactionReceipt(hash: string, requestDetails: RequestDetails): Promise<ITransactionReceipt | null>;
 
   sendRawTransaction(transaction: string, requestDetails: RequestDetails): Promise<string | JsonRpcError>;
-
-  sendTransaction(): JsonRpcError;
-
-  signTransaction(): JsonRpcError;
-
-  sign(): JsonRpcError;
 }

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

@@ -277,39 +277,6 @@ export class TransactionService implements ITransactionService {
     );
   }
 
-  /**
-   * Send transaction - not supported
-   * @returns A JsonRpcError indicating that the method is not supported
-   */
-  public sendTransaction(): JsonRpcError {
-    if (this.logger.isLevelEnabled('trace')) {
-      this.logger.trace('sendTransaction()');
-    }
-    return predefined.UNSUPPORTED_METHOD;
-  }
-
-  /**
-   * Sign transaction - not supported
-   * @returns A JsonRpcError indicating that the method is not supported
-   */
-  public signTransaction(): JsonRpcError {
-    if (this.logger.isLevelEnabled('trace')) {
-      this.logger.trace('signTransaction()');
-    }
-    return predefined.UNSUPPORTED_METHOD;
-  }
-
-  /**
-   * Sign - not supported
-   * @returns A JsonRpcError indicating that the method is not supported
-   */
-  public sign(): JsonRpcError {
-    if (this.logger.isLevelEnabled('trace')) {
-      this.logger.trace('sign()');
-    }
-    return predefined.UNSUPPORTED_METHOD;
-  }
-
   /**
    * Retrieves the current network exchange rate of HBAR to USD in cents.
    * @param requestDetails The request details for logging and tracking
@@ -684,16 +651,14 @@ export class TransactionService implements ITransactionService {
     let error = null;
 
     try {
-      const sendRawTransactionResult = await this.hapiService
-        .getSDKClient()
-        .submitEthereumTransaction(
-          transactionBuffer,
-          constants.ETH_SEND_RAW_TRANSACTION,
-          requestDetails,
-          originalCallerAddress,
-          networkGasPriceInWeiBars,
-          await this.getCurrentNetworkExchangeRateInCents(requestDetails),
-        );
+      const sendRawTransactionResult = await this.hapiService.submitEthereumTransaction(
+        transactionBuffer,
+        constants.ETH_SEND_RAW_TRANSACTION,
+        requestDetails,
+        originalCallerAddress,
+        networkGasPriceInWeiBars,
+        await this.getCurrentNetworkExchangeRateInCents(requestDetails),
+      );
 
       txSubmitted = true;
       fileId = sendRawTransactionResult.fileId;
@@ -716,14 +681,7 @@ export class TransactionService implements ITransactionService {
        */
       if (fileId) {
         this.hapiService
-          .getSDKClient()
-          .deleteFile(
-            fileId,
-            requestDetails,
-            constants.ETH_SEND_RAW_TRANSACTION,
-            fileId.toString(),
-            originalCallerAddress,
-          )
+          .deleteFile(fileId, requestDetails, constants.ETH_SEND_RAW_TRANSACTION, originalCallerAddress)
           .then();
       }
     }