0xweb/dequanto/src/clients/Web3Client.ts

Contract package manager and other web3 tools

import di from 'a-di';
import memd from 'memd';

import type { TAbiItem } from '@dequanto/types/TAbi';
import type { TPlatform } from '@dequanto/models/TPlatform';

import type { IWeb3Client, IWeb3ClientOptions } from './interfaces/IWeb3Client';

import { ClientPool, IRpcConfig, IPoolWeb3Request, WClient } from './ClientPool';
import { BlockDateResolver } from '@dequanto/blocks/BlockDateResolver';
import { $number } from '@dequanto/utils/$number';

import { $logger } from '@dequanto/utils/$logger';
import { ClientEventsStream } from './ClientEventsStream';
import { $abiUtils } from '@dequanto/utils/$abiUtils';
import { ClientDebugMethods } from './debug/ClientDebugMethods';
import { $require } from '@dequanto/utils/$require';
import { $is } from '@dequanto/utils/$is';
import { $hex } from '@dequanto/utils/$hex';

import { $bigint } from '@dequanto/utils/$bigint';

import { RpcContract, TRpcContractCall } from '@dequanto/rpc/RpcContract';
import { RpcLogFilterOptions, RpcSubscription } from '@dequanto/rpc/RpcSubscription';
import { TEth } from '@dequanto/models/TEth';

import { PromiseEvent } from '@dequanto/class/PromiseEvent';
import { Rpc, RpcTypes } from '@dequanto/rpc/Rpc';
import { TRpc } from '@dequanto/rpc/RpcBase';
import { $sig } from '@dequanto/utils/$sig';
import { DataLike } from '@dequanto/utils/types';
import { ErrorCode } from './ClientPoolStats';
import { $date } from '@dequanto/utils/$date';
import { WalletClient } from './WalletClient';

export abstract class Web3Client implements IWeb3Client {

    public TIMEOUT = 3 * 60 * 1000;

    abstract platform: TPlatform;
    abstract chainId: number;
    abstract chainToken: string;
    abstract defaultGasLimit: number;


    // Hardhat network could be launched in forking mode
    forked?: {
        platform: TPlatform;
        block?: number;
    }

    defaultTxType: 0 | 1 | 2 = 2;
    defaultGasPriceRatio = 1.4;

    // block time in ms
    blockTimeAvg = 12_000;

    get network (): TPlatform {
        return this.forked?.platform ?? this.platform;
    }

    public options: IWeb3ClientOptions;
    public pool: ClientPool;
    public debug: ClientDebugMethods;
    public wallet = di.resolve(WalletClient);

    constructor(options: IWeb3ClientOptions)
    constructor(endpoints: IRpcConfig[])
    constructor(mix: IWeb3ClientOptions | IRpcConfig[]) {
        if (Array.isArray(mix)) {
            this.options = { endpoints: mix }
        } else if (mix != null) {
            this.options = mix;
        }

        if (this.options.endpoints == null && this.options.web3 == null) {
            console.dir(this.options, { depth: null });
            throw new Error(`Neither Node endpoints nor web3 instance provided`);
        }
        this.pool = new ClientPool(this.options);
        this.debug = new ClientDebugMethods(this, this.options.debug);
        if (this.options.defaultTxType != null) {
            this.defaultTxType = this.options.defaultTxType;
        }
        if (this.options.defaultGasPriceRatio != null) {
            this.defaultGasPriceRatio = this.options.defaultGasPriceRatio;
        }
        if (this.options.blockTimeAvg != null) {
            this.blockTimeAvg = this.options.blockTimeAvg;
        }
    }

    async request<TResult = any>(req: TRpc.IRpcAction): Promise<TResult> {
        return this.with (async wClient => {
            return wClient.rpc.request<TResult>(req);
        });
    }

    async batch(requests: TRpc.IRpcAction[]): Promise<any[]> {
        return this.with (async web3 => {
            return web3.callBatched(requests);
        });
    }

