fix: added newFilter to paramRearrangementMap for WS server (#3117)

* fix: added newFilter to paramRearrangementMap for WS server Signed-off-by: Logan Nguyen <[email protected]> * test: added unit test Signed-off-by: Logan Nguyen <[email protected]> --------- Signed-off-by: Logan Nguyen <[email protected]>
hashgraph · Oct 17, 2024 · 0b538db · 0b538db
1 parent daaccaa
commit 0b538db
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 13 deletions.
diff --git a/packages/ws-server/src/controllers/index.ts b/packages/ws-server/src/controllers/index.ts
@@ -26,7 +26,7 @@ import { handleEthSubscribe, handleEthUnsubscribe } from './eth_subscribe';
 import { JsonRpcError, predefined, Relay } from '@hashgraph/json-rpc-relay';
 import { MirrorNodeClient } from '@hashgraph/json-rpc-relay/dist/lib/clients';
 import jsonResp from '@hashgraph/json-rpc-server/dist/koaJsonRpc/lib/RpcResponse';
-import { resolveParams, validateJsonRpcRequest, verifySupportedMethod } from '../utils/utils';
+import { paramRearrangementMap, resolveParams, validateJsonRpcRequest, verifySupportedMethod } from '../utils/utils';
 import {
  InvalidRequest,
  IPRateLimitExceeded,
@@ -76,16 +76,8 @@ const handleSendingRequestsToRelay = async ({
  const resolvedParams = resolveParams(method, params);
  const [service, methodName] = method.split('_');
 
- // Rearrange the parameters for certain methods, since not everywhere requestDetails is last aparameter
- const paramRearrangementMap: { [key: string]: (params: any[], requestDetails: RequestDetails) => any[] } = {
- chainId: (_, requestDetails) => [requestDetails],
- estimateGas: (params, requestDetails) => [...params, null, requestDetails],
- getStorageAt: (params, requestDetails) => [params[0], params[1], requestDetails, params[2]],
- default: (params, requestDetails) => [...params, requestDetails],
- };
-
- const rearrangeParams = paramRearrangementMap[methodName] || paramRearrangementMap['default'];
- const rearrangedParams = rearrangeParams(resolvedParams, requestDetails);
+ const rearrangeParamsFn = paramRearrangementMap[methodName] || paramRearrangementMap['default'];
+ const rearrangedParamsArray = rearrangeParamsFn(resolvedParams, requestDetails);
 
  // Call the relay method with the resolved parameters.
  // Method will be validated by "verifySupportedMethod" before reaching this point.
@@ -94,9 +86,9 @@ const handleSendingRequestsToRelay = async ({
  txRes = await relay
  .eth()
  .filterService()
- [methodName](...rearrangedParams);
+ [methodName](...rearrangedParamsArray);
  } else {
- txRes = await relay[service]()[methodName](...rearrangedParams);
+ txRes = await relay[service]()[methodName](...rearrangedParamsArray);
  }
 
  if (!txRes) {

diff --git a/packages/ws-server/src/utils/utils.ts b/packages/ws-server/src/utils/utils.ts
@@ -202,3 +202,18 @@ export const constructValidLogSubscriptionFilter = (filters: any): object => {
  Object.entries(filters).filter(([key, value]) => value !== undefined && ['address', 'topics'].includes(key)),
  );
 };
+
+/**
+ * A mapping of parameter rearrangement functions for various methods.
+ * Each function adjusts the order of parameters to ensure that the
+ * `requestDetails` object is placed correctly based on the method's requirements.
+ */
+export const paramRearrangementMap: {
+ [key: string]: (params: any[], requestDetails: RequestDetails) => any[];
+} = {
+ chainId: (_: any[], requestDetails: RequestDetails) => [requestDetails],
+ estimateGas: (params, requestDetails) => [params[0], params[1], requestDetails],
+ getStorageAt: (params, requestDetails) => [params[0], params[1], requestDetails, params[2]],
+ newFilter: (params, requestDetails) => [params[0], params[1], requestDetails, params[2], params[3]],
+ default: (params, requestDetails) => [...params, requestDetails],
+};
diff --git a/packages/ws-server/tests/unit/utils.spec.ts b/packages/ws-server/tests/unit/utils.spec.ts
@@ -26,6 +26,7 @@ import {
  getMultipleAddressesEnabled,
  getWsBatchRequestsEnabled,
  handleConnectionClose,
+ paramRearrangementMap,
  resolveParams,
  sendToClient,
 } from '../../src/utils/utils';
@@ -313,4 +314,56 @@ describe('Utilities unit tests', async function () {
  });
  });
  });
+
+ describe('paramRearrangementMap', () => {
+ const requestDetails = new RequestDetails({ ipAddress: '0.0.0.0', requestId: 'test-id' });
+ const specialMethodNames = [`chainId`, `estimateGas`, `getStorageAt`, `newFilter`, `default`];
+
+ const mockResolvedParams = {
+ chainId: [],
+ estimateGas: [
+ {
+ to: '0xD7d454ea421FA3E98c988c2A33b5292C70A43b1E',
+ data: '0x18160ddd',
+ },
+ 'latest',
+ ],
+ getStorageAt: ['0xd7d454ea421fa3e98c988c2a33b5292c70a43b1e', '0x0', 'latest'],
+ newFilter: [
+ '0x0',
+ 'latest',
+ ['0xf72ea4E404618E9DCcA79748236910887be9e2bd'],
+ ['0x25d719d88a4512dd76c7442b910a83360845505894eb444ef299409e180f8fb9'],
+ ],
+ default: ['0x7cb9357e', '0x7cb9357e', '0x00abv'],
+ };
+
+ const expectedRearrangedParams = {
+ chainId: [requestDetails],
+ estimateGas: [...mockResolvedParams.estimateGas, requestDetails],
+ getStorageAt: [
+ mockResolvedParams.getStorageAt[0],
+ mockResolvedParams.getStorageAt[1],
+ requestDetails,
+ mockResolvedParams.getStorageAt[2],
+ ],
+ newFilter: [
+ mockResolvedParams.newFilter[0],
+ mockResolvedParams.newFilter[1],
+ requestDetails,
+ mockResolvedParams.newFilter[2],
+ mockResolvedParams.newFilter[3],
+ ],
+ default: [...mockResolvedParams.default, requestDetails],
+ };
+
+ specialMethodNames.forEach((methodName) => {
+ it(`Should correctly rearrange parameters for ${methodName}`, () => {
+ const rearrangeParamsFn = paramRearrangementMap[methodName];
+ const rearrangedParamsArray = rearrangeParamsFn(mockResolvedParams[methodName], requestDetails);
+ const expectedResult = expectedRearrangedParams[methodName];
+ expect(rearrangedParamsArray).to.deep.eq(expectedResult);
+ });
+ });
+ });
 });