Merge branch 'main' into 1837_openrpc-updater

Author: Ferparishuertas

MAINTAINERS.md

@@ -6,9 +6,11 @@ The general handling of Maintainer rights and all groups in this GitHub org is d
 
 Maintainers are assigned the following scopes in this repository:
 
-| Scope      | Definition               | GitHub Role | GitHub Team                        |
-| ---------- | ------------------------ | ----------- | ---------------------------------- |
-| Maintainer | The GitHub Maintain role | Maintain    | `hiero-json-rcp-relay-maintainers` |
+|        Scope        |            Definition             | GitHub Role |            GitHub Team             |
+|---------------------|-----------------------------------|-------------|------------------------------------|
+| project-maintainers | The Maintainers of the project    | Maintain    | `hiero-json-rcp-relay-maintainers` |
+| tsc                 | The Hiero TSC                     | Maintain    | `tsc`                              |
+| github-maintainers  | The Maintainers of the github org | Maintain    | `github-maintainers`               |
 
 ## Active Maintainers
 

dapp-example/package-lock.json

@@ -1064,29 +1064,11 @@
           },
           "description": "The hash of the transaction to trace."
         },
-        {
-          "name": "tracer",
-          "required": false,
-          "schema": {
-            "oneOf": [
-              {
-                "$ref": "#/components/schemas/TracerType"
-              },
-              {
-                "$ref": "#/components/schemas/TracerConfig"
-              },
-              {
-                "$ref": "#/components/schemas/TracerConfigWrapper"
-              }
-            ]
-          },
-          "description": "Specifies the type of tracer or configuration object for the tracer."
-        },
         {
           "name": "tracerConfig",
           "required": false,
           "schema": {
-            "$ref": "#/components/schemas/TracerConfig"
+            "$ref": "#/components/schemas/TracerConfigWrapper"
           },
           "description": "Configuration object for the tracer."
         }

docs/openrpc.json

@@ -1,6 +1,4 @@
 // SPDX-License-Identifier: Apache-2.0
-
-import { TracerType } from './lib/constants';
 import { JsonRpcError, predefined } from './lib/errors/JsonRpcError';
 import { MirrorNodeClientError } from './lib/errors/MirrorNodeClientError';
 import WebSocketError from './lib/errors/WebSocketError';
@@ -10,9 +8,9 @@ import {
   IContractCallRequest,
   IGetLogsParams,
   INewFilterParams,
-  ITracerConfig,
   ITransactionReceipt,
   RequestDetails,
+  TransactionTracerConfig,
 } from './lib/types';
 
 export { JsonRpcError, predefined, MirrorNodeClientError, WebSocketError };