    getEventStream(address: TEth.Address, abi: TAbiItem[], event: string) {
        let eventAbi = abi.find(x => x.type === 'event' && x.name === event);
        if (eventAbi == null) {
            let events = abi.filter(x => x.type === 'event').map(x => x.name).join(', ');
            throw new Error(`Event "${event}" not present in ABI. Events: ${events}`);
        }
        let stream = new ClientEventsStream(address, eventAbi);
        this
            .subscribe('logs', {
                address: address,
                topics: [
                    $abiUtils.getMethodHash(eventAbi)
                ]
            })
            .then(subscription => {
                stream.fromSubscription(subscription);
            }, error => {
                stream.error(error);
            });

        return stream;
    }

    with<TResult>(fn: (wClient: WClient) => Promise<TResult>) {
        return this.pool.call(fn);
    }

    async getWeb3(options?: IPoolWeb3Request) {
        throw new Error(`To get the web3 initialize the Web3 compatibility class ('compatibility/Web3.ts') instead`)
    }
    async getRpc(options?: IPoolWeb3Request): Promise<Rpc> {
        return await this.pool.getRpc(options);
    }
    async getNodeURL(options?: IPoolWeb3Request) {
        return await this.pool.getNodeURL(options);
    }

    subscribe(
        type: 'logs',
        options: RpcLogFilterOptions,
        callback?: (error: Error, log: TEth.Log) => void
    ): Promise<RpcSubscription<TEth.Log>>;
    subscribe(
        type: 'newHeads' | 'newBlockHeaders' /* web3 compat */,
        callback?: (error: Error, blockHeader: TEth.Block) => void
    ): Promise<RpcSubscription<TEth.Block>>;
    subscribe(
        type: 'newPendingTransactions' | 'pendingTransactions' /* web3 compat */,
        callback?: (error: Error, transactionHash: TEth.Hex) => void
    ): Promise<RpcSubscription<TEth.Hex>>;
    async subscribe(type, ...params): Promise<RpcSubscription<any>> {
        let wClient = await this.pool.getWrappedWeb3({ ws: true });
        await wClient.ensureConnected();
        switch (type) {
            case 'newBlockHeaders':
                type = 'newHeads';
                break;
            case 'pendingTransactions':
                type = 'newPendingTransactions';
                break;
        }

        let cb: Function;
        if (typeof params[params.length - 1] === 'function') {
            cb = params[params.length - 1];
            params.splice(params.length - 1, 1);
        }

        let subscription = await wClient.rpc.eth_subscribe(type, ...(params as []));
        if (cb != null) {
            subscription.subscribe(
                (value) => cb(null, value),
                (error) => cb(error)
            );
        }
        return subscription;
    }

    async readContract(req: TRpcContractCall) {
        let reader = new RpcContract(this);
        let result = await reader.request(req)
        return result;
    }

    async readContractBatch(requests: TRpcContractCall[]) {
        let reader = new RpcContract(this);
        let result = await reader.batch(requests);
        return result;
    }


