feat: change units of the value in eth gettransactionbyhash result (#… (#3081)

feat: change units of the value in eth gettransactionbyhash result (#3080)

* fix: change unit of transaction value result



* chore: reusable tinybarsToWeibars method and tests



---------

Signed-off-by: Nadezhda Popova <[email protected]>
Signed-off-by: ebadiere <[email protected]>
Co-authored-by: Nadezhda Popova <[email protected]>
Co-authored-by: Nadezhda Popova <[email protected]>

Author: 3 people

packages/relay/src/formatters.ts

@@ -178,7 +178,7 @@ const formatContractResult = (cr: any) => {
     transactionIndex: nullableNumberTo0x(cr.transaction_index),
     type: cr.type === null ? '0x0' : nanOrNumberTo0x(cr.type),
     v: cr.v === null ? '0x0' : nanOrNumberTo0x(cr.v),
-    value: nanOrNumberTo0x(cr.amount),
+    value: nanOrNumberTo0x(tinybarsToWeibars(cr.amount)),
     // for legacy EIP155 with tx.chainId=0x0, mirror-node will return a '0x' (EMPTY_HEX) value for contract result's chain_id
     //   which is incompatibile with certain tools (i.e. foundry). By setting this field, chainId, to undefined, the end jsonrpc
     //   object will leave out this field, which is the proper behavior for other tools to be compatible with.
@@ -303,6 +303,14 @@ const getFunctionSelector = (data?: string): string => {
   return data.replace(/^0x/, '').substring(0, 8);
 };
 
+const tinybarsToWeibars = (value: number | null) => {
+  if (value && value < 0) throw new Error('Invalid value - cannot pass negative number');
+  if (value && value > constants.TOTAL_SUPPLY_TINYBARS)
+    throw new Error('Value cannot be more than the total supply of tinybars in the blockchain');
+
+  return value == null ? null : value * constants.TINYBAR_TO_WEIBAR_COEF;
+};
+
 export {
   hashNumber,
   formatRequestIdMessage,
@@ -330,4 +338,5 @@ export {
   ASCIIToHex,
   getFunctionSelector,
   mapKeysAndValues,
+  tinybarsToWeibars,
 };

packages/relay/src/lib/constants.ts

@@ -69,6 +69,7 @@ export enum CallType {
 export default {
   HBAR_TO_TINYBAR_COEF: 100_000_000,
   TINYBAR_TO_WEIBAR_COEF: 10_000_000_000,
+  TOTAL_SUPPLY_TINYBARS: 5_000_000_000_000_000_000,
   // 131072 bytes are 128kbytes
   SEND_RAW_TRANSACTION_SIZE_LIMIT: process.env.SEND_RAW_TRANSACTION_SIZE_LIMIT
     ? parseInt(process.env.SEND_RAW_TRANSACTION_SIZE_LIMIT)

packages/relay/tests/lib/eth/eth-config.ts

@@ -18,6 +18,7 @@
  *
  */
 import {
+  defaultDetailedContractResultByHash,
   defaultEvmAddress,
   defaultLogs1,
   defaultLogs2,
@@ -26,7 +27,7 @@ import {
   mockData,
   toHex,
 } from '../../helpers';
-import { numberTo0x } from '../../../dist/formatters';
+import { numberTo0x, nanOrNumberTo0x } from '../../../dist/formatters';
 import constants from '../../../src/lib/constants';
 
 export const BLOCK_TRANSACTION_COUNT = 77;
@@ -601,6 +602,9 @@ export const BLOCK_BY_HASH_FROM_RELAY = {
 };
 export const CONTRACT_EVM_ADDRESS = '0xd8db0b1dbf8ba6721ef5256ad5fe07d72d1d04b9';
 export const DEFAULT_TX_HASH = '0x4a563af33c4871b51a8b108aa2fe1dd5280a30dfb7236170ae5e5e7957eb6392';
+const DEFAULT_TRANSACTION_VALUE = nanOrNumberTo0x(
+  defaultDetailedContractResultByHash.amount * constants.TINYBAR_TO_WEIBAR_COEF,
+);
 export const DEFAULT_TRANSACTION = {
   accessList: [],
   blockHash: '0xd693b532a80fed6392b428604171fb32fdbf953728a3a7ecc7d4062b1652c042',
@@ -620,7 +624,7 @@ export const DEFAULT_TRANSACTION = {
   transactionIndex: '0x1',
   type: 2,
   v: 1,
-  value: '0x77359400',
+  value: DEFAULT_TRANSACTION_VALUE,
 };
 export const DEFAULT_DETAILED_CONTRACT_RESULT_BY_HASH = {
   address: '0xd8db0b1dbf8ba6721ef5256ad5fe07d72d1d04b9',

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

@@ -43,6 +43,7 @@ import {
   getFunctionSelector,
   toHexString,
   weibarHexToTinyBarInt,
+  tinybarsToWeibars,
 } from '../../src/formatters';
 import constants from '../../src/lib/constants';
 import { BigNumber as BN } from 'bignumber.js';
@@ -737,4 +738,29 @@ describe('Formatters', () => {
       expect(result).to.deep.equal({ A: '1', B: '2', C: '3' });
     });
   });
+
+  describe('tinybarsToWeibars', () => {
+    it('should convert tinybars to weibars', () => {
+      expect(tinybarsToWeibars(10)).to.eql(100000000000);
+    });
+
+    it('should return null if null is passed', () => {
+      expect(tinybarsToWeibars(null)).to.eql(null);
+    });
+
+    it('should return 0 for 0 input', () => {
+      expect(tinybarsToWeibars(0)).to.eql(0);
+    });
+
+    it('should throw an error when value is smaller than 0', () => {
+      expect(() => tinybarsToWeibars(-10)).to.throw(Error, 'Invalid value - cannot pass negative number');
+    });
+
+    it('should throw an error when value is larger than the total supply of tinybars', () => {
+      expect(() => tinybarsToWeibars(constants.TOTAL_SUPPLY_TINYBARS * 10)).to.throw(
+        Error,
+        'Value cannot be more than the total supply of tinybars in the blockchain',
+      );
+    });
+  });
 });

packages/server/tests/helpers/assertions.ts

@@ -190,9 +190,10 @@ export default class Assertions {
       relayResponse.transactionIndex,
       "Assert transaction: 'transactionIndex' should equal mirrorNode response",
     ).to.eq(ethers.toQuantity(mirrorNodeResponse.transaction_index));
-    expect(relayResponse.value, "Assert transaction: 'value' should equal mirrorNode response").to.eq(
-      ethers.toQuantity(mirrorNodeResponse.amount),
-    );
+    expect(
+      relayResponse.value,
+      "Assert transaction: 'value' should equal mirrorNode response converted in weibar",
+    ).to.eq(ethers.toQuantity(BigInt(mirrorNodeResponse.amount * constants.TINYBAR_TO_WEIBAR_COEF)));
   }
 
   static transactionReceipt = (transactionReceipt, mirrorResult, effectiveGas) => {