fix: remove top level params for callTracer

Signed-off-by: Simeon Nakov <[email protected]>

Author: simzzz

packages/relay/src/lib/debug.ts

@@ -126,13 +126,13 @@ export class DebugImpl implements Debug {
     // Extract tracer config from either nested tracerConfig or top-level properties
     let tracerConfig = tracerObject?.tracerConfig ?? {};
 
-    // If no nested tracerConfig is provided, check for top-level tracer config properties
+    // If no nested tracerConfig is provided, check for top-level opcodeLogger config properties
     if (!tracerObject?.tracerConfig && tracerObject) {
       const { tracer: _, tracerConfig: __, ...topLevelConfig } = tracerObject;
-      // Only include valid tracer config properties
-      const validConfigKeys = ['onlyTopCall', 'enableMemory', 'disableStack', 'disableStorage'];
+      // Only include valid opcodeLogger config properties (callTracer properties are never at top level)
+      const validOpcodeLoggerKeys = ['enableMemory', 'disableStack', 'disableStorage'];
       const filteredConfig = Object.keys(topLevelConfig)
-        .filter((key) => validConfigKeys.includes(key))
+        .filter((key) => validOpcodeLoggerKeys.includes(key))
         .reduce((obj, key) => {
           obj[key] = topLevelConfig[key];
           return obj;

packages/relay/src/lib/types/ITracerConfigWrapper.ts

@@ -1,9 +1,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { TracerType } from '../constants';
-import { ICallTracerConfig, IOpcodeLoggerConfig, ITracerConfig } from './ITracerConfig';
+import { IOpcodeLoggerConfig, ITracerConfig } from './ITracerConfig';
 
-export interface ITracerConfigWrapper extends Partial<ICallTracerConfig>, Partial<IOpcodeLoggerConfig> {
+export interface ITracerConfigWrapper extends Partial<IOpcodeLoggerConfig> {
   tracer?: TracerType;
   tracerConfig?: ITracerConfig;
 }

packages/relay/src/lib/validators/objectTypes.ts

@@ -123,12 +123,6 @@ export const OBJECTS_VALIDATIONS: { [key: string]: IObjectSchema } = {
         nullable: false,
         required: false,
       },
-      // CallTracer config properties at top level
-      onlyTopCall: {
-        type: 'boolean',
-        nullable: false,
-        required: false,
-      },
       // OpcodeLogger config properties at top level
       enableMemory: {
         type: 'boolean',
@@ -261,9 +255,8 @@ export function validateTracerConfigWrapper(param: any): boolean {
   const callTracerKeys = Object.keys(OBJECTS_VALIDATIONS.callTracerConfig.properties);
   const opcodeLoggerKeys = Object.keys(OBJECTS_VALIDATIONS.opcodeLoggerConfig.properties);
 
-  // Check for tracer config properties at the top level
+  // Check for opcodeLogger config properties at the top level
   const topLevelKeys = Object.keys(param);
-  const hasTopLevelCallTracerKeys = topLevelKeys.some((k) => callTracerKeys.includes(k));
   const hasTopLevelOpcodeLoggerKeys = topLevelKeys.some((k) => opcodeLoggerKeys.includes(k));
 
   // Check for tracer config properties in nested tracerConfig
@@ -276,7 +269,7 @@ export function validateTracerConfigWrapper(param: any): boolean {
   }
 
   // Don't allow both top-level and nested config properties at the same time
-  if ((hasTopLevelCallTracerKeys || hasTopLevelOpcodeLoggerKeys) && tracerConfig) {
+  if (hasTopLevelOpcodeLoggerKeys && tracerConfig) {
     throw predefined.INVALID_PARAMETER(
       1,
       `Cannot specify tracer config properties both at top level and in 'tracerConfig' for ${schema.name}`,
@@ -286,18 +279,23 @@ export function validateTracerConfigWrapper(param: any): boolean {
   // Determine which tracer type should be used
   const effectiveTracer = tracer ?? TracerType.OpcodeLogger; // Default to opcodeLogger if no tracer specified
 
-  // Validate that the right config properties are used with the right tracer
-  const hasCallTracerKeys = hasTopLevelCallTracerKeys || hasNestedCallTracerKeys;
-  const hasOpcodeLoggerKeys = hasTopLevelOpcodeLoggerKeys || hasNestedOpcodeLoggerKeys;
+  // Validate that opcodeLogger config properties are only used with opcodeLogger tracer
+  if (hasTopLevelOpcodeLoggerKeys && effectiveTracer !== TracerType.OpcodeLogger) {
+    throw predefined.INVALID_PARAMETER(
+      1,
+      `opcodeLogger config properties for ${schema.name} are only valid when tracer=${TracerType.OpcodeLogger}`,
+    );
+  }
 
-  if (hasCallTracerKeys && effectiveTracer === TracerType.OpcodeLogger) {
+  // Validate nested config properties with tracer types (existing logic)
+  if (hasNestedCallTracerKeys && effectiveTracer === TracerType.OpcodeLogger) {
     throw predefined.INVALID_PARAMETER(
       1,
       `callTracer config properties for ${schema.name} are only valid when tracer=${TracerType.CallTracer}`,
     );
   }
 
-  if (hasOpcodeLoggerKeys && effectiveTracer !== TracerType.OpcodeLogger) {
+  if (hasNestedOpcodeLoggerKeys && effectiveTracer !== TracerType.OpcodeLogger) {
     throw predefined.INVALID_PARAMETER(
       1,
       `opcodeLogger config properties for ${schema.name} are only valid when tracer=${TracerType.OpcodeLogger}`,

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

@@ -672,8 +672,6 @@ describe('Validator', async () => {
       { tracer: Constants.TracerType.CallTracer, tracerConfig: {} },
       { tracer: Constants.TracerType.CallTracer },
       { tracerConfig: { onlyTopCall: true } },
-      // CallTracer config at top level
-      { tracer: Constants.TracerType.CallTracer, onlyTopCall: true },
       // OpcodeLoggerConfig
       {
         tracer: Constants.TracerType.OpcodeLogger,
@@ -707,21 +705,6 @@ describe('Validator', async () => {
         input: { tracer: 'invalid', tracerConfig: {} },
         error: expectInvalidParam("'tracer' for TracerConfigWrapper", TYPES.tracerType.error, 'invalid'),
       },
-      // CallTracer config properties with wrong tracer type
-      {
-        input: { tracer: Constants.TracerType.OpcodeLogger, onlyTopCall: true },
-        error: expectInvalidParam(
-          1,
-          'callTracer config properties for TracerConfigWrapper are only valid when tracer=callTracer',
-        ),
-      },
-      {
-        input: { onlyTopCall: true }, // defaults to opcodeLogger
-        error: expectInvalidParam(
-          1,
-          'callTracer config properties for TracerConfigWrapper are only valid when tracer=callTracer',
-        ),
-      },
       // OpcodeLogger config properties with wrong tracer type
       {
         input: { tracer: Constants.TracerType.CallTracer, enableMemory: true },

packages/server/tests/acceptance/debug.spec.ts

@@ -674,22 +674,6 @@ describe('@debug API Acceptance Tests', function () {
         );
       });
 
-      it('should reject top-level callTracer config with wrong tracer type', async function () {
-        const invalidFormat = {
-          tracer: TracerType.OpcodeLogger,
-          onlyTopCall: true, // callTracer property with opcodeLogger tracer
-        };
-
-        await relay.callFailing(
-          DEBUG_TRACE_TRANSACTION,
-          [createChildTx.hash, invalidFormat],
-          predefined.INVALID_PARAMETER(
-            1,
-            'callTracer config properties for TracerConfigWrapper are only valid when tracer=callTracer',
-          ),
-        );
-      });
-
       it('should reject top-level opcodeLogger config with wrong tracer type', async function () {
         const invalidFormat = {
           tracer: TracerType.CallTracer,