    getBalance(address: TEth.Address, blockNumber: DataLike<RpcTypes.BlockNumberOrTagOrHash> = 'latest'): Promise<bigint> {
        return this.pool.call(async web3 => {
            let wei = await web3.rpc.eth_getBalance(address, blockNumber);
            return wei;
        });
    }
    getBalances(addresses: TEth.Address[], blockNumber: DataLike<RpcTypes.BlockNumberOrTagOrHash> = 'latest'): Promise<bigint[]> {
        return this.pool.call(async web3 => {
            let rpc = web3.rpc;
            let requests = addresses.map(address => {
                return rpc.req.eth_getBalance(address, blockNumber);
            });
            return rpc.batch(requests);

        }, { batchRequestCount: addresses.length });
    }
    getTransactionCount(address: TEth.Address, blockNumber: DataLike<RpcTypes.BlockNumberOrTagOrHash> = 'latest') {
        return this.pool.call(wClient => {
            return wClient.rpc.eth_getTransactionCount(address, blockNumber ?? 'latest');
        });
    }
    isSyncing() {
        return this.pool.call(web3 => {
            return web3.rpc.eth_syncing();
        });
    }
    getTransaction(txHash: TEth.Hex, opts?: IPoolWeb3Request): Promise<TEth.Tx> {
        return this.pool.call(web3 => {
            return web3.rpc.eth_getTransactionByHash(txHash);
        }, opts);
    }
    getTransactions(txHashes: TEth.Hex[], opts?: IPoolWeb3Request): Promise<TEth.Tx[]> {
        return this.pool.call(async web3 => {
            let rpc = web3.rpc;
            let requests = txHashes.map(hash => {
                return rpc.req.eth_getTransactionByHash(hash);
            });
            return web3.callBatched(requests);
        }, {
            ...(opts ?? {}),
            batchRequestCount: txHashes.length
        });
    }
    getTransactionReceipt(txHash: TEth.Hex): Promise<TEth.TxReceipt> {
        return this.pool.call(web3 => {
            return web3.rpc.eth_getTransactionReceipt(txHash);
        });
    }
    getTransactionReceipts(hashes: TEth.Hex[]): Promise<TEth.TxReceipt[]> {
        return this.pool.call(async web3 => {
            let rpc = web3.rpc;
            let requests = hashes.map(hash => {
                return rpc.req.eth_getTransactionReceipt(hash);
            });
            return web3.callBatched(requests);
        }, { batchRequestCount: hashes.length });
    }
    getTransactionTrace(hash: string) {
        return this.pool.call(async web3 => {
            let rpc = web3.rpc;

            if (typeof rpc.fns.traceTransaction !== 'function') {
                rpc.extend([{
                    name: 'traceTransaction',
                    call: 'debug_traceTransaction',
                }])
            }

            let result = await rpc.fns.traceTransaction(hash);
            return result;

        }, {
            node: {
                traceable: true
            }
        });
    }
    getBlock(nr: number | "earliest" | "latest" | "pending" | "safe" | "finalized"): Promise<TEth.Block> {
        return this.pool.call(web3 => {
            let mix = typeof nr === 'number' ? $hex.ensure(nr) : nr;
            return web3.rpc.eth_getBlockByNumber(mix, false);
        });
    }
    getBlocks(nrs: number[]): Promise<TEth.Block<TEth.Hex>[]> {
        return this.pool.call(async web3 => {
            let rpc = web3.rpc;
            let requests = nrs.map(nr => {
                return rpc.req.eth_getBlockByNumber($hex.ensure(nr), false);
            });
            return web3.callBatched(requests);
        }, {
            batchRequestCount: nrs.length
        });
    }
    getCode(address: TEth.Address) {
        return this.pool.call(async web3 => {
            let code = await web3.rpc.eth_getCode(address, 'latest');
            if ($hex.isEmpty(code)) {
                return null;
            }
            return code;
        })
    }
    getPendingTransactions() {
        return this.pool.call(web3 => {
            return web3.rpc.eth_pendingTransactions();
        });
    }
    getPoolStatus(): Promise<{ baseFee: bigint, pending: number, queued: number }> {
        return this.pool.call(async web3 => {
            let rpc = web3.rpc;
            if (rpc.fns.txpool_status == null) {
                rpc.extend([{
                    name: 'txpool_content',
                    call: 'txpool_content'
                }, {
                    name: 'txpool_inspect',
                    call: 'txpool_inspect'
                }, {
                    name: 'txpool_status',
                    call: 'txpool_status'
                }]);
            }
            let status = await rpc.fns.txpool_status();
            return {
                baseFee: BigInt(status.baseFee),
                pending: Number(status.pending),
                queued: Number(status.queued),
            }
        });
    }
    getStorageAt(address: TEth.Address, position: number | bigint | TEth.Hex, blockNumber: DataLike<RpcTypes.BlockNumberOrTagOrHash> = 'latest') {
        return this.pool.call(web3 => {
            return web3.rpc.eth_getStorageAt(address, <any>position, blockNumber);
        });
    }
    getStorageAtBatched(address: TEth.Address, slots: (string | number | bigint)[], blockNumber: DataLike<RpcTypes.BlockNumberOrTagOrHash> = 'latest') {
        return this.pool.callBatched({
            async requests(rpc) {
                return slots.map(storageSlot => ({
                    address,
                    ...rpc.req.eth_getStorageAt(address, BigInt(storageSlot), blockNumber)
                }));
            }
        });
    }
    getGasPrice(): Promise<{ price: bigint, base?: bigint, priority?: bigint }> {
        return this.pool.call(async wClient => {
            let price = await wClient.rpc.eth_gasPrice();
            return { price };
        });
    }
    getGasPriorityFee(): Promise<bigint> {
        return this.pool.call(async wClient => {
            let priority = await wClient.rpc.eth_maxPriorityFeePerGas();
            return priority;
        });
    }
    getGasEstimation(from: TEth.Address, tx: TEth.TxLike) {
        let data = $hex.ensure(tx.data ?? tx.input);
        $require.notNull(data, `Expects the bytecode to estimate the gas for`, tx);
        if ($is.Address(tx.to) === false && data.includes('60806040') === false) {
            throw new Error(`"To" address is undefined, but the bytecode is not the contract creation ${data}`);
        }
        return this.pool.call(async web3 => {
            let txData = {
                from: from,
                to: tx.to,
                data: data,
                value: $hex.ensure(tx.value ?? '0x0'),
                //nonce: $hex.ensure(tx.nonce),
            };
            let rpc = web3.rpc;
            let gasAmount = await rpc.eth_estimateGas(txData);
            return gasAmount;
        })
    }
    async getAccounts(options?: IPoolWeb3Request): Promise<TEth.Address[]> {
        let rpc = await this.getRpc(options);
        return rpc.eth_accounts();
    }
    async getChainId(options?: IPoolWeb3Request): Promise<number> {
        let rpc = await this.getRpc(options);
        return rpc.eth_chainId();
    }

