Fix constants. Set effectiveGasPrice to 0 if null (#581)

* Fix constants. Set effectiveGasPrice to 0 if null
Combined two small fixes into a single PR:

Fixes ETH_GET_LOGS_BLOCK_RANGE_LIMIT and FEE_HISTORY_MAX_RESULTS env variables being undefined at module initialization
Fixes effectiveGasPrice having 0xNaN as value for non-eth transactions in eth_getTransactionReceipt responce

Signed-off-by: Maksim Dimitrov <[email protected]>

Author: dimitrovmaksim

packages/relay/src/lib/constants.ts

@@ -38,14 +38,14 @@ export default {
 
     DEFAULT_TINY_BAR_GAS: 72, // (853454 / 1000) * (1 / 12)
     ETH_FUNCTIONALITY_CODE: 84,
-    ETH_GET_LOGS_BLOCK_RANGE_LIMIT: Number(process.env.ETH_GET_LOGS_BLOCK_RANGE_LIMIT || 500),
+    DEFAULT_ETH_GET_LOGS_BLOCK_RANGE_LIMIT: 500,
     EXCHANGE_RATE_FILE_ID: "0.0.112",
     FEE_SCHEDULE_FILE_ID: '0.0.111',
 
     TYPE_CONTRACT: 'contract',
     TYPE_ACCOUNT: 'account',
 
-    FEE_HISTORY_MAX_RESULTS: Number(process.env.FEE_HISTORY_MAX_RESULTS || 10),
+    DEFAULT_FEE_HISTORY_MAX_RESULTS: 10,
     ORDER,
 
     BLOCK_GAS_LIMIT: 15_000_000,

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

@@ -18,8 +18,6 @@
  *
  */
 
-import constants from "../constants";
-
 const REQUEST_ID_STRING = `Request ID: `;
 export class JsonRpcError {
   public code: number;
@@ -119,10 +117,10 @@ export const predefined = {
     code: -32001,
     message: `Requested resource not found. ${message}`
   }),
-  'RANGE_TOO_LARGE': new JsonRpcError({
+  'RANGE_TOO_LARGE': (blockRange: number) => new JsonRpcError({
     name: 'Block range too large',
     code: -32000,
-    message: `Exceeded maximum block range: ${constants.ETH_GET_LOGS_BLOCK_RANGE_LIMIT}`
+    message: `Exceeded maximum block range: ${blockRange}`
   }),
   'IP_RATE_LIMIT_EXCEEDED': new JsonRpcError({
     name: 'IP Rate limit exceeded',

packages/relay/src/lib/eth.ts

@@ -140,8 +140,12 @@ export class EthImpl implements Eth {
    * Gets the fee history.
    */
   async feeHistory(blockCount: number, newestBlock: string, rewardPercentiles: Array<number> | null, requestId?: string) {
+    const maxResults = Number(process.env.FEE_HISTORY_MAX_RESULTS) || constants.DEFAULT_FEE_HISTORY_MAX_RESULTS;
+
     const requestIdPrefix = formatRequestIdMessage(requestId);
+
     this.logger.trace(`${requestIdPrefix} feeHistory(blockCount=${blockCount}, newestBlock=${newestBlock}, rewardPercentiles=${rewardPercentiles})`);
+
     try {
       const latestBlockNumber = await this.translateBlockTag(EthImpl.blockLatest, requestId);
       const newestBlockNumber = await this.translateBlockTag(newestBlock, requestId);
@@ -150,7 +154,7 @@ export class EthImpl implements Eth {
         return predefined.REQUEST_BEYOND_HEAD_BLOCK(newestBlockNumber, latestBlockNumber);
       }
 
-      blockCount = blockCount > constants.FEE_HISTORY_MAX_RESULTS ? constants.FEE_HISTORY_MAX_RESULTS : blockCount;
+      blockCount = blockCount > maxResults ? maxResults : blockCount;
 
       if (blockCount <= 0) {
         return EthImpl.feeHistoryZeroBlockCountResponse;
@@ -752,7 +756,7 @@ export class EthImpl implements Eth {
         return e;
       }
       return predefined.INTERNAL_ERROR;
-    } 
+    }
   }
 
   /**
@@ -901,7 +905,7 @@ export class EthImpl implements Eth {
       input: contractResult.function_parameters,
       maxPriorityFeePerGas: maxPriorityFee,
       maxFeePerGas: maxFee,
-      nonce: EthImpl.nonceNumberTo0x(contractResult.nonce),
+      nonce: EthImpl.nanOrNumberTo0x(contractResult.nonce),
       r: rSig,
       s: sSig,
       to: contractResult.to?.substring(0, 42),
@@ -963,7 +967,7 @@ export class EthImpl implements Eth {
         logsBloom: receiptResponse.bloom,
         transactionHash: EthImpl.toHash32(receiptResponse.hash),
         transactionIndex: EthImpl.numberTo0x(receiptResponse.transaction_index),
-        effectiveGasPrice: EthImpl.numberTo0x(Number.parseInt(effectiveGas) * 10_000_000_000),
+        effectiveGasPrice: EthImpl.nanOrNumberTo0x(Number.parseInt(effectiveGas) * 10_000_000_000),
         root: receiptResponse.root,
         status: receiptResponse.status,
       };
@@ -991,8 +995,11 @@ export class EthImpl implements Eth {
     return input === null ? null : EthImpl.numberTo0x(input);
   }
 
-  static nonceNumberTo0x(input: number | BigNumber): string {
-    return input === null ? EthImpl.numberTo0x(0) : EthImpl.numberTo0x(input);
+  static nanOrNumberTo0x(input: number | BigNumber): string {
+    // input == null assures to check against both null and undefined.
+    // A reliable way for ECMAScript code to test if a value X is a NaN is an expression of the form X !== X.
+    // The result will be true if and only if X is a NaN.
+    return input == null || input !== input ? EthImpl.numberTo0x(0) : EthImpl.numberTo0x(input);
   }
 
   static toHash32(value: string): string {
@@ -1180,7 +1187,7 @@ export class EthImpl implements Eth {
           input: contractResultDetails.function_parameters,
           maxPriorityFeePerGas: EthImpl.toNullIfEmptyHex(contractResultDetails.max_priority_fee_per_gas),
           maxFeePerGas: EthImpl.toNullIfEmptyHex(contractResultDetails.max_fee_per_gas),
-          nonce: EthImpl.nonceNumberTo0x(contractResultDetails.nonce),
+          nonce: EthImpl.nanOrNumberTo0x(contractResultDetails.nonce),
           r: rSig,
           s: sSig,
           to: contractResultDetails.to.substring(0, 42),
@@ -1219,6 +1226,7 @@ export class EthImpl implements Eth {
         throw e;
       }
     } else if (fromBlock || toBlock) {
+      const blockRangeLimit = Number(process.env.ETH_GET_LOGS_BLOCK_RANGE_LIMIT) || constants.DEFAULT_ETH_GET_LOGS_BLOCK_RANGE_LIMIT;
       let fromBlockTimestamp;
       let toBlockTimestamp;
       let fromBlockNum = 0;
@@ -1272,8 +1280,8 @@ export class EthImpl implements Eth {
 
       if (fromBlockNum > toBlockNum) {
         return [];
-      } else if((toBlockNum - fromBlockNum) > constants.ETH_GET_LOGS_BLOCK_RANGE_LIMIT) {
-        throw predefined.RANGE_TOO_LARGE;
+      } else if((toBlockNum - fromBlockNum) > blockRangeLimit) {
+        throw predefined.RANGE_TOO_LARGE(blockRangeLimit);
       }
     }
 

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

@@ -32,6 +32,7 @@ import { predefined } from '../../src/lib/errors/JsonRpcError';
 import { EthImpl } from '../../src/lib/eth';
 import { MirrorNodeClient } from '../../src/lib/clients/mirrorNodeClient';
 import {
+  defaultContractResults,
   defaultEvmAddress,
   defaultFromLongZeroAddress,
   expectUnsupportedMethod,
@@ -42,6 +43,7 @@ import { Block, Transaction } from '../../src/lib/model';
 import constants from '../../src/lib/constants';
 import { SDKClient } from '../../src/lib/clients';
 import { SDKClientError } from '../../src/lib/errors/SDKClientError';
+import { isTypedArray } from 'util/types';
 
 const logger = pino();
 const registry = new Registry();
@@ -995,7 +997,7 @@ describe('Eth calls using MirrorNode', async function () {
           messages: [{ message: 'Not found' }]
         }
       });
-      
+
       const resCached = await ethImpl.getBalance(contractAddress1, null);
       expect(resNoCache).to.equal(defHexBalance);
       expect(resCached).to.equal(EthImpl.zeroHex);
@@ -1459,7 +1461,7 @@ describe('Eth calls using MirrorNode', async function () {
   });
 
   it('eth_feeHistory with max results', async function () {
-    const maxResultsCap = Number(constants.FEE_HISTORY_MAX_RESULTS);
+    const maxResultsCap = Number(constants.DEFAULT_FEE_HISTORY_MAX_RESULTS);
 
     mock.onGet('blocks?limit=1&order=desc').reply(200, {blocks: [{...defaultBlock, number: 10}]});
     mock.onGet(`network/fees?timestamp=lte:${defaultBlock.timestamp.to}`).reply(200, defaultNetworkFees);
@@ -2070,6 +2072,22 @@ describe('Eth', async function () {
       expect(receipt.status).to.eq(defaultReceipt.status);
       expect(receipt.effectiveGasPrice).to.eq(defaultReceipt.effectiveGasPrice);
     });
+
+    it("Handles null effectiveGasPrice", async function() {
+      const contractResult = {
+        ...defaultDetailedContractResultByHash,
+        gas_price: null,
+        max_fee_per_gas: null
+      };
+
+      mock.onGet(`contracts/results/${defaultTxHash}`).reply(200, contractResult);
+      const receipt = await ethImpl.getTransactionReceipt(defaultTxHash);
+
+      expect(receipt).to.exist;
+      if (receipt == null) return;
+
+      expect(receipt.effectiveGasPrice).to.eq('0x0');
+    });
   });
 
   describe('eth_getTransactionByHash', async function () {