feat: support non-zero shard/realm (#3718)

Signed-off-by: Luis Mastrangelo <[email protected]>

Author: acuarica

packages/relay/src/lib/clients/mirrorNodeClient.ts

@@ -1398,18 +1398,23 @@ export class MirrorNodeClient {
           : Promise.reject(),
       ];
 
-      // only add long zero evm addresses for tokens as they do not refer to actual contract addresses but rather encoded entity nums
-      if (entityIdentifier.startsWith(constants.LONG_ZERO_PREFIX)) {
-        promises.push(
-          searchableTypes.find((t) => t === constants.TYPE_TOKEN)
-            ? buildPromise(
-                this.getTokenById(`0.0.${parseInt(entityIdentifier, 16)}`, requestDetails, retries).catch(() => {
-                  return null;
-                }),
-              )
-            : Promise.reject(),
-        );
-      }
+      const toEntityId = (address: string) => {
+        address = address.slice(2);
+        const shardNum = address.slice(0, 8);
+        const realmNum = address.slice(8, 24);
+        const accountNum = address.slice(24);
+        return `${parseInt(shardNum, 16)}.${parseInt(realmNum, 16)}.${parseInt(accountNum, 16)}`;
+      };
+
+      promises.push(
+        searchableTypes.find((t) => t === constants.TYPE_TOKEN)
+          ? buildPromise(
+              this.getTokenById(toEntityId(entityIdentifier), requestDetails, retries).catch(() => {
+                return null;
+              }),
+            )
+          : Promise.reject(),
+      );
 
       // maps the promises with indices of the promises array
       // because there is no such method as Promise.anyWithIndex in js

packages/relay/src/lib/constants.ts

@@ -110,7 +110,6 @@ export default {
   ETH_FEE_HISTORY_TTL: `${CACHE_TTL.HALF_HOUR}`,
   TRANSACTION_ID_REGEX: /\d{1}\.\d{1}\.\d{1,10}\@\d{1,10}\.\d{1,9}/,
 
-  LONG_ZERO_PREFIX: '0x000000000000',
   CHAIN_IDS: {
     mainnet: 0x127,
     testnet: 0x128,

packages/relay/src/lib/eth.ts

@@ -94,9 +94,6 @@ export class EthImpl implements Eth {
     reward: [],
     oldestBlock: EthImpl.zeroHex,
   };
-  static redirectBytecodePrefix = '6080604052348015600f57600080fd5b506000610167905077618dc65e';
-  static redirectBytecodePostfix =
-    '600052366000602037600080366018016008845af43d806000803e8160008114605857816000f35b816000fdfea2646970667358221220d8378feed472ba49a0005514ef7087017f707b45fb9bf56bb81bb93ff19a238b64736f6c634300080b0033';
   static iHTSAddress = '0x0000000000000000000000000000000000000167';
   static invalidEVMInstruction = '0xfe';
   static blockHashLength = 66;
@@ -2505,7 +2502,7 @@ export class EthImpl implements Eth {
     }
   }
 
-  async resolveEvmAddress(
+  private async resolveEvmAddress(
     address: string,
     requestDetails: RequestDetails,
     searchableTypes = [constants.TYPE_CONTRACT, constants.TYPE_TOKEN, constants.TYPE_ACCOUNT],
@@ -2763,8 +2760,11 @@ export class EthImpl implements Eth {
     return numberTo0x(gasPriceForTimestamp);
   }
 
-  private static redirectBytecodeAddressReplace(address: string): string {
-    return `${this.redirectBytecodePrefix}${address.slice(2)}${this.redirectBytecodePostfix}`;
+  static redirectBytecodeAddressReplace(address: string): string {
+    const redirectBytecodePrefix = '6080604052348015600f57600080fd5b506000610167905077618dc65e';
+    const redirectBytecodePostfix =
+      '600052366000602037600080366018016008845af43d806000803e8160008114605857816000f35b816000fdfea2646970667358221220d8378feed472ba49a0005514ef7087017f707b45fb9bf56bb81bb93ff19a238b64736f6c634300080b0033';
+    return `0x${redirectBytecodePrefix}${address.slice(2)}${redirectBytecodePostfix}`;
   }
 
   private static prune0x(input: string): string {

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

@@ -21,6 +21,16 @@ import { generateEthTestEnv } from './eth-helpers';
 
 use(chaiAsPromised);
 
+function entityIdToEvmAddress(entityId: string): string {
+  const pad = (num: string, n: number) =>
+    Number(num)
+      .toString(16)
+      .padStart(n * 2, '0');
+  const [shardNum, realmNum, accountNum] = entityId.split('.');
+
+  return `0x${pad(shardNum, 4)}${pad(realmNum, 8)}${pad(accountNum, 8)}`;
+}
+
 describe('@ethGetCode using MirrorNode', async function () {
   this.timeout(10000);
   const { restMock, ethImpl, cacheService } = generateEthTestEnv();
@@ -95,11 +105,8 @@ describe('@ethGetCode using MirrorNode', async function () {
       restMock.onGet(`contracts/${HTS_TOKEN_ADDRESS}`).reply(404, JSON.stringify(null));
       restMock.onGet(`accounts/${HTS_TOKEN_ADDRESS}?limit=100`).reply(404, JSON.stringify(null));
       restMock.onGet(`tokens/0.0.${parseInt(HTS_TOKEN_ADDRESS, 16)}`).reply(200, JSON.stringify(DEFAULT_HTS_TOKEN));
-      const redirectBytecode = `6080604052348015600f57600080fd5b506000610167905077618dc65e${HTS_TOKEN_ADDRESS.slice(
-        2,
-      )}600052366000602037600080366018016008845af43d806000803e8160008114605857816000f35b816000fdfea2646970667358221220d8378feed472ba49a0005514ef7087017f707b45fb9bf56bb81bb93ff19a238b64736f6c634300080b0033`;
       const res = await ethImpl.getCode(HTS_TOKEN_ADDRESS, null, requestDetails);
-      expect(res).to.equal(redirectBytecode);
+      expect(res).to.be.equal(EthImpl.redirectBytecodeAddressReplace(HTS_TOKEN_ADDRESS));
     });
 
     it('should return the static bytecode for address(0x167) call', async () => {
@@ -214,10 +221,7 @@ describe('@ethGetCode using MirrorNode', async function () {
       );
 
       const res = await ethImpl.getCode(HTS_TOKEN_ADDRESS, blockNumberAfterCreation, requestDetails);
-      const expectedRedirectBytecode = `6080604052348015600f57600080fd5b506000610167905077618dc65e${HTS_TOKEN_ADDRESS.slice(
-        2,
-      )}600052366000602037600080366018016008845af43d806000803e8160008114605857816000f35b816000fdfea2646970667358221220d8378feed472ba49a0005514ef7087017f707b45fb9bf56bb81bb93ff19a238b64736f6c634300080b0033`;
-      expect(res).to.equal(expectedRedirectBytecode);
+      expect(res).to.be.equal(EthImpl.redirectBytecodeAddressReplace(HTS_TOKEN_ADDRESS));
     });
 
     it('should throw error for invalid block number', async () => {
@@ -262,5 +266,16 @@ describe('@ethGetCode using MirrorNode', async function () {
       const res = await ethImpl.getCode(CONTRACT_ADDRESS_1, 'earliest', requestDetails);
       expect(res).to.equal(EthImpl.emptyHex);
     });
+
+    it('should return redirect bytecode for HTS when accountId has non-zero shard/realm', async function () {
+      const accountId = '1.2.3';
+      const addr = entityIdToEvmAddress(accountId);
+
+      restMock.onGet(`contracts/${addr}`).reply(404, JSON.stringify(null));
+      restMock.onGet(`accounts/${addr}?limit=100`).reply(404, JSON.stringify(null));
+      restMock.onGet(`tokens/${accountId}`).reply(200, JSON.stringify(DEFAULT_HTS_TOKEN));
+      const res = await ethImpl.getCode(addr, null, requestDetails);
+      expect(res).to.be.equal(EthImpl.redirectBytecodeAddressReplace(addr));
+    });
   });
 });

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

@@ -1,21 +1,20 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // External resources
-import { solidity } from 'ethereum-waffle';
+import { EthImpl } from '@hashgraph/json-rpc-relay/dist/lib/eth';
 import chai, { expect } from 'chai';
-
-// Local resources
-import { AliasAccount } from '../types/AliasAccount';
-import { Utils } from '../helpers/utils';
+import { solidity } from 'ethereum-waffle';
 import { ethers } from 'ethers';
-import ERC20MockJson from '../contracts/ERC20Mock.json';
-import Assertions from '../helpers/assertions';
-import { EthImpl } from '@hashgraph/json-rpc-relay/dist/lib/eth';
 
 // Constants from local resources
 import Constants from '../../../server/tests/helpers/constants';
-import ServicesClient from '../clients/servicesClient';
 import RelayClient from '../clients/relayClient';
+import ServicesClient from '../clients/servicesClient';
+import ERC20MockJson from '../contracts/ERC20Mock.json';
+import Assertions from '../helpers/assertions';
+import { Utils } from '../helpers/utils';
+// Local resources
+import { AliasAccount } from '../types/AliasAccount';
 
 chai.use(solidity);
 
@@ -43,10 +42,10 @@ describe('@erc20 Acceptance Tests', async function () {
   const symbol = Utils.randomString(5);
   const initialSupply = BigInt(10000);
 
-  const ERC20 = 'ERC20 Contract';
-  const HTS = 'HTS token';
-
-  const testTitles = [{ testName: ERC20, expectedBytecode: ERC20MockJson.deployedBytecode }, { testName: HTS }];
+  const testTitles = [
+    { testName: 'ERC20 Contract', expectedBytecode: ERC20MockJson.deployedBytecode },
+    { testName: 'HTS token' },
+  ];
 
   this.beforeAll(async () => {
     requestId = Utils.generateRequestId();
@@ -111,14 +110,9 @@ describe('@erc20 Acceptance Tests', async function () {
 
       it('Relay can execute "eth_getCode" for ERC20 contract with evmAddress', async function () {
         const res = await relay.call('eth_getCode', [contract.target, 'latest'], requestId);
-        const expectedBytecode = `${EthImpl.redirectBytecodePrefix}${contract.target.slice(2)}${
-          EthImpl.redirectBytecodePostfix
-        }`;
-        if (testTitles[i].testName !== HTS) {
-          expect(res).to.eq(testTitles[i].expectedBytecode);
-        } else {
-          expect(res).to.eq(expectedBytecode);
-        }
+        expect(res).to.be.equal(
+          testTitles[i].expectedBytecode ?? EthImpl.redirectBytecodeAddressReplace(contract.target),
+        );
       });
 
       describe('should behave like erc20', function () {

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

@@ -730,7 +730,6 @@ describe('@api-batch-2 RPC Server Acceptance Tests', function () {
     let mainContract: ethers.Contract;
     let mainContractAddress: string;
     let NftHTSTokenContractAddress: string;
-    let redirectBytecode: string;
     let blockBeforeContractCreation: number;
     let basicContract: ethers.Contract;
     let basicContractAddress: string;
@@ -770,14 +769,12 @@ describe('@api-batch-2 RPC Server Acceptance Tests', function () {
     });
 
     it('should execute "eth_getCode" for hts token', async function () {
-      const tokenAddress = NftHTSTokenContractAddress.slice(2);
-      redirectBytecode = `6080604052348015600f57600080fd5b506000610167905077618dc65e${tokenAddress}600052366000602037600080366018016008845af43d806000803e8160008114605857816000f35b816000fdfea2646970667358221220d8378feed472ba49a0005514ef7087017f707b45fb9bf56bb81bb93ff19a238b64736f6c634300080b0033`;
       const res = await relay.call(
         RelayCalls.ETH_ENDPOINTS.ETH_GET_CODE,
         [NftHTSTokenContractAddress, 'latest'],
         requestId,
       );
-      expect(res).to.equal(redirectBytecode);
+      expect(res).to.be.equal(EthImpl.redirectBytecodeAddressReplace(NftHTSTokenContractAddress));
     });
 
     it('@release should return empty bytecode for HTS token when a block earlier than the token creation is passed', async function () {

packages/server/tests/helpers/utils.ts

@@ -1,23 +1,24 @@
 // SPDX-License-Identifier: Apache-2.0
 
-import { ethers } from 'ethers';
-import Assertions from './assertions';
-import crypto from 'crypto';
-import RelayClient from '../clients/relayClient';
+import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
 import { numberTo0x } from '@hashgraph/json-rpc-relay/dist/formatters';
-import RelayCall from '../../tests/helpers/constants';
+import { RequestDetails } from '@hashgraph/json-rpc-relay/dist/lib/types';
 import { AccountId, KeyList, PrivateKey } from '@hashgraph/sdk';
-import { AliasAccount } from '../types/AliasAccount';
-import ServicesClient from '../clients/servicesClient';
+import crypto from 'crypto';
+import { ethers } from 'ethers';
 import http from 'http';
+import { Context } from 'mocha';
 import { GCProfiler, setFlagsFromString, writeHeapSnapshot } from 'v8';
 import { runInNewContext } from 'vm';
-import { Context } from 'mocha';
+
+import RelayCall from '../../tests/helpers/constants';
 import { GitHubClient } from '../clients/githubClient';
 import MirrorClient from '../clients/mirrorClient';
+import RelayClient from '../clients/relayClient';
+import ServicesClient from '../clients/servicesClient';
+import { AliasAccount } from '../types/AliasAccount';
 import { HeapDifferenceStatistics } from '../types/HeapDifferenceStatistics';
-import { ConfigService } from '@hashgraph/json-rpc-config-service/dist/services';
-import { RequestDetails } from '@hashgraph/json-rpc-relay/dist/lib/types';
+import Assertions from './assertions';
 
 export class Utils {
   static readonly HEAP_SIZE_DIFF_MEMORY_LEAK_THRESHOLD: number = 4e6; // 4 MB
@@ -100,7 +101,7 @@ export class Utils {
     relay: RelayClient,
   ) => {
     const factory = new ethers.ContractFactory(contractJson.abi, contractJson.bytecode, wallet);
-    let contract = await factory.deploy(...constructorArgs);
+    const contract = await factory.deploy(...constructorArgs);
     await contract.waitForDeployment();
 
     // re-init the contract with the deployed address