    async switchChain(params: { chainId: number | string }, options: IPoolWeb3Request): Promise<void> {
        let rpc = await this.getRpc(options);
        await rpc.wallet_switchEthereumChain({ chainId: $hex.ensure(params.chainId) });
    }

    sendSignedTransaction(signedTxBuffer: TEth.Hex): PromiseEvent<TEth.TxReceipt> {
        return this.pool.callPromiEvent(wClient => {
            return wClient.sendSignedTransaction(signedTxBuffer);
        }, { preferSafe: true, distinct: true });
    }

    // async signTx(txData: TEth.TxLike, privateKey: TEth.Hex): Promise<string> {
    //     let rpc = await this.getRpc();
    //     let sig = await $sig.signTx( txData, { key: privateKey }, rpc);
    //     let tx = $sig.TxSerializer.serialize(txData, sig);
    //     return tx;
    // }

    async sign(address: TEth.Address, message: string): Promise<string> {
        if (this.wallet.isConnected(address)) {
            return this.wallet.eth_sign(address, message);
        }
        return this.pool.call(wClient => {
            return wClient.sign(address, message);
        }, {
            wallet: true
        });
    }

    signTypedData(address: TEth.Address, typedData: DataLike<RpcTypes.TypedData>): Promise<TEth.Hex> {
        if (this.wallet.isConnected(address)) {
            return this.wallet.eth_signTypedData_v4(address, typedData);
        }
        return this.pool.call(wClient => {
            return wClient.signTypedData(address, typedData);
        }, {
            wallet: true
        });
    }

    sendTransaction(data: TEth.TxLike): PromiseEvent<TEth.TxReceipt> {
        if (this.wallet.isConnected(data.from)) {
            return this.pool.wrappedPromiEvent <TEth.TxReceipt> (async () => {
                let client = await this.wallet.getClientFor(this.chainId);
                return client.sendTransaction(data);
            });
        }
        return this.pool.callPromiEvent(wClient => {
            return wClient.sendTransaction(data);
        }, {
            preferSafe: true,
            distinct: true,
            wallet: this.platform === 'hardhat' ? void 0 : true
        });
    }

    getBlockNumber() {
        return this.pool.call(wClient => {
            return wClient.rpc.eth_blockNumber();
        });
    }

    call(tx: TEth.TxLike): Promise<any> {
        for (let key in tx) {
            let val = tx[key];
            switch (typeof val) {
                case 'number':
                    tx[key] = $number.toHex(val);
                    break;
                case 'bigint':
                    tx[key] = $bigint.toHex(val);
                    break;
            }
        }
        if (tx.input != null) {
            /** eth_call expects 'data' property, not the 'input' as in Transaction */
            tx.data = tx.input;
            delete tx.input;
        }
        return this.pool.call(async wClient => {
            return await wClient.rpc.eth_call(tx as TEth.Tx, 'latest');
        });
    }

