Dictionary V2 Ethereum

.prettierignore

@@ -9,3 +9,5 @@
 *.tgz
 *.cmd
 *.sh
+generate-project*.yaml
+*.proto

jest.config.js

@@ -81,7 +81,7 @@ module.exports = {
   // moduleNameMapper: {},
   moduleNameMapper: {
     '@subql/common-ethereum': '<rootDir>/packages/common-ethereum/src',
-    '@subql/types-ethereum': '<rootDir>/packages/types/src',
+    '@subql/types-ethereum': '<rootDir>/packages/types/src'
   },
 
   // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader

packages/node/package.json

@@ -27,7 +27,7 @@
     "@nestjs/schedule": "^3.0.1",
     "@subql/common": "^3.4.1",
     "@subql/common-ethereum": "workspace:*",
-    "@subql/node-core": "^7.4.1",
+    "@subql/node-core": "7.4.2-0",
     "@subql/testing": "^2.1.0",
     "@subql/types-ethereum": "workspace:*",
     "cacheable-lookup": "6",
@@ -65,6 +65,5 @@
   "files": [
     "/dist",
     "/bin"
-  ],
-  "stableVersion": "3.9.1"
+  ]
 }

packages/node/src/ethereum/api.connection.ts

@@ -11,14 +11,18 @@ import {
   RateLimitError,
   TimeoutError,
   IApiConnectionSpecific,
+  IBlock,
 } from '@subql/node-core';
 import { EthereumBlock, LightEthereumBlock } from '@subql/types-ethereum';
 import { EthereumApi } from './api.ethereum';
 import SafeEthProvider from './safe-api';
 
 export type FetchFunc =
-  | ((api: EthereumApi, batch: number[]) => Promise<EthereumBlock[]>)
-  | ((api: EthereumApi, batch: number[]) => Promise<LightEthereumBlock[]>);
+  | ((api: EthereumApi, batch: number[]) => Promise<IBlock<EthereumBlock>[]>)
+  | ((
+      api: EthereumApi,
+      batch: number[],
+    ) => Promise<IBlock<LightEthereumBlock>[]>);
 
 // We use a function to get the fetch function because it can change depending on the skipBlocks feature
 export type GetFetchFunc = () => FetchFunc;
@@ -28,7 +32,7 @@ export class EthereumApiConnection
     IApiConnectionSpecific<
       EthereumApi,
       SafeEthProvider,
