@recoillink/sdk 0.0.0-stage → 45.0.1

package/dist/rpc/evm/EvmEventLogsReader.d.ts

@@ -0,0 +1,91 @@
+import { Logger } from 'pino';
+import { z } from 'zod';
+import { Address } from '@recoillink/utils';
+import type { ChainMetadataManager } from '../../metadata/ChainMetadataManager.js';
+import { MultiProvider } from '../../providers/MultiProvider.js';
+import type { ChainNameOrId } from '../../types.js';
+import { GetEventLogsResponse } from './types.js';
+export type EvmEventLogsReaderConfig = {
+    chain: ChainNameOrId;
+    useRPC?: boolean;
+    paginationBlockRange?: number;
+    explorerFallback?: ExplorerFallbackConfig;
+};
+export declare const GetLogByTopicOptionsSchema: z.ZodObject<{
+    eventTopic: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    contractAddress: z.ZodString;
+    fromBlock: z.ZodOptional<z.ZodNumber>;
+    toBlock: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const RequiredGetLogByTopicOptionsSchema: z.ZodObject<{
+    eventTopic: z.ZodNonOptional<z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>>;
+    contractAddress: z.ZodNonOptional<z.ZodString>;
+    fromBlock: z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>;
+    toBlock: z.ZodNonOptional<z.ZodOptional<z.ZodNumber>>;
+}, z.core.$strip>;
+type GetLogByTopicOptions = z.infer<typeof GetLogByTopicOptionsSchema>;
+type RequiredGetLogByTopicOptions = z.infer<typeof RequiredGetLogByTopicOptionsSchema>;
+interface IEvmEventLogsReaderStrategy {
+    getContractDeploymentBlockNumber(address: Address): Promise<number>;
+    getContractLogs(address: RequiredGetLogByTopicOptions): Promise<GetEventLogsResponse[]>;
+}
+export type ExplorerFallbackConfig = Partial<Record<keyof IEvmEventLogsReaderStrategy, boolean>>;
+export declare class EvmEtherscanLikeEventLogsReader implements IEvmEventLogsReaderStrategy {
+    protected readonly chain: ChainNameOrId;
+    protected readonly config: Awaited<ReturnType<ChainMetadataManager['getExplorerApi']>>;
+    protected readonly multiProvider: MultiProvider;
+    constructor(chain: ChainNameOrId, config: Awaited<ReturnType<ChainMetadataManager['getExplorerApi']>>, multiProvider: MultiProvider);
+    getContractDeploymentBlockNumber(address: string): Promise<number>;
+    getContractLogs(options: RequiredGetLogByTopicOptions): Promise<GetEventLogsResponse[]>;
+}
+export declare class EvmRpcEventLogsReader implements IEvmEventLogsReaderStrategy {
+    protected readonly chain: ChainNameOrId;
+    protected readonly config: {
+        paginationBlockRange?: number;
+    };
+    protected readonly multiProvider: MultiProvider;
+    constructor(chain: ChainNameOrId, config: {
+        paginationBlockRange?: number;
+    }, multiProvider: MultiProvider);
+    getContractDeploymentBlockNumber(address: string): Promise<number>;
+    getContractLogs(options: RequiredGetLogByTopicOptions): Promise<GetEventLogsResponse[]>;
+}
+export declare class FallbackEvmEventLogsReader implements IEvmEventLogsReaderStrategy {
+    protected readonly chain: ChainNameOrId;
+    protected readonly readers: EvmEtherscanLikeEventLogsReader[];
+    protected readonly logger: Logger;
+    protected readonly config: ExplorerFallbackConfig;
+    constructor(chain: ChainNameOrId, readers: EvmEtherscanLikeEventLogsReader[], logger: Logger, config?: ExplorerFallbackConfig);
+    private executeWithFallback;
+    getContractDeploymentBlockNumber(address: Address): Promise<number>;
+    getContractLogs(options: RequiredGetLogByTopicOptions): Promise<GetEventLogsResponse[]>;
+}
+export declare class EvmEventLogsReader {
+    protected readonly config: EvmEventLogsReaderConfig;
+    protected readonly multiProvider: MultiProvider;
+    protected logReaderStrategy: IEvmEventLogsReaderStrategy;
+    protected readonly logger: Logger;
+    protected fallbackLogReaderStrategy?: IEvmEventLogsReaderStrategy | undefined;
+    private deploymentBlockCache;
+    private explorerDeploymentBlockCache;
+    protected constructor(config: EvmEventLogsReaderConfig, multiProvider: MultiProvider, logReaderStrategy: IEvmEventLogsReaderStrategy, logger: Logger, fallbackLogReaderStrategy?: IEvmEventLogsReaderStrategy | undefined);
+    static fromConfig(config: EvmEventLogsReaderConfig, multiProvider: MultiProvider, logger?: Logger): EvmEventLogsReader;
+    getContractDeploymentBlockFromExplorer(contractAddress: Address): Promise<number>;
+    /**
+     * The block the contract was deployed in, which is where a scan of its whole
+     * history starts. Read over the block explorer where the chain has a usable
+     * one and over the RPC otherwise, the same way `getLogsByTopic` resolves it
+     * when a caller does not supply `fromBlock`, and cached per instance.
+     *
+     * Exposed for callers that read the same range more than once: resolving it
+     * here and passing it as `fromBlock` keeps a later read from deriving it
+     * again over the RPC, which bisects `eth_getCode` through historical blocks
+     * that a chain serving no archive state cannot answer.
+     */
+    getContractDeploymentBlock(contractAddress: Address): Promise<number>;
+    getLogsByTopic(options: GetLogByTopicOptions): Promise<GetEventLogsResponse[]>;
+    private getDeploymentBlock;
+    private getLogsByTopicWithStrategy;
+}
+export {};
+//# sourceMappingURL=EvmEventLogsReader.d.ts.map

package/dist/rpc/evm/EvmEventLogsReader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmEventLogsReader.d.ts","sourceRoot":"","sources":["../../../src/rpc/evm/EvmEventLogsReader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EACL,OAAO,EAKR,MAAM,mBAAmB,CAAC;AAO3B,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wCAAwC,CAAC;AAEnF,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAGlD,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,aAAa,CAAC;IAGrB,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAG9B,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;CAC3C,CAAC;AAEF,eAAO,MAAM,0BAA0B;;;;;iBAKrC,CAAC;AAEH,eAAO,MAAM,kCAAkC;;;;;iBACR,CAAC;AAExC,KAAK,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AACvE,KAAK,4BAA4B,GAAG,CAAC,CAAC,KAAK,CACzC,OAAO,kCAAkC,CAC1C,CAAC;AAyBF,UAAU,2BAA2B;IACnC,gCAAgC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpE,eAAe,CACb,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAAC;CACpC;AAED,MAAM,MAAM,sBAAsB,GAAG,OAAO,CAC1C,MAAM,CAAC,MAAM,2BAA2B,EAAE,OAAO,CAAC,CACnD,CAAC;AAEF,qBAAa,+BAAgC,YAAW,2BAA2B;IAE/E,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa;IACvC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAChC,UAAU,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CACnD;IACD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa;IALjD,YACqB,KAAK,EAAE,aAAa,EACpB,MAAM,EAAE,OAAO,CAChC,UAAU,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CACnD,EACkB,aAAa,EAAE,aAAa,EAC7C;IAEE,gCAAgC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAmBvE;IAEK,eAAe,CACnB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAejC;CACF;AAED,qBAAa,qBAAsB,YAAW,2BAA2B;IAErE,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa;IACvC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE;QAAE,oBAAoB,CAAC,EAAE,MAAM,CAAA;KAAE;IAC5D,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa;IAHjD,YACqB,KAAK,EAAE,aAAa,EACpB,MAAM,EAAE;QAAE,oBAAoB,CAAC,EAAE,MAAM,CAAA;KAAE,EACzC,aAAa,EAAE,aAAa,EAC7C;IAEJ,gCAAgC,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAMjE;IAED,eAAe,CACb,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAYjC;CACF;AAuBD,qBAAa,0BAA2B,YAAW,2BAA2B;IAE1E,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa;IACvC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,+BAA+B,EAAE;IAC7D,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACjC,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,sBAAsB;IAJnD,YACqB,KAAK,EAAE,aAAa,EACpB,OAAO,EAAE,+BAA+B,EAAE,EAC1C,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,sBAA2B,EAGvD;YAEa,mBAAmB;IAsBjC,gCAAgC,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAKlE;IAED,eAAe,CACb,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAKjC;CACF;AAED,qBAAa,kBAAkB;IAK3B,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,wBAAwB;IACnD,SAAS,CAAC,QAAQ,CAAC,aAAa,EAAE,aAAa;IAC/C,SAAS,CAAC,iBAAiB,EAAE,2BAA2B;IACxD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACjC,SAAS,CAAC,yBAAyB,CAAC,EAAE,2BAA2B;IARnE,OAAO,CAAC,oBAAoB,CAAkC;IAC9D,OAAO,CAAC,4BAA4B,CAAkC;IAEtE,SAAS,aACY,MAAM,EAAE,wBAAwB,EAChC,aAAa,EAAE,aAAa,EACrC,iBAAiB,EAAE,2BAA2B,EACrC,MAAM,EAAE,MAAM,EACvB,yBAAyB,CAAC,EAAE,2BAA2B,YAAA,EAC/D;IAEJ,MAAM,CAAC,UAAU,CACf,MAAM,EAAE,wBAAwB,EAChC,aAAa,EAAE,aAAa,EAC5B,MAAM,GAAE,MAEN,sBA4CH;IAEK,sCAAsC,CAC1C,eAAe,EAAE,OAAO,GACvB,OAAO,CAAC,MAAM,CAAC,CAkBjB;IAED;;;;;;;;;;OAUG;IACG,0BAA0B,CAAC,eAAe,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAmB1E;IAEK,cAAc,CAClB,OAAO,EAAE,oBAAoB,GAC5B,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAsCjC;YAEa,kBAAkB;YAalB,0BAA0B;CA+BzC"}

package/dist/rpc/evm/EvmEventLogsReader.hardhat-test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=EvmEventLogsReader.hardhat-test.d.ts.map

package/dist/rpc/evm/EvmEventLogsReader.hardhat-test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EvmEventLogsReader.hardhat-test.d.ts","sourceRoot":"","sources":["../../../src/rpc/evm/EvmEventLogsReader.hardhat-test.ts"],"names":[],"mappings":""}