feat: add blockmeta block number provider

packages/blocknumber/package.json

@@ -17,7 +17,11 @@
     "author": "",
     "license": "ISC",
     "dependencies": {
-        "viem": "2.17.10",
-        "@ebo-agent/shared": "workspace:*"
+        "@ebo-agent/shared": "workspace:*",
+        "axios": "1.7.7",
+        "viem": "2.17.10"
+    },
+    "devDependencies": {
+        "axios-mock-adapter": "2.0.0"
     }
 }

packages/blocknumber/src/exceptions/undefinedBlockNumber.ts

@@ -0,0 +1,7 @@
+export class UndefinedBlockNumber extends Error {
+    constructor(isoTimestamp: string) {
+        super(`Undefined block number at ${isoTimestamp}.`);
+
+        this.name = "UndefinedBlockNumber";
+    }
+}

packages/blocknumber/src/providers/blockNumberProviderFactory.ts

@@ -4,6 +4,7 @@ import { FallbackTransport, HttpTransport, PublicClient } from "viem";
 import { UnsupportedChain } from "../exceptions/unsupportedChain.js";
 import { Caip2ChainId } from "../types.js";
 import { Caip2Utils } from "../utils/index.js";
+import { BlockmetaJsonBlockNumberProvider } from "./blockmetaJsonBlockNumberProvider.js";
 import { EvmBlockNumberProvider } from "./evmBlockNumberProvider.js";
 
 const DEFAULT_PROVIDER_CONFIG = {
@@ -16,20 +17,24 @@ export class BlockNumberProviderFactory {
      * Build a `BlockNumberProvider` to handle communication with the specified chain.
      *
      * @param chainId CAIP-2 chain id
-     * @param client a viem public client
+     * @param evmClient a viem public client
      * @param logger a ILogger instance
      * @returns
      */
     public static buildProvider(
         chainId: Caip2ChainId,
-        client: PublicClient<FallbackTransport<HttpTransport[]>>,
+        evmClient: PublicClient<FallbackTransport<HttpTransport[]>>,
+        blockmetaConfig: { baseUrl: URL; servicePath: string; bearerToken: string },
         logger: ILogger,
     ) {
         const chainNamespace = Caip2Utils.getNamespace(chainId);
 
         switch (chainNamespace) {
             case EBO_SUPPORTED_CHAINS_CONFIG.evm.namespace:
-                return new EvmBlockNumberProvider(client, DEFAULT_PROVIDER_CONFIG, logger);
+                return new EvmBlockNumberProvider(evmClient, DEFAULT_PROVIDER_CONFIG, logger);
+
+            case EBO_SUPPORTED_CHAINS_CONFIG.solana.namespace:
+                return new BlockmetaJsonBlockNumberProvider(blockmetaConfig, logger);
 
             default:
                 throw new UnsupportedChain(chainId);

packages/blocknumber/src/providers/blockmetaJsonBlockNumberProvider.ts

@@ -0,0 +1,126 @@
+import { ILogger, Timestamp } from "@ebo-agent/shared";
+import axios, { AxiosInstance, AxiosResponse, isAxiosError } from "axios";
+
+import { UndefinedBlockNumber } from "../exceptions/undefinedBlockNumber.js";
+import { BlockNumberProvider } from "./blockNumberProvider.js";
+
+type BlockByTimeResponse = {
+    num: string;
+    id: string;
+    time: string;
+};
+
+export type BlockmetaClientConfig = {
+    baseUrl: URL;
+    servicePath: string;
+    bearerToken: string;
+};
+
+/**
+ * Consumes the blockmeta.BlockByTime substreams' service via HTTP POST JSON requests to provide
+ * block numbers based on timestamps
+ *
+ * Refer to these web pages for more information:
+ * * https://thegraph.market/
+ * * https://substreams.streamingfast.io/documentation/consume/authentication
+ */
+export class BlockmetaJsonBlockNumberProvider implements BlockNumberProvider {
+    private readonly axios: AxiosInstance;
+
+    constructor(
+        private readonly options: BlockmetaClientConfig,
+        private readonly logger: ILogger,
+    ) {
+        const { baseUrl, bearerToken } = options;
+
+        this.axios = axios.create({
+            baseURL: baseUrl.toString(),
+            headers: {
+                common: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${bearerToken}`,
+                },
+            },
+        });
+    }
+
+    /** @inheritdoc */
+    async getEpochBlockNumber(timestamp: Timestamp): Promise<bigint> {
+        if (timestamp > Number.MAX_SAFE_INTEGER || timestamp < Number.MIN_SAFE_INTEGER)
+            throw new RangeError(`Timestamp ${timestamp.toString()} cannot be casted to a Number.`);
+
+        const timestampNumber = Number(timestamp);
+        const isoTimestamp = new Date(timestampNumber).toISOString();
+
+        try {
+            // Try to get the block number at a specific timestamp
+            const blockNumberAt = await this.getBlockNumberAt(isoTimestamp);
+
+            return blockNumberAt;
+        } catch (err) {
+            const isAxios404 = isAxiosError(err) && err.status === 404;
+            const isUndefinedBlockNumber = err instanceof UndefinedBlockNumber;
+
+            if (!isAxios404 && !isUndefinedBlockNumber) throw err;
+
+            // If no block has its timestamp exactly equal to the specified timestamp,
+            // try to get the most recent block before the specified timestamp.
+            const blockNumberBefore = await this.getBlockNumberBefore(isoTimestamp);
+
+            return blockNumberBefore;
+        }
+    }
+
+    /**
+     * Gets the block number at a specific timestamp.
+     *
+     * @param isoTimestamp ISO UTC timestamp
+     * @throws { UndefinedBlockNumber } if request was successful but block number is invalid/not present
+     * @throws { AxiosError } if request fails
+     * @returns a promise with the block number at the timestamp
+     */
+    private async getBlockNumberAt(isoTimestamp: string): Promise<bigint> {
+        const { servicePath } = this.options;
+
+        const response = await this.axios.post(`${servicePath}/At`, { time: isoTimestamp });
+
+        return this.parseBlockByTimeResponse(response, isoTimestamp);
+    }
+
+    /**
+     * Gets the most recent block number before the specified timestamp.
+     *
+     * @param isoTimestamp ISO UTC timestamp
+     * @throws { UndefinedBlockNumber } if request was successful but block number is invalid/not present
+     * @throws { AxiosError } if request fails
+     * @returns a promise with the most recent block number before the specified timestamp
+     */
+    private async getBlockNumberBefore(isoTimestamp: string): Promise<bigint> {
+        const { servicePath } = this.options;
+
+        const response = await this.axios.post(`${servicePath}/Before`, { time: isoTimestamp });
+
+        return this.parseBlockByTimeResponse(response, isoTimestamp);
+    }
+
+    /**
+     * Parse the BlockByTime response and extracts the block number.
+     *
+     * @param response an AxiosResponse of a request to BlockByTime endpoint
+     * @param isoTimestamp the timestamp that was sent in the request
+     * @returns
+     */
+    private parseBlockByTimeResponse(response: AxiosResponse, isoTimestamp: string) {
+        const { data } = response;
+        // TODO: validate with zod instead
+        const blockNumber = (data as BlockByTimeResponse)["num"];
+
+        if (blockNumber === undefined) {
+            this.logger.error(`Couldn't find a block number for timestamp ${isoTimestamp}`);
+
+            throw new UndefinedBlockNumber(isoTimestamp);
+        }
+
+        return BigInt(blockNumber);
+    }
+}

packages/blocknumber/src/providers/index.ts

@@ -0,0 +1,4 @@
+export * from "./blockNumberProvider.js";
+export * from "./blockNumberProviderFactory.js";
+export * from "./blockmetaJsonBlockNumberProvider.js";
+export * from "./evmBlockNumberProvider.js";

packages/blocknumber/src/services/blockNumberService.ts

@@ -2,6 +2,7 @@ import { EBO_SUPPORTED_CHAIN_IDS, ILogger, Timestamp } from "@ebo-agent/shared";
 import { createPublicClient, fallback, http } from "viem";
 
 import { ChainWithoutProvider, EmptyRpcUrls, UnsupportedChain } from "../exceptions/index.js";
+import { BlockmetaClientConfig } from "../providers/blockmetaJsonBlockNumberProvider.js";
 import { BlockNumberProvider } from "../providers/blockNumberProvider.js";
 import { BlockNumberProviderFactory } from "../providers/blockNumberProviderFactory.js";
 import { Caip2ChainId } from "../types.js";
@@ -20,6 +21,7 @@ export class BlockNumberService {
      */
     constructor(
         chainRpcUrls: Map<Caip2ChainId, RpcUrl[]>,
+        private readonly blockmetaConfig: BlockmetaClientConfig,
         private readonly logger: ILogger,
     ) {
         this.blockNumberProviders = this.buildBlockNumberProviders(chainRpcUrls);
@@ -81,7 +83,12 @@ export class BlockNumberService {
                 transport: fallback(urls.map((url) => http(url))),
             });
 
-            const provider = BlockNumberProviderFactory.buildProvider(chainId, client, this.logger);
+            const provider = BlockNumberProviderFactory.buildProvider(
+                chainId,
+                client,
+                this.blockmetaConfig,
+                this.logger,
+            );
 
             if (!provider) throw new ChainWithoutProvider(chainId);
 

packages/blocknumber/test/providers/blockNumberProviderFactory.spec.ts

@@ -1,29 +1,69 @@
 import { Logger } from "@ebo-agent/shared";
-import { createPublicClient, fallback, http } from "viem";
+import {
+    createPublicClient,
+    fallback,
+    FallbackTransport,
+    http,
+    HttpTransport,
+    PublicClient,
+} from "viem";
 import { describe, expect, it } from "vitest";
 
-import { UnsupportedChain } from "../../src/exceptions";
-import { BlockNumberProviderFactory } from "../../src/providers/blockNumberProviderFactory";
-import { EvmBlockNumberProvider } from "../../src/providers/evmBlockNumberProvider";
-import { Caip2ChainId } from "../../src/types";
+import { UnsupportedChain } from "../../src/exceptions/index.js";
+import {
+    BlockmetaClientConfig,
+    BlockmetaJsonBlockNumberProvider,
+    BlockNumberProviderFactory,
+    EvmBlockNumberProvider,
+} from "../../src/providers/index.js";
+import { Caip2ChainId } from "../../src/types.js";
 
 describe("BlockNumberProviderFactory", () => {
     const logger = Logger.getInstance();
 
-    describe("buildProvider", () => {
-        const client = createPublicClient({ transport: fallback([http("http://localhost:8545")]) });
+    const client: PublicClient<FallbackTransport<HttpTransport[]>> = createPublicClient({
+        transport: fallback([http("http://localhost:8545")]),
+    });
 
-        it("builds a provider", () => {
-            const provider = BlockNumberProviderFactory.buildProvider("eip155:1", client, logger);
+    const blockmetaConfig: BlockmetaClientConfig = {
+        baseUrl: new URL("localhost:443"),
+        servicePath: "/sf.blockmeta.v2.BlockByTime",
+        bearerToken: "bearer-token",
+    };
+
+    describe("buildProvider", () => {
+        it("builds an EVM provider", () => {
+            const provider = BlockNumberProviderFactory.buildProvider(
+                "eip155:1",
+                client,
+                blockmetaConfig,
+                logger,
+            );
 
             expect(provider).toBeInstanceOf(EvmBlockNumberProvider);
         });
 
+        it("builds a Solana Blockmeta provider", () => {
+            const provider = BlockNumberProviderFactory.buildProvider(
+                "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+                client,
+                blockmetaConfig,
+                logger,
+            );
+
+            expect(provider).toBeInstanceOf(BlockmetaJsonBlockNumberProvider);
+        });
+
         it("fails if chain is not supported", () => {
-            const unsupportedChainId = "solana:80085" as Caip2ChainId;
+            const unsupportedChainId = "antelope:f16b1833c747c43682f4386fca9cbb32" as Caip2ChainId;
 
             expect(() => {
-                BlockNumberProviderFactory.buildProvider(unsupportedChainId, client, logger);
+                BlockNumberProviderFactory.buildProvider(
+                    unsupportedChainId,
+                    client,
+                    blockmetaConfig,
+                    logger,
+                );
             }).toThrow(UnsupportedChain);
         });
     });