@@ -22,8 +20,7 @@ export { Relay } from './lib/relay';
 export interface Debug {
   traceTransaction: (
     transactionIdOrHash: string,
-    tracer: TracerType,
-    tracerConfig: ITracerConfig,
+    tracerObject: TransactionTracerConfig,
     requestDetails: RequestDetails,
   ) => Promise<any>;
 
@@ -71,7 +68,7 @@ export interface Eth {
 
   getBalance(account: string, blockNumber: string | null, requestDetails: RequestDetails): Promise<string>;
 
-  getBlockReceipts(blockHashOrNumber: string, requestDetails: RequestDetails): Promise<ITransactionReceipt[]>;
+  getBlockReceipts(blockHashOrNumber: string, requestDetails: RequestDetails): Promise<ITransactionReceipt[] | null>;
 
   getBlockByHash(hash: string, showDetails: boolean, requestDetails: RequestDetails): Promise<Block | null>;
 

packages/relay/src/index.ts

@@ -19,11 +19,11 @@ import {
   EntityTraceStateMap,
   ICallTracerConfig,
   IOpcodeLoggerConfig,
-  ITracerConfig,
   MirrorNodeContractResult,
   ParamType,
   RequestDetails,
   TraceBlockByNumberTxResult,
+  TransactionTracerConfig,
 } from './types';
 
 /**
@@ -106,26 +106,34 @@ export class DebugImpl implements Debug {
   @rpcMethod
   @rpcParamValidationRules({
     0: { type: ParamType.TRANSACTION_HASH_OR_ID, required: true },
-    1: { type: ParamType.COMBINED_TRACER_TYPE, required: false },
-    2: { type: ParamType.TRACER_CONFIG, required: false },
+    1: { type: ParamType.TRACER_CONFIG_WRAPPER, required: false },
   })
+  @rpcParamLayoutConfig(RPC_LAYOUT.custom((params) => [params[0], params[1]]))
   @cache(CacheService.getInstance(CACHE_LEVEL.L1))
   async traceTransaction(
     transactionIdOrHash: string,
-    tracer: TracerType,
-    tracerConfig: ITracerConfig,
+    tracerObject: TransactionTracerConfig,
     requestDetails: RequestDetails,
   ): Promise<any> {
+    if (tracerObject?.tracer === TracerType.PrestateTracer) {
+      throw predefined.INVALID_PARAMETER(1, 'Prestate tracer is not yet supported on debug_traceTransaction');
+    }
+
     if (this.logger.isLevelEnabled('trace')) {
       this.logger.trace(`${requestDetails.formattedRequestId} traceTransaction(${transactionIdOrHash})`);
     }
+
+    //we use a wrapper since we accept a transaction where a second param with tracer/tracerConfig may not be provided
+    //and we will still default to opcodeLogger
+    const tracer = tracerObject?.tracer ?? TracerType.OpcodeLogger;
+    const tracerConfig = tracerObject?.tracerConfig ?? {};
+
     try {
       DebugImpl.requireDebugAPIEnabled();
       if (tracer === TracerType.CallTracer) {
         return await this.callTracer(transactionIdOrHash, tracerConfig as ICallTracerConfig, requestDetails);
-      } else if (tracer === TracerType.OpcodeLogger) {
-        return await this.callOpcodeLogger(transactionIdOrHash, tracerConfig as IOpcodeLoggerConfig, requestDetails);
       }
+      return await this.callOpcodeLogger(transactionIdOrHash, tracerConfig as IOpcodeLoggerConfig, requestDetails);
     } catch (e) {
       throw this.common.genericErrorHandler(e);
     }

packages/relay/src/lib/debug.ts

@@ -268,9 +268,6 @@ export class EthImpl implements Eth {
     if (callDataSize >= constants.FUNCTION_SELECTOR_CHAR_LENGTH) {
       this.eventEmitter.emit(constants.EVENTS.ETH_EXECUTION, {
         method: constants.ETH_ESTIMATE_GAS,
-        functionSelector: callData!.substring(0, constants.FUNCTION_SELECTOR_CHAR_LENGTH),
-        from: transaction.from || '',
-        to: transaction.to || '',
         requestDetails: requestDetails,
       });
     }
@@ -986,9 +983,6 @@ export class EthImpl implements Eth {
 
     this.eventEmitter.emit(constants.EVENTS.ETH_EXECUTION, {
       method: 'eth_call',
-      functionSelector: callData?.substring(0, constants.FUNCTION_SELECTOR_CHAR_LENGTH) || '',
-      from: call.from || '',
-      to: call.to || '',
       requestDetails: requestDetails,
     });
 
@@ -1108,7 +1102,7 @@ export class EthImpl implements Eth {
    *
    * @param {string } blockHashOrBlockNumber The block hash, block number, or block tag
    * @param {RequestDetails} requestDetails The request details for logging and tracking
-   * @returns {Promise<Receipt[]>} Array of transaction receipts for the block
+   * @returns {Promise<ITransactionReceipt[] | null>} Array of transaction receipts for the block or null if block not found
    */
   @rpcMethod
   @rpcParamValidationRules({
@@ -1120,7 +1114,7 @@ export class EthImpl implements Eth {
   public async getBlockReceipts(
     blockHashOrBlockNumber: string,
     requestDetails: RequestDetails,
-  ): Promise<ITransactionReceipt[]> {
+  ): Promise<ITransactionReceipt[] | null> {
     return await this.blockService.getBlockReceipts(blockHashOrBlockNumber, requestDetails);
   }
 

packages/relay/src/lib/eth.ts

@@ -121,12 +121,12 @@ export class BlockService implements IBlockService {
    *
    * @param {string} blockHashOrBlockNumber The block hash, block number, or block tag
    * @param {RequestDetails} requestDetails The request details for logging and tracking
-   * @returns {Promise<Receipt[]>} Array of transaction receipts for the block
+   * @returns {Promise<Receipt[] | null>} Array of transaction receipts for the block or null if block not found
    */
   public async getBlockReceipts(
     blockHashOrBlockNumber: string,
     requestDetails: RequestDetails,
-  ): Promise<ITransactionReceipt[]> {
+  ): Promise<ITransactionReceipt[] | null> {
     const requestIdPrefix = requestDetails.formattedRequestId;
     if (this.logger.isLevelEnabled('trace')) {
       this.logger.trace(`${requestIdPrefix} getBlockReceipt(${JSON.stringify(blockHashOrBlockNumber)})`);
@@ -135,7 +135,7 @@ export class BlockService implements IBlockService {
     const block = await this.common.getHistoricalBlockResponse(requestDetails, blockHashOrBlockNumber);
 
     if (block == null) {
-      throw predefined.RESOURCE_NOT_FOUND(`Block: ${blockHashOrBlockNumber}`);
+      return null;
     }
 
     const paramTimestamp: IContractResultsParams = {

packages/relay/src/lib/services/ethService/blockService/BlockService.ts

@@ -12,7 +12,7 @@ export interface IBlockService {
   getBlockByHash: (hash: string, showDetails: boolean, requestDetails: RequestDetails) => Promise<Block | null>;
   getBlockTransactionCountByHash: (hash: string, requestDetails: RequestDetails) => Promise<string | null>;
   getBlockTransactionCountByNumber: (blockNum: string, requestDetails: RequestDetails) => Promise<string | null>;
-  getBlockReceipts: (blockHash: string, requestDetails: RequestDetails) => Promise<ITransactionReceipt[]>;
+  getBlockReceipts: (blockHash: string, requestDetails: RequestDetails) => Promise<ITransactionReceipt[] | null>;
   getUncleByBlockHashAndIndex: (requestDetails: RequestDetails) => Promise<null>;
   getUncleByBlockNumberAndIndex: (requestDetails: RequestDetails) => Promise<null>;
   getUncleCountByBlockHash: (requestDetails: RequestDetails) => Promise<string>;

packages/relay/src/lib/services/ethService/blockService/IBlockService.ts

@@ -331,22 +331,11 @@ export class TransactionService implements ITransactionService {
 
   /**
    * Emits an Ethereum execution event with transaction details
-   * @param parsedTx The parsed transaction object
-   * @param originalCallerAddress The address of the original caller
-   * @param toAddress The destination address
    * @param requestDetails The request details for logging and tracking
    */
-  private emitEthExecutionEvent(
-    parsedTx: EthersTransaction,
-    originalCallerAddress: string,
-    toAddress: string,
-    requestDetails: RequestDetails,
-  ): void {
+  private emitEthExecutionEvent(requestDetails: RequestDetails): void {
     this.eventEmitter.emit(constants.EVENTS.ETH_EXECUTION, {
       method: constants.ETH_SEND_RAW_TRANSACTION,
-      functionSelector: parsedTx.data?.substring(0, constants.FUNCTION_SELECTOR_CHAR_LENGTH) || '',
-      from: originalCallerAddress,
-      to: toAddress,
       requestDetails: requestDetails,
     });
   }
@@ -560,9 +549,8 @@ export class TransactionService implements ITransactionService {
 
     const requestIdPrefix = requestDetails.formattedRequestId;
     const originalCallerAddress = parsedTx.from?.toString() || '';
-    const toAddress = parsedTx.to?.toString() || '';
 
-    this.emitEthExecutionEvent(parsedTx, originalCallerAddress, toAddress, requestDetails);
+    this.emitEthExecutionEvent(requestDetails);
 
     const { txSubmitted, submittedTransactionId, error } = await this.submitTransaction(
       transactionBuffer,

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

@@ -117,7 +117,7 @@ export default class MetricService {
     });
 
     this.eventEmitter.on(constants.EVENTS.ETH_EXECUTION, (args: IEthExecutionEventPayload) => {
-      this.ethExecutionsCounter.labels(args.method, args.functionSelector, args.from, args.to).inc();
+      this.ethExecutionsCounter.labels(args.method).inc();
     });
   }
 
@@ -262,7 +262,7 @@ export default class MetricService {
     return new Counter({
       name: metricCounterName,
       help: `Relay ${metricCounterName} function`,
-      labelNames: ['method', 'function', 'from', 'to'],
+      labelNames: ['method'],
       registers: [register],
     });
   }