-      EthereumBlock[] | LightEthereumBlock[]
+      IBlock<EthereumBlock>[] | IBlock<LightEthereumBlock>[]
     >
 {
   readonly networkMeta: NetworkMetadataPayload;
@@ -77,7 +81,7 @@ export class EthereumApiConnection
 
   async fetchBlocks(
     heights: number[],
-  ): Promise<EthereumBlock[] | LightEthereumBlock[]> {
+  ): Promise<IBlock<EthereumBlock>[] | IBlock<LightEthereumBlock>[]> {
     const blocks = await this.fetchBlocksBatches()(this.unsafeApi, heights);
     return blocks;
   }

packages/node/src/ethereum/api.ethereum.test.ts

@@ -49,7 +49,7 @@ describe('Api.ethereum', () => {
   const fetchBlock = async (height: number) => {
     const block = await ethApi.fetchBlock(height);
 
-    return block as EthereumBlock;
+    return block.block as EthereumBlock;
   };
 
   beforeEach(async () => {

packages/node/src/ethereum/api.ethereum.ts

@@ -14,7 +14,7 @@ import {
 } from '@ethersproject/abstract-provider';
 import { WebSocketProvider } from '@ethersproject/providers';
 import { EventEmitter2 } from '@nestjs/event-emitter';
-import { getLogger, timeout } from '@subql/node-core';
+import { getLogger, IBlock, timeout } from '@subql/node-core';
 import {
   ApiWrapper,
   EthereumBlock,
@@ -40,6 +40,7 @@ import { ConnectionInfo } from './ethers/web';
 import SafeEthProvider from './safe-api';
 import {
   formatBlock,
+  formatBlockUtil,
   formatLog,
   formatReceipt,
   formatTransaction,
@@ -279,7 +280,10 @@ export class EthereumApi implements ApiWrapper {
     return this.client.getBlock(heightOrHash);
   }
 
-  private async getBlockPromise(num: number, includeTx = true): Promise<any> {
+  private async getBlockPromise(
+    num: number,
+    includeTx = true,
+  ): Promise<IBlock<any>> {
     const rawBlock = await this.client.send('eth_getBlockByNumber', [
       hexValue(num),
       includeTx,
@@ -288,11 +292,8 @@ export class EthereumApi implements ApiWrapper {
     if (!rawBlock) {
       throw new Error(`Failed to fetch block ${num}`);
     }
-
-    const block = formatBlock(rawBlock);
-
-    block.stateRoot = this.client.formatter.hash(block.stateRoot);
-
+    const block = formatBlockUtil(formatBlock(rawBlock));
+    block.block.stateRoot = this.client.formatter.hash(block.block.stateRoot);
     return block;
   }
 
@@ -304,27 +305,29 @@ export class EthereumApi implements ApiWrapper {
     );
   }
 
-  async fetchBlock(blockNumber: number): Promise<EthereumBlock> {
+  async fetchBlock(blockNumber: number): Promise<IBlock<EthereumBlock>> {
     try {
       const block = await this.getBlockPromise(blockNumber, true);
-      const logsRaw = await this.client.getLogs({ blockHash: block.hash });
+      const logsRaw = await this.client.getLogs({
+        blockHash: block.block.hash,
+      });
 
       // Certain RPC may not accommodate for blockHash, and would return wrong logs
       if (logsRaw.length) {
         assert(
-          logsRaw.every((l) => l.blockHash === block.hash),
+          logsRaw.every((l) => l.blockHash === block.block.hash),
           `Log BlockHash does not match block: ${blockNumber}`,
         );
       }
 
-      block.logs = logsRaw.map((l) => formatLog(l, block));
-      block.transactions = block.transactions.map((tx) => ({
-        ...formatTransaction(tx, block),
+      block.block.logs = logsRaw.map((l) => formatLog(l, block.block));
+      block.block.transactions = block.block.transactions.map((tx) => ({
+        ...formatTransaction(tx, block.block),
         receipt: () =>
           this.getTransactionReceipt(tx.hash).then((r) =>
-            formatReceipt(r, block),
+            formatReceipt(r, block.block),
           ),
-        logs: block.logs.filter((l) => l.transactionHash === tx.hash),
+        logs: block.block.logs.filter((l) => l.transactionHash === tx.hash),
       }));
 
       this.eventEmitter.emit('fetchBlock');
@@ -336,23 +339,26 @@ export class EthereumApi implements ApiWrapper {
 
   private async fetchLightBlock(
     blockNumber: number,
-  ): Promise<LightEthereumBlock> {
+  ): Promise<IBlock<LightEthereumBlock>> {
     const block = await this.getBlockPromise(blockNumber, false);
-    const logs = await this.client.getLogs({ blockHash: block.hash });
+    const logs = await this.client.getLogs({ blockHash: block.block.hash });
 
     return {
+      block: {
+        logs: logs.map((l) => formatLog(l, block.block)),
+        ...block.block,
+      },
       ...block,
-      logs: logs.map((l) => formatLog(l, block)),
     };
   }
 
-  async fetchBlocks(bufferBlocks: number[]): Promise<EthereumBlock[]> {
+  async fetchBlocks(bufferBlocks: number[]): Promise<IBlock<EthereumBlock>[]> {
     return Promise.all(bufferBlocks.map(async (num) => this.fetchBlock(num)));
   }
 
   async fetchBlocksLight(
     bufferBlocks: number[],
-  ): Promise<LightEthereumBlock[]> {
+  ): Promise<IBlock<LightEthereumBlock>[]> {
     return Promise.all(
       bufferBlocks.map(async (num) => this.fetchLightBlock(num)),
     );
@@ -449,7 +455,6 @@ export class EthereumApi implements ApiWrapper {
         )) as Array<EthereumLog | EthereumLog<T>>);
 
       transaction.args = args;
-
       return transaction;
     } catch (e) {
       logger.warn(`Failed to parse transaction data: ${e.message}`);

packages/node/src/ethereum/api.service.ethereum.ts

@@ -9,6 +9,7 @@ import {
   getLogger,
   NodeConfig,
   profilerWrap,
+  IBlock,
 } from '@subql/node-core';
 import {
   EthereumBlock,
@@ -32,7 +33,7 @@ const logger = getLogger('api');
 export class EthereumApiService extends ApiService<
   EthereumApi,
   SafeEthProvider,
-  EthereumBlock[] | LightEthereumBlock[]
+  IBlock<EthereumBlock>[] | IBlock<LightEthereumBlock>[]
 > {
   private fetchBlocksFunction: FetchFunc;
   private fetchBlocksBatches: GetFetchFunc = () => this.fetchBlocksFunction;
@@ -159,14 +160,14 @@ export class EthereumApiService extends ApiService<
   private async fetchFullBlocksBatch(
     api: EthereumApi,
     batch: number[],
-  ): Promise<EthereumBlock[]> {
+  ): Promise<IBlock<EthereumBlock>[]> {
     return api.fetchBlocks(batch);
   }
 
   private async fetchLightBlocksBatch(
     api: EthereumApi,
     batch: number[],
-  ): Promise<LightEthereumBlock[]> {
+  ): Promise<IBlock<LightEthereumBlock>[]> {
     return api.fetchBlocksLight(batch);
   }
 

packages/node/src/ethereum/block.ethereum.ts

@@ -137,5 +137,11 @@ export function filterLogsProcessor(
 
 export function isFullBlock(block: BlockContent): block is EthereumBlock {
   // Light etherum block just contains transaction hashes for transactions. If the block has no transactions then both types would be the same
-  return typeof (block as EthereumBlock).transactions[0] !== 'string';
+  return (
+    typeof (block as EthereumBlock).transactions[0] !== 'string' ||
+    !(
+      !(block as EthereumBlock).transactions.length &&
+      (block as EthereumBlock).logs.length
+    )
+  );
 }

packages/node/src/ethereum/utils.ethereum.ts

@@ -1,9 +1,11 @@
 // Copyright 2020-2024 SubQuery Pte Ltd authors & contributors
 // SPDX-License-Identifier: GPL-3.0
 
+import { Block } from '@ethersproject/abstract-provider';
 import { getAddress } from '@ethersproject/address';
 import { BigNumber } from '@ethersproject/bignumber';
 import { Zero } from '@ethersproject/constants';
+import { Header, IBlock } from '@subql/node-core';
 import {
   ApiWrapper,
   EthereumBlock,
@@ -13,6 +15,7 @@ import {
   EthereumTransaction,
 } from '@subql/types-ethereum';
 import { omit } from 'lodash';
+import { BlockContent } from '../indexer/types';
 
 export function calcInterval(api: ApiWrapper): number {
   // TODO find a way to get this from the blockchain
@@ -26,7 +29,7 @@ function handleAddress(value: string): string | null {
   return getAddress(value);
 }
 
-function handleNumber(value: string | number): BigNumber {
+export function handleNumber(value: string | number): BigNumber {
   if (value === undefined) {
     return Zero;
   }
@@ -58,6 +61,20 @@ export function formatBlock(block: Record<string, any>): EthereumBlock {
     logs: [], // Filled in at AvalancheBlockWrapped constructor
   } as EthereumBlock;
 }
+
+export function formatBlockUtil(block: EthereumBlock): IBlock<EthereumBlock> {
+  return {
+    block,
+    getHeader: () => {
+      return {
+        blockHash: block.hash,
+        blockHeight: block.number,
+        parentHash: block.parentHash,
+      };
+    },
+  };
+}
+
 export function formatLog(
   log: Omit<
     EthereumLog<EthereumResult> | EthereumLog,
@@ -139,3 +156,11 @@ export function formatReceipt<R extends EthereumReceipt = EthereumReceipt>(
     },
   } as unknown as R;
 }
+
+export function ethereumBlockToHeader(block: BlockContent | Block): Header {
+  return {
+    blockHeight: block.number,
+    blockHash: block.hash,
+    parentHash: block.parentHash,
+  };
+}

packages/node/src/indexer/blockDispatcher/block-dispatcher.service.ts

@@ -9,12 +9,12 @@ import {
   StoreCacheService,
   StoreService,
   IProjectService,
-  PoiService,
   BlockDispatcher,
   ProcessBlockResponse,
   ApiService,
   IProjectUpgradeService,
   PoiSyncService,
+  IBlock,
 } from '@subql/node-core';
 import {
   EthereumProjectDs,
@@ -63,16 +63,16 @@ export class BlockDispatcherService
     );
   }
 
-  protected getBlockHeight(block: BlockContent): number {
-    return block.number;
+  onApplicationShutdown(signal?: string) {
+    throw new Error('Method not implemented.');
   }
 
   protected async indexBlock(
-    block: BlockContent,
+    block: IBlock<BlockContent>,
   ): Promise<ProcessBlockResponse> {
     return this.indexerManager.indexBlock(
       block,
-      await this.projectService.getDataSources(this.getBlockHeight(block)),
+      await this.projectService.getDataSources(block.getHeader().blockHeight),
     );
   }
 }

packages/node/src/indexer/blockDispatcher/ethereum-block-dispatcher.ts

@@ -1,8 +1,10 @@
 // Copyright 2020-2024 SubQuery Pte Ltd authors & contributors
 // SPDX-License-Identifier: GPL-3.0
 
-import { IBlockDispatcher } from '@subql/node-core';
+import { IBlockDispatcher, IBlock } from '@subql/node-core';
+import { EthereumBlock } from '@subql/types-ethereum';
 
-export interface IEthereumBlockDispatcher extends IBlockDispatcher {
+export interface IEthereumBlockDispatcher
+  extends IBlockDispatcher<EthereumBlock> {
   init(onDynamicDsCreated: (height: number) => Promise<void>): Promise<void>;
 }