    @memd.deco.memoize({ perInstance: true, maxAge: 30 })
    getBlockNumberCached() {
        return this.pool.call(wClient => {
            return wClient.rpc.eth_blockNumber();
        });
    }

    async getPastLogs(filter: RpcTypes.Filter, options?: {
        /**
         * For large block ranges and huge amounts of logs, streaming should be used, we pass the loaded logs in batches direct to onProgress
         * and do not aggregate to a final logs array to prevent memory issues.
         */
        streamed?: boolean
        /**
         * Override the default block range limits for all underlying RPC clients, otherwise the config will be used or
         * the RPC exception will be parsed.
         */
        blockRangeLimits?: WClient['blockRangeLimits']

        /**
         * When loading in batches the cb will be called with fetched and parsed logs on each iteration
         */
        onProgress? (info: TLogsRangeProgress<TEth.Log>): void
    }): Promise<TEth.Log[]> {

        if (options?.blockRangeLimits?.blocks != null) {
            this.pool.MINIMUM_BLOCK_RANGE = Math.min(this.pool.MINIMUM_BLOCK_RANGE, options.blockRangeLimits.blocks);
        }

        // ensure numbers, bigints, bools are in HEX
        filter.topics = filter.topics?.map(mix => {
            if (mix != null && Array.isArray(mix) === false) {
                return $hex.ensure(mix as any)
            }
            return mix;
        });

        // ensure all topics are in 32-byte
        filter.topics = filter.topics?.map(topic => {
            if (typeof topic === 'string' && topic.startsWith('0x')) {
                return $hex.padBytes(topic, 32);
            }
            return topic;
        });
        let MAX = this.pool.getOptionForFetchableRange(options?.blockRangeLimits);
        let [fromBlock, toBlockExcluded] = await Promise.all([
            Blocks.getBlock(this, filter.fromBlock, 0),
            Blocks.getBlock(this, filter.toBlock, 'latest'),
        ]);

        let toBlock = toBlockExcluded + 1;

        let logs = await RangeWorker.fetchWithLimits(this, filter, {
            maxBlockRange: MAX,
            maxResultCount: null,
        }, {
            fromBlock,
            toBlock
        }, {
            streamed: options?.streamed,
            onProgress: options?.onProgress
        });

        let removedLogs = logs?.filter(x => x.removed === true);
        if (removedLogs?.length > 0) {
            console.error(`Caution: There are ${removedLogs.length} removed Logs. But @dequanto didn't handle this as they are not expected to be present in past logs.`);
        }

        return logs;
    }

    getNodeInfos(options?: {
        timeout?: number
        calls?: ('net_peerCount' | 'eth_blockNumber' | 'eth_syncing' | 'net_version')[]
    }) {
        return this.pool.getNodeInfos(options);
    }
    getNodeStats() {
        return this.pool.getNodeStats();
    }

    static url<T extends Web3Client>(options: IWeb3ClientOptions)
    static url<T extends Web3Client>(endpoints: IRpcConfig[], opts?: Partial<IWeb3ClientOptions>)
    static url<T extends Web3Client>(url: string, opts?: Partial<IWeb3ClientOptions>): T
    static url<T extends Web3Client>(mix: IWeb3ClientOptions | IRpcConfig[] | string, opts?: Partial<IWeb3ClientOptions>): T {
        const Ctor: any = this;
        let options: IWeb3ClientOptions;
        if (typeof mix === 'string') {
            options = { endpoints: [{ url: mix }] }
        } else if (Array.isArray(mix)) {
            options = { endpoints: mix }
        } else {
            options = mix;
        }
        const param = {
            ...options,
            ...(opts ?? {})
        };
        return new Ctor(param);
    }
}

export type TLogsRangeProgress<TLogParsed> = {
    logs: TLogParsed[]

    /** @deprecated Use logs for current logs buffer */
    paged: TLogParsed[]
    latestBlock: number
    blocks: {
        total: number
        loaded: number
    }
    blocksPerSecond: number
    timeLeftSeconds: number
    completed: boolean
}

