feat: hedera (#74)

0xkenj1 · thelostone-mc · 0xnigir1 · web-flow · commit 064c66194cd9 · 2025-02-24T16:41:10.000-03:00
## Description

- Add hedera to indexed chains
- Add more docs about adding new chain 
- Add more decimals for amounts in usd on the db 

## Checklist before requesting a review

-   [x] I have conducted a self-review of my code.
-   [x] I have conducted a QA.
-   [x] If it is a core feature, I have included comprehensive tests.


&lt;!-- This is an auto-generated comment: release notes by coderabbit.ai
--&gt;

## Summary by CodeRabbit

- **Documentation**
- Added detailed step-by-step guides for integrating new blockchains and
tokens.
- Expanded setup instructions with additional environment configuration
details.

- **New Features**
- Introduced support for a new blockchain network and HBAR token
pricing.
- Increased currency precision for more accurate financial calculations.
  - Enhanced validation to ensure only supported networks are processed.

- **Tests**
- Included new test scenarios to verify proper error handling for
unsupported chains.

&lt;!-- end of auto-generated comment: release notes by coderabbit.ai --&gt;

---------

Co-authored-by: Aditya Anand M C &lt;aditya.anandmc@gmail.com&gt;
Co-authored-by: nigiri &lt;168690269+0xnigir1@users.noreply.github.com&gt;
diff --git a/README.md b/README.md
@@ -112,6 +112,13 @@ http://localhost:8082/
 
 Use the default password: `my-admin-secret`.
 
+## To add a new chain
+
+1. On `indexer` package add the chain to `config.yaml` (refer to : [[How to add a new chain](apps/indexer/README.md)] )
+2. On `shared` package modify `tokens.ts` and add the tokens you will search price for (Refer to : [[How to add a new token](apps/shared/README.md)] )
+3. Wait until the new chain is fully indexed
+4. Run bootstrap pricing and metadata scripts (refer to: [[How to run bootstrap for specific chain](scripts/bootstrap/README.md)] )
+
 ## Contributing
 
 Wonderland is a team of top Web3 researchers, developers, and operators who believe that the future needs to be open-source, permissionless, and decentralized.
diff --git a/apps/indexer/README.md b/apps/indexer/README.md
@@ -43,6 +43,27 @@ Create a handler for the new event. This handler is essential for ensuring the e
 
 After making the necessary changes, redeploy your environment to apply the updates.
 
+## Adding a new chain
+
+### Step 1: Add the Chain to `config.yaml`
+
+Example:
+Use your values for the chain and the contracts you want to index.
+
+```yaml
+- id: 1 # ethereum
+  start_block: 17423042
+  rpc_url: https://mainnet.infura.io/v3/YOUR_INFURA_PROJECT_ID
+  contracts:
+      - name: Registry
+        address:
+            - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+      - name: Strategy
+      - name: Allo
+        address:
+            - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+```
+
 ## 🔍 Notes
 
 Ensure each event is properly handled and thoroughly tested before redeploying the environment to prevent issues in the indexing process.
diff --git a/apps/indexer/config.yaml b/apps/indexer/config.yaml
@@ -144,82 +144,82 @@ networks:
             address:
                 - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
 
-    - id: 250 # fantom
-      start_block: 77624278
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
-
-    - id: 42161 # arbitrum
-      start_block: 146489425
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
-
-    - id: 137 # polygon
-      start_block: 49466006
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
-
-    - id: 8453 # base
-      start_block: 6083365
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
-
-    - id: 324 # zksync-era-mainnet
-      start_block: 31154341
-      contracts:
-          - name: Registry
-            address:
-                - 0xaa376Ef759c1f5A8b0B5a1e2FEC5C23f3bF30246
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x9D1D1BF2835935C291C0f5228c86d5C4e235A249
-
-    - id: 43114 # avalanche
-      start_block: 34540051
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
-
-    - id: 534352 # scroll
-      start_block: 2683205
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+    # - id: 250 # fantom
+    #   start_block: 77624278
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    # - id: 42161 # arbitrum
+    #   start_block: 146489425
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    # - id: 137 # polygon
+    #   start_block: 49466006
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    # - id: 8453 # base
+    #   start_block: 6083365
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    # - id: 324 # zksync-era-mainnet
+    #   start_block: 31154341
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0xaa376Ef759c1f5A8b0B5a1e2FEC5C23f3bF30246
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x9D1D1BF2835935C291C0f5228c86d5C4e235A249
+
+    # - id: 43114 # avalanche
+    #   start_block: 34540051
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    # - id: 534352 # scroll
+    #   start_block: 2683205
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
 
     # - id: 1329 # sei-mainnet
     #   rpc_config:
@@ -234,19 +234,38 @@ networks:
     #       address:
     #         - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
 
-    - id: 42220 # celo-mainnet
-      start_block: 22257475
-      contracts:
-          - name: Registry
-            address:
-                - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
-          - name: Strategy
-          - name: Allo
-            address:
-                - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
-
-    - id: 42 # lukso-mainnet
-      start_block: 2400000
+    # - id: 42220 # celo-mainnet
+    #   start_block: 22257475
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    # - id: 42 # lukso-mainnet
+    #   start_block: 2400000
+    #   contracts:
+    #       - name: Registry
+    #         address:
+    #             - 0x4AAcca72145e1dF2aeC137E1f3C5E3D75DB8b5f3
+    #       - name: Strategy
+    #       - name: Allo
+    #         address:
+    #             - 0x1133eA7Af70876e64665ecD07C0A0476d09465a1
+
+    - id: 295 # hedera-mainnet
+      rpc_config:
+          url: https://mainnet.hashio.io/api
+          initial_block_interval: 1000 # Number of blocks to request initially
+          backoff_multiplicative: 0 # Factor to reduce batch size on error
+          acceleration_additive: 0 # Increase batch size if no errors
+          interval_ceiling: 1000 # Maximum blocks per request
+          backoff_millis: 1000 # Wait time before retrying in milliseconds
+          query_timeout_millis: 20000 # Timeout for RPC requests in milliseconds
+      start_block: 75239000
       contracts:
           - name: Registry
             address:
diff --git a/apps/processing/src/exceptions/index.ts b/apps/processing/src/exceptions/index.ts
@@ -0,0 +1 @@
+export * from "./invalidChainId.exception.js";
diff --git a/apps/processing/src/exceptions/invalidChainId.exception.ts b/apps/processing/src/exceptions/invalidChainId.exception.ts
@@ -0,0 +1,6 @@
+export class InvalidChainId extends Error {
+    constructor(chainId: number) {
+        super(`Chain ${chainId} not found`);
+        this.name = "InvalidChainId";
+    }
+}
diff --git a/apps/processing/src/services/processing.service.ts b/apps/processing/src/services/processing.service.ts
@@ -1,4 +1,5 @@
-import { optimism } from "viem/chains";
+import { Chain, extractChain } from "viem";
+import * as viemChains from "viem/chains";
 
 import { EvmProvider } from "@grants-stack-indexer/chain-providers";
 import {
@@ -11,6 +12,7 @@ import {
 import { ChainId, ILogger } from "@grants-stack-indexer/shared";
 
 import { Environment } from "../config/env.js";
+import { InvalidChainId } from "../exceptions/index.js";
 import { SharedDependencies, SharedDependenciesService } from "./index.js";
 
 /**
@@ -63,9 +65,18 @@ export class ProcessingService {
         const strategyRegistry = new DatabaseStrategyRegistry(logger, strategyRegistryRepository);
         const eventsRegistry = new DatabaseEventRegistry(logger, eventRegistryRepository);
 
+        const viemChainsArray = Object.values(viemChains) as Chain[];
+
         for (const chain of chains) {
             // Initialize EVM provider
-            const evmProvider = new EvmProvider(chain.rpcUrls, optimism, logger);
+            const viemChain = extractChain({
+                chains: viemChainsArray,
+                id: chain.id,
+            });
+            if (!viemChain) {
+                throw new InvalidChainId(chain.id);
+            }
+            const evmProvider = new EvmProvider(chain.rpcUrls, viemChain, logger);
 
             const cachedStrategyRegistry = await InMemoryCachedStrategyRegistry.initialize(
                 logger,
diff --git a/apps/processing/test/unit/processing.service.spec.ts b/apps/processing/test/unit/processing.service.spec.ts
@@ -10,6 +10,7 @@ import {
 } from "@grants-stack-indexer/data-flow";
 
 import type { Environment } from "../../src/config/env.js";
+import { InvalidChainId } from "../../src/exceptions/index.js";
 import { ProcessingService } from "../../src/services/processing.service.js";
 
 vi.mock("../../src/services/sharedDependencies.service.js", () => ({
@@ -91,7 +92,7 @@ describe("ProcessingService", () => {
                 fetchDelayMs: 1000,
             },
             {
-                id: 2,
+                id: 10,
                 rpcUrls: ["http://localhost:8546"],
                 name: "Chain 2",
                 fetchLimit: 200,
@@ -154,8 +155,14 @@ describe("ProcessingService", () => {
                 expect.any(AbortSignal),
                 expect.any(AbortSignal),
             ]);
-            expect(logSpy).toHaveBeenNthCalledWith(2, "Starting orchestrator for chain 1...");
-            expect(logSpy).toHaveBeenNthCalledWith(3, "Starting orchestrator for chain 2...");
+            expect(logSpy).toHaveBeenNthCalledWith(
+                2,
+                `Starting orchestrator for chain ${mockEnv.CHAINS[0]?.id}...`,
+            );
+            expect(logSpy).toHaveBeenNthCalledWith(
+                3,
+                `Starting orchestrator for chain ${mockEnv.CHAINS[1]?.id}...`,
+            );
 
             // Simulate SIGINT
             process.emit("SIGINT");
@@ -201,6 +208,22 @@ describe("ProcessingService", () => {
 
             expect(logSpy).toHaveBeenCalledWith(`Error releasing resources: ${mockError}`);
         });
+        it("throws an error if the chain is not supported", async () => {
+            const unsupportedChain = {
+                id: 2,
+                rpcUrls: ["http://localhost:8546"],
+                name: "Chain 2",
+                fetchLimit: 200,
+                fetchDelayMs: 2000,
+            };
+            const env = {
+                ...mockEnv,
+                CHAINS: [unsupportedChain],
+            };
+            await expect(ProcessingService.initialize(env as Environment)).rejects.toThrow(
+                InvalidChainId,
+            );
+        });
     });
 
     describe("retroactiveProcessing", () => {
diff --git a/packages/pricing/src/providers/coingecko.provider.ts b/packages/pricing/src/providers/coingecko.provider.ts
@@ -59,6 +59,7 @@ const TokenMapping: { [key: string]: CoingeckoTokenId | undefined } = {
     AVAX: "avalanche-2" as CoingeckoTokenId,
     // MTK: undefined,
     WSEI: "wrapped-sei" as CoingeckoTokenId,
+    HBAR: "hedera-hashgraph" as CoingeckoTokenId,
 };
 
 // sometimes coingecko returns no prices for 1 hour range, 2 hours works better
diff --git a/packages/pricing/src/types/coingecko.types.ts b/packages/pricing/src/types/coingecko.types.ts
@@ -11,7 +11,8 @@ export type CoingeckoSupportedChainId =
     | 1329
     | 42
     | 42220
-    | 1088;
+    | 1088
+    | 295;
 
 export type CoingeckoTokenId = Branded<string, "CoingeckoTokenId">;
 export type CoingeckoPlatformId = Branded<string, "CoingeckoPlatformId">;
diff --git a/packages/processors/src/processors/allo/handlers/poolCreated.handler.ts b/packages/processors/src/processors/allo/handlers/poolCreated.handler.ts
@@ -49,6 +49,7 @@ export class PoolCreatedHandler implements IEventHandler<"Allo", "PoolCreated">
             round?: unknown;
             application?: unknown;
         }>(metadataPointer);
+        // TODO: this might not work for other gitcoin strategies like retro funding
         const parsedRoundMetadata = RoundMetadataSchema.safeParse(metadata?.round);
 
         const checksummedTokenAddress = getAddress(tokenAddress);
diff --git a/packages/shared/README.md b/packages/shared/README.md
diff --git a/packages/shared/src/tokens/tokens.ts b/packages/shared/src/tokens/tokens.ts
diff --git a/scripts/bootstrap/README.md b/scripts/bootstrap/README.md
diff --git a/scripts/migrations/src/migrations/processing/20241029T120000_initial.ts b/scripts/migrations/src/migrations/processing/20241029T120000_initial.ts

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export * from "./invalidChainId.exception.js";`