Fix handling of null amount value when fetching transactions from the mirror node (#715)

Fix handling of null amount value

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

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

Author: dimitrovmaksim

packages/relay/src/lib/eth.ts

@@ -76,7 +76,7 @@ export class EthImpl implements Eth {
   static blockLatest = 'latest';
   static blockEarliest = 'earliest';
   static blockPending = 'pending';
-  
+
   /**
    * Configurable options used when initializing the cache.
    *
@@ -541,7 +541,7 @@ export class EthImpl implements Eth {
         blockNumberOrTag = EthImpl.blockLatest;
       }
     }
-    
+
     // Cache is only set for `not found` balances
     const cachedLabel = `getBalance.${account}.${blockNumberOrTag}`;
     const cachedResponse: string | undefined = this.cache.get(cachedLabel);
@@ -961,7 +961,7 @@ export class EthImpl implements Eth {
     const sSig = contractResult.s === null ? null : contractResult.s.substring(0, 66);
 
     if (process.env.DEV_MODE && process.env.DEV_MODE === 'true' && contractResult.result === 'CONTRACT_REVERT_EXECUTED') {
-      let err = predefined.CONTRACT_REVERT(contractResult.error_message);
+      const err = predefined.CONTRACT_REVERT(contractResult.error_message);
       throw err;
     }
 
@@ -984,7 +984,7 @@ export class EthImpl implements Eth {
       transactionIndex: EthImpl.numberTo0x(contractResult.transaction_index),
       type: EthImpl.nullableNumberTo0x(contractResult.type),
       v: EthImpl.nullableNumberTo0x(contractResult.v),
-      value: EthImpl.numberTo0x(contractResult.amount),
+      value: EthImpl.nanOrNumberTo0x(contractResult.amount),
     });
   }
 
@@ -1126,7 +1126,6 @@ export class EthImpl implements Eth {
    * Then using the block timerange get all contract results to get transaction details.
    * If showDetails is set to true subsequently call mirror node for additional transaction details
    *
-   * TODO What do we return if we cannot find the block with that hash?
    * @param blockHashOrNumber
    * @param showDetails
    */
@@ -1137,7 +1136,7 @@ export class EthImpl implements Eth {
 
     const timestampRange = blockResponse.timestamp;
     const timestampRangeParams = [`gte:${timestampRange.from}`, `lte:${timestampRange.to}`];
-    const contractResults = await this.mirrorNodeClient.getContractResults({ timestamp: timestampRangeParams },undefined, requestId);
+    const contractResults = await this.mirrorNodeClient.getContractResults({ timestamp: timestampRangeParams }, undefined, requestId);
     const maxGasLimit = constants.BLOCK_GAS_LIMIT;
     const gasUsed = blockResponse.gas_used;
 
@@ -1268,7 +1267,7 @@ export class EthImpl implements Eth {
             transactionIndex: EthImpl.numberTo0x(contractResultDetails.transaction_index),
             type: EthImpl.nullableNumberTo0x(contractResultDetails.type),
             v: EthImpl.nullableNumberTo0x(contractResultDetails.v),
-            value: EthImpl.numberTo0x(contractResultDetails.amount),
+            value: EthImpl.nanOrNumberTo0x(contractResultDetails.amount),
           });
         }
       })
@@ -1359,7 +1358,7 @@ export class EthImpl implements Eth {
       return [];
     }
 
-    let unproccesedLogs = await this.mirrorNodeClient.pageAllResults(result, requestId);
+    const unproccesedLogs = await this.mirrorNodeClient.pageAllResults(result, requestId);
 
     const logs: Log[] = [];
     for(const log of unproccesedLogs) {

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

@@ -965,6 +965,19 @@ describe('Eth calls using MirrorNode', async function () {
     expect(result.to).equal(contractAddress1);
   });
 
+  it('eth_getTransactionByBlockNumberAndIndex with null amount', async function () {
+    // mirror node request mocks
+    mock.onGet(`contracts/results?block.number=${defaultBlock.number}&transaction.index=${defaultBlock.count}&limit=100&order=asc`).reply(200, defaultContractResults);
+    mock.onGet(`contracts/${contractAddress1}/results/${contractTimestamp1}`).reply(200, {...defaultDetailedContractResults, amount: null});
+
+    const result = await ethImpl.getTransactionByBlockNumberAndIndex(EthImpl.numberTo0x(defaultBlock.number), EthImpl.numberTo0x(defaultBlock.count));
+    expect(result).to.exist;
+    if (result == null) return;
+
+    // verify aggregated info
+    expect(result.value).equal("0x0");
+  });
+
   it('eth_getTransactionByBlockNumberAndIndex with no contract result match', async function () {
     mock.onGet(`contracts/results?block.number=${defaultBlock.number}&transaction.index=${defaultBlock.count}&limit=100&order=asc`).reply(400, {
       '_status': {
@@ -1171,7 +1184,7 @@ describe('Eth calls using MirrorNode', async function () {
           balance: defBalance
         }
       });
-      
+
       const resBalance = await ethImpl.getBalance(contractAddress1, blockNumber);
       expect(resBalance).to.equal(defHexBalance);
     });
@@ -1558,7 +1571,7 @@ describe('Eth calls using MirrorNode', async function () {
       };
 
       mock.onGet("blocks?limit=1&order=desc").reply(200, { blocks: [defaultBlock] });
-      
+
       mock.onGet(`contracts/results/logs?timestamp=gte:${defaultBlock.timestamp.from}&timestamp=lte:${defaultBlock.timestamp.to}&limit=2&order=asc`).replyOnce(200, filteredLogs)
       .onGet('contracts/results/logs?limit=2&order=desc&timestamp=lte:1668432962.375200975&index=lt:0').replyOnce(200, filteredLogsNext);
 
@@ -2691,6 +2704,24 @@ describe('Eth', async function () {
       expect(result.gas).to.eq('0x0');
     });
 
+    it('handles transactions with null amount', async function () {
+      // mirror node request mocks
+      const detailedResultsWithNullNullableValues = {
+        ...defaultDetailedContractResultByHash,
+        amount: null
+      };
+
+      mock.onGet(`contracts/results/${defaultTxHash}`).reply(200, detailedResultsWithNullNullableValues);
+      mock.onGet(`accounts/${defaultFromLongZeroAddress}`).reply(200, {
+        evm_address: `${defaultTransaction.from}`
+      });
+      const result = await ethImpl.getTransactionByHash(defaultTxHash);
+      if (result == null) return;
+
+      expect(result).to.exist;
+      expect(result.value).to.eq('0x0');
+    });
+
     it('returns reverted transactions', async function () {
       mock.onGet(`contracts/results/${defaultTxHash}`).reply(200, defaultDetailedContractResultByHashReverted);
       mock.onGet(`accounts/${defaultFromLongZeroAddress}`).reply(200, {
@@ -2721,7 +2752,7 @@ describe('Eth', async function () {
       expect(result.type).to.eq(EthImpl.numberTo0x(defaultTransaction.type));
       expect(result.v).to.eq(EthImpl.numberTo0x(defaultTransaction.v));
       expect(result.value).to.eq(defaultTransaction.value);
-    })
+    });
 
     it('throws error for reverted transactions when DEV_MODE=true', async function () {
       const initialDevModeValue = process.env.DEV_MODE;
@@ -2741,6 +2772,6 @@ describe('Eth', async function () {
       }
 
       process.env.DEV_MODE = initialDevModeValue;
-    })
+    });
   });
 });