namespace RangeWorker {



    export async function fetchWithLimits(
        client: Web3Client,
        filter: RpcTypes.Filter,
        limits: { maxBlockRange?: number, maxResultCount?: number },
        ranges: { fromBlock: number, toBlock: number },
        options?: {
            streamed?: boolean
            onProgress? (info: TLogsRangeProgress<TEth.Log>)
        }
    ) {
        let { fromBlock, toBlock } = ranges;

        $require.Number(fromBlock, `FromBlock must be a number`);
        $require.Number(toBlock, `ToBlock must be a number`);
        if (options?.streamed) {
            $require.Function(options.onProgress, `onProgress must be a function when streaming past logs`);
        }

        let range = toBlock - fromBlock;
        let logs = options?.streamed ? null : [];
        let cursor = fromBlock;
        let perf = {
            start: Date.now(),
            blocks: {
                total: range,
                loaded: 0,
            }
        };
        let nodeStats = Date.now();
        let loadedCount = 0;
        while (cursor < toBlock) {

            let paged = await fetchPaged(client, filter, {
                fromBlock: cursor,
                toBlock: toBlock,
            }, limits);

            if (logs != null) {
                logs.push(...paged.result);
            }

            cursor += paged.range.count;
            loadedCount += paged.result.length;

            perf.blocks.loaded += paged.range.count;
            let now = Date.now();
            let blocksPerSec = perf.blocks.loaded / ((now - perf.start) / 1000);
            let blocksPerSecFormatted = blocksPerSec.toFixed(2);
            let leftSeconds = (toBlock - cursor) / blocksPerSec;
            let leftTimeFormatted = $date.formatTimespan(leftSeconds * 1000);


            let strLatestRange = `Latest range: ${paged.range.count}.`;
            let strBlocksWalked = `Blocks walked: ${perf.blocks.loaded}(${paged.range.fromBlock}-${paged.range.toBlock})/${perf.blocks.total}.`;
            let strBPS = `b/s: ${blocksPerSecFormatted}.`;
            let strEstimated = leftTimeFormatted ? `~${leftTimeFormatted}.` : '';
            let strLoaded = `∑: ${loadedCount}. Current: ${paged.result.length}`;
            $logger.log(`${strBlocksWalked} ${strLatestRange} ${strBPS} ${strEstimated} ${strLoaded}`);

            await options?.onProgress?.({
                logs: logs,
                paged: paged.result as RpcTypes.Log[],
                latestBlock: paged.range.toBlock,
                blocks: perf.blocks,
                blocksPerSecond: Number(blocksPerSecFormatted),
                timeLeftSeconds: leftSeconds,
                completed: cursor >= toBlock
            });

            let lastNodeStats = Date.now() - nodeStats;
            if (lastNodeStats > 30 * 1000) {
                nodeStats = Date.now();

                let stats = client.getNodeStats();
                stats.forEach(stat => {
                    $logger.log(`bold<${stat.url}> green<${stat.success}> red<${stat.fail}> cyan<${Math.ceil(stat.ping)}ms>`);
                });
            }
        }
        return logs;

    };


