ethers-rpc-pool 1.0.0 → 1.0.2

package/dist/index.d.cts

@@ -1,44 +1,69 @@
-import { JsonRpcProvider, Network } from 'ethers';
-
-declare class Semaphore {
-    private readonly max;
-    private inUse;
-    private queue;
-    constructor(max: number);
-    acquire(): Promise<() => void>;
-    private release;
-}
+import { JsonRpcProvider } from 'ethers';
 
 interface RpcStatsSnapshot {
     total: number;
     inFlight: number;
-    perMethod: Record<string, number>;
+    perMethodTotal: Record<string, number>;
     rateLimitedTotal: number;
-    rateLimitedPerProvider: Record<string, number>;
+    perProviderRateLimited: Record<string, number>;
     timeoutTotal: number;
-    timeoutPerProvider: Record<string, number>;
+    perProviderTimeout: Record<string, number>;
     perProviderTotal: Record<string, number>;
-    perProviderTimeouts: Record<string, number>;
     providerCooldownUntil: Record<string, number>;
+    perProviderInFlight: Record<string, number>;
 }
-declare class RPCStats {
-    total: number;
-    inFlight: number;
-    perMethod: Record<string, number>;
-    rateLimitedTotal: number;
-    timeoutTotal: number;
-    timeoutPerProvider: Record<string, number>;
-    rateLimitedPerProvider: Record<string, number>;
-    perProviderTotal: Record<string, number>;
-    perProviderTimeouts: Record<string, number>;
-    providerCooldownUntil: Record<string, number>;
-    bump(map: Record<string, number>, key: string): void;
+declare class Stats {
+    private _total;
+    private _inFlight;
+    private _perMethod;
+    private _rateLimitedTotal;
+    private _timeoutTotal;
+    private _perProviderInFlight;
+    private _perProviderTotal;
+    private _perProviderTimeout;
+    private _perProviderRateLimited;
+    private _providerCooldownUntil;
+    private _bump;
+    private _decrease;
+    private _bumpTotal;
+    private _bumpInFlight;
+    private _bumpRateLimitedTotal;
+    private _bumpTimeoutTotal;
+    bumpInFlightPerProvider(id: string): void;
+    decreaseInFlightPerProvider(id: string): void;
+    decreaseInFlight(): void;
+    bumpPerMethod(method: string): void;
+    bumpRateLimitedPerProvider(id: string): void;
+    bumpTimeoutPerProvider(id: string): void;
     bumpProviderTotal(id: string): void;
-    bumpProviderTimeout(id: string): void;
     timeoutRatio(id: string): number;
     isInCooldown(id: string): boolean;
     setCooldown(id: string, ms: number): void;
-    snapshot(): RpcStatsSnapshot;
+    snapshot(): Readonly<RpcStatsSnapshot>;
+}
+
+declare class Semaphore {
+    private readonly max;
+    private inUse;
+    private queue;
+    constructor(max: number);
+    acquire(): Promise<() => void>;
+    private release;
+}
+
+/**
+ * Instrumented StaticJsonRpcProvider.
+ * Tracks requests, inFlight count, rate limits, and per-method / per-provider metrics.
+ */
+declare class InstrumentedStaticJsonRpcProvider extends JsonRpcProvider {
+    private readonly stats;
+    private readonly limiter;
+    private readonly onEvent?;
+    readonly providerId: string;
+    readonly chainId: number;
+    constructor(url: string, chainId: number, providerId: string, stats: Stats, limiter: Semaphore, onEvent?: ((e: RpcEvent) => void) | undefined);
+    send(method: string, params: any): Promise<any>;
+    private _sendInstrumented;
 }
 
 interface Endpoint {
@@ -75,52 +100,36 @@ type RpcEvent = {
     code?: string;
     message: string;
 };
-declare function getHttpStatus(e: any): number | undefined;
-declare function isRateLimitError(e: any): boolean;
-declare function getRetryAfterMs(e: any): number | null;
-declare function isTimeoutError(e: any): boolean;
-/**
- * Wraps a promise with a timeout (useful when an RPC hangs without emitting TIMEOUT).
- * Important: this does not cancel the network request, but you get a controlled error
- * and FallbackProvider can switch to another RPC.
- */
-declare function withTimeout<T>(p: Promise<T>, ms: number, meta?: {
-    chainId?: number;
-    providerId?: string;
-    method?: string;
-}): Promise<T>;
-declare function shouldFailover(e: any): boolean;
-
-/**
- * Instrumented StaticJsonRpcProvider.
- * Tracks requests, inFlight count, rate limits, and per-method / per-provider metrics.
- */
-declare class InstrumentedStaticJsonRpcProvider extends JsonRpcProvider {
-    private readonly stats;
-    private readonly limiter;
-    private readonly onEvent?;
-    readonly providerId: string;
-    readonly chainId: number;
-    constructor(url: string, chainId: number, providerId: string, stats: RPCStats, limiter: Semaphore, onEvent?: ((e: RpcEvent) => void) | undefined);
-    send(method: string, params: any): Promise<any>;
-    private _sendInstrumented;
-}
 
-declare class RpcRouter {
+declare class Router {
     private readonly endpoints;
     private readonly stats;
     private rr;
-    constructor(endpoints: Endpoint[], stats: RPCStats);
+    constructor(endpoints: Endpoint[], stats: Stats);
     size(): number;
     pick(): Endpoint;
 }
 
-declare class LoadBalancedProvider extends JsonRpcProvider {
-    private readonly router;
-    private readonly _lbNetwork;
-    constructor(chainId: number, router: RpcRouter);
-    getNetwork(): Promise<Network>;
+interface RPCPoolProviderParams {
+    chainId: number;
+    urls: string[];
+    perUrl: {
+        inFlight: number;
+    };
+    retry: {
+        attempts: number;
+    };
+    hooks?: {
+        onEvent(e: RpcEvent): void;
+    };
+}
+declare class RPCPoolProvider extends JsonRpcProvider {
+    readonly router: Router;
+    readonly params: RPCPoolProviderParams;
+    readonly stats: Stats;
+    constructor(params: RPCPoolProviderParams);
     send(method: string, params: any): Promise<any>;
+    getStats(): Stats;
 }
 
-export { type Endpoint, InstrumentedStaticJsonRpcProvider, LoadBalancedProvider, RPCStats, type RpcEvent, RpcRouter, type RpcStatsSnapshot, Semaphore, getHttpStatus, getRetryAfterMs, isRateLimitError, isTimeoutError, shouldFailover, withTimeout };
+export { RPCPoolProvider };

package/dist/index.d.ts

@@ -1,44 +1,69 @@
-import { JsonRpcProvider, Network } from 'ethers';
-
-declare class Semaphore {
-    private readonly max;
-    private inUse;
-    private queue;
-    constructor(max: number);
-    acquire(): Promise<() => void>;
-    private release;
-}
+import { JsonRpcProvider } from 'ethers';
 
 interface RpcStatsSnapshot {
     total: number;
     inFlight: number;
-    perMethod: Record<string, number>;
+    perMethodTotal: Record<string, number>;
     rateLimitedTotal: number;
-    rateLimitedPerProvider: Record<string, number>;
+    perProviderRateLimited: Record<string, number>;
     timeoutTotal: number;
-    timeoutPerProvider: Record<string, number>;
+    perProviderTimeout: Record<string, number>;
     perProviderTotal: Record<string, number>;
-    perProviderTimeouts: Record<string, number>;
     providerCooldownUntil: Record<string, number>;
+    perProviderInFlight: Record<string, number>;
 }
-declare class RPCStats {
-    total: number;
-    inFlight: number;
-    perMethod: Record<string, number>;
-    rateLimitedTotal: number;
-    timeoutTotal: number;
-    timeoutPerProvider: Record<string, number>;
-    rateLimitedPerProvider: Record<string, number>;
-    perProviderTotal: Record<string, number>;
-    perProviderTimeouts: Record<string, number>;
-    providerCooldownUntil: Record<string, number>;
-    bump(map: Record<string, number>, key: string): void;
+declare class Stats {
+    private _total;
+    private _inFlight;
+    private _perMethod;
+    private _rateLimitedTotal;
+    private _timeoutTotal;
+    private _perProviderInFlight;
+    private _perProviderTotal;
+    private _perProviderTimeout;
+    private _perProviderRateLimited;
+    private _providerCooldownUntil;
+    private _bump;
+    private _decrease;
+    private _bumpTotal;
+    private _bumpInFlight;
+    private _bumpRateLimitedTotal;
+    private _bumpTimeoutTotal;
+    bumpInFlightPerProvider(id: string): void;
+    decreaseInFlightPerProvider(id: string): void;
+    decreaseInFlight(): void;
+    bumpPerMethod(method: string): void;
+    bumpRateLimitedPerProvider(id: string): void;
+    bumpTimeoutPerProvider(id: string): void;
     bumpProviderTotal(id: string): void;
-    bumpProviderTimeout(id: string): void;
     timeoutRatio(id: string): number;
     isInCooldown(id: string): boolean;
     setCooldown(id: string, ms: number): void;
-    snapshot(): RpcStatsSnapshot;
+    snapshot(): Readonly<RpcStatsSnapshot>;
+}
+
+declare class Semaphore {
+    private readonly max;
+    private inUse;
+    private queue;
+    constructor(max: number);
+    acquire(): Promise<() => void>;
+    private release;
+}
+
+/**
+ * Instrumented StaticJsonRpcProvider.
+ * Tracks requests, inFlight count, rate limits, and per-method / per-provider metrics.
+ */
+declare class InstrumentedStaticJsonRpcProvider extends JsonRpcProvider {
+    private readonly stats;
+    private readonly limiter;
+    private readonly onEvent?;
+    readonly providerId: string;
+    readonly chainId: number;
+    constructor(url: string, chainId: number, providerId: string, stats: Stats, limiter: Semaphore, onEvent?: ((e: RpcEvent) => void) | undefined);
+    send(method: string, params: any): Promise<any>;
+    private _sendInstrumented;
 }
 
 interface Endpoint {
@@ -75,52 +100,36 @@ type RpcEvent = {
     code?: string;
     message: string;
 };
-declare function getHttpStatus(e: any): number | undefined;
-declare function isRateLimitError(e: any): boolean;
-declare function getRetryAfterMs(e: any): number | null;
-declare function isTimeoutError(e: any): boolean;
-/**
- * Wraps a promise with a timeout (useful when an RPC hangs without emitting TIMEOUT).
- * Important: this does not cancel the network request, but you get a controlled error
- * and FallbackProvider can switch to another RPC.
- */
-declare function withTimeout<T>(p: Promise<T>, ms: number, meta?: {
-    chainId?: number;
-    providerId?: string;
-    method?: string;
-}): Promise<T>;
-declare function shouldFailover(e: any): boolean;
-
-/**
- * Instrumented StaticJsonRpcProvider.
- * Tracks requests, inFlight count, rate limits, and per-method / per-provider metrics.
- */
-declare class InstrumentedStaticJsonRpcProvider extends JsonRpcProvider {
-    private readonly stats;
-    private readonly limiter;
-    private readonly onEvent?;
-    readonly providerId: string;
-    readonly chainId: number;
-    constructor(url: string, chainId: number, providerId: string, stats: RPCStats, limiter: Semaphore, onEvent?: ((e: RpcEvent) => void) | undefined);
-    send(method: string, params: any): Promise<any>;
-    private _sendInstrumented;
-}
 
-declare class RpcRouter {
+declare class Router {
     private readonly endpoints;
     private readonly stats;
     private rr;
-    constructor(endpoints: Endpoint[], stats: RPCStats);
+    constructor(endpoints: Endpoint[], stats: Stats);
     size(): number;
     pick(): Endpoint;
 }
 
-declare class LoadBalancedProvider extends JsonRpcProvider {
-    private readonly router;
-    private readonly _lbNetwork;
-    constructor(chainId: number, router: RpcRouter);
-    getNetwork(): Promise<Network>;
+interface RPCPoolProviderParams {
+    chainId: number;
+    urls: string[];
+    perUrl: {
+        inFlight: number;
+    };
+    retry: {
+        attempts: number;
+    };
+    hooks?: {
+        onEvent(e: RpcEvent): void;
+    };
+}
+declare class RPCPoolProvider extends JsonRpcProvider {
+    readonly router: Router;
+    readonly params: RPCPoolProviderParams;
+    readonly stats: Stats;
+    constructor(params: RPCPoolProviderParams);
     send(method: string, params: any): Promise<any>;
+    getStats(): Stats;
 }
 
-export { type Endpoint, InstrumentedStaticJsonRpcProvider, LoadBalancedProvider, RPCStats, type RpcEvent, RpcRouter, type RpcStatsSnapshot, Semaphore, getHttpStatus, getRetryAfterMs, isRateLimitError, isTimeoutError, shouldFailover, withTimeout };
+export { RPCPoolProvider };