    async function fetchPaged(
        client: Web3Client,
        filter: RpcTypes.Filter,
        range: { fromBlock: number, toBlock: number },
        knownLimits: { maxBlockRange?: number, maxResultCount?: number }
    ): Promise<{
        result: RpcTypes.FilterResults
        range: {
            fromBlock: number
            toBlock: number
            count: number
        }
    }> {

        let currentWClient: WClient;
        let blockRange = range.toBlock - range.fromBlock;
        try {

            let result = await client.pool.call(async (wClient) => {

                currentWClient = wClient;
                blockRange = Math.min(
                    blockRange,
                    currentWClient.blockRangeLimits.blocks ?? Infinity,
                    knownLimits?.maxBlockRange ?? Infinity,
                );

                let fromBlock = range.fromBlock;
                let toBlockExcluded = fromBlock + blockRange - 1;

                let { result, error } = await LogsFetcher.fetch(wClient, fromBlock, toBlockExcluded, blockRange, filter);
                if (error != null) {
                    throw error;
                }
                return result;
            }, {
                blockRangeCount: blockRange,
                method: 'eth_getLogs',
            });
            return {
                result: result.paged,
                range: {
                    fromBlock: result.fromBlock,
                    toBlock: result.toBlockExcluded,
                    count: result.blockRange
                }
            };
        } catch (error) {
            if (error.code === ErrorCode.NO_LIVE_CLIENT) {
                throw error;
            }

            /**
             * query returned more than 10000 results
             */
            $logger.log(`Range worker request: ${range.fromBlock}-${range.toBlock}. ${error.message.trim()}. Current range: ${ blockRange }`);

            let matchCountLimit = /(?<count>\d+) results/.exec(error.message);
            if (matchCountLimit) {
                let count = Number(matchCountLimit.groups.count);
                let newRange = Math.floor(blockRange * 0.8);
                currentWClient.updateBlockRangeInfo({
                    blocks: newRange,
                    results: count,
                });
                return fetchPaged(client, filter, range, knownLimits);
            }

            let maxRangeMatch = /\b(?<maxRange>\d{2,})\b/.exec(error.message)?.groups?.maxRange;
            if (maxRangeMatch && knownLimits.maxBlockRange == null) {
                // handle unknown range, otherwise throw
                let rangeLimit = Number(maxRangeMatch);
                let currentRangeLimit = currentWClient.blockRangeLimits.blocks;
                if (currentRangeLimit <= rangeLimit) {
                    rangeLimit = Math.floor(currentRangeLimit * .9);
                }

                currentWClient.updateBlockRangeInfo({ blocks: rangeLimit });
                return fetchPaged(client, filter, range, knownLimits);
            }
            if (/\b(range|limit)\b/.test(error.message)) {
                // Generic "block range is too wide", "limit exceeded",
                let newRange = Math.floor(blockRange * 0.8);
                currentWClient.updateBlockRangeInfo({
                    blocks: newRange
                });
                return fetchPaged(client, filter, range, knownLimits);
            }

            currentWClient.updateBlockRangeInfo({
                blocks: 0
            });
            return fetchPaged(client, filter, range, knownLimits);
        }
    }
}

namespace LogsFetcher {
    export async function fetch (client: WClient, fromBlock: number, toBlockExcluded: number, blockRange: number, filter: RpcTypes.Filter) {

        const MAX_RESULTS = client.blockRangeLimits?.results ?? 10_000;
        return await client.call(async wClient => {
            let arr = await wClient.rpc.eth_getLogs({
                ...filter,
                fromBlock: $hex.ensure(fromBlock),
                toBlock: $hex.ensure(toBlockExcluded),
            }) as RpcTypes.Log[];
            if (arr.length > 0 && arr.length % MAX_RESULTS === 0) {
                $logger.log(`Too many results: ${arr.length} at block ${fromBlock} to ${toBlockExcluded}. Fetching sub-ranges.`);
                let lastBlock = arr[arr.length - 1].blockNumber;

                let { result } = await fetch (client, lastBlock, toBlockExcluded, blockRange, filter);

                // The sub-range query includes the last block, as some results might be skipped that are in the same block.
                arr = arr.filter(x => x.blockNumber !== lastBlock);
                arr = arr.concat(result.paged);
            }
            return {
                paged: arr,
                fromBlock,
                toBlockExcluded: toBlockExcluded,
                blockRange
            }
        });
    }
}

namespace Blocks {
    export async function getBlock(client: Web3Client, block: string | bigint | number | Date, $default: string | number): Promise<number> {
        if (block == null) {
            return await getBlockNumber(client, $default);
        }
        if (block instanceof Date) {
            let resolver = di.resolve(BlockDateResolver, client);
            return resolver.getBlockNumberFor(block);
        }
        return await getBlockNumber(client, block);
    };
    export async function getBlockNumber(client: Web3Client, block: number | string | bigint) {
        if (typeof block === 'number') {
            return block;
        }
        if (typeof block === 'bigint') {
            return Number(block);
        }
        if (block == null || block === 'latest') {
            let nr = await client.getBlockNumber();
            return Number(nr);
        }
        if (block.startsWith('0x')) {
            return Number(block);
        }
        throw new Error(`Invalid block number`);
    };
}