web3-eth/lib/commonjs/web3_subscriptions.d.ts

Web3 module to interact with the Ethereum blockchain and smart contracts.

import { SyncOutput, Address, BlockNumberOrTag, HexString, Topic, BlockHeaderOutput, LogsOutput } from 'web3-types';
import { Web3Subscription } from 'web3-core';
/**
 * ## subscribe('logs')
 * Subscribes to incoming logs, filtered by the given options. If a valid numerical fromBlock options property is set, web3.js will retrieve logs beginning from this point, backfilling the response as necessary.
 *
 * You can subscribe to logs matching a given filter object, which can take the following parameters:
 * - `fromBlock`: (optional, default: 'latest') Integer block number, or `'latest'` for the last mined block or `'pending'`, `'earliest'` for not yet mined transactions.
 * - `address`: (optional) Contract address or a list of addresses from which logs should originate.
 * - `topics`: (optional) Array of 32 Bytes DATA topics. Topics are order-dependent. Each topic can also be an array of DATA with `or` options.
 *
 */
export declare class LogsSubscription extends Web3Subscription<{
    data: LogsOutput;
}, {
    readonly fromBlock?: BlockNumberOrTag;
    readonly address?: Address | Address[];
    readonly topics?: Topic[];
}> {
    protected _buildSubscriptionParams(): (string | {
        readonly fromBlock?: BlockNumberOrTag;
        readonly address?: Address | Address[];
        readonly topics?: Topic[];
    })[];
    protected formatSubscriptionResult(data: LogsOutput): {
        readonly id?: string | undefined;
        readonly removed: boolean;
        readonly logIndex?: string | number | bigint | undefined;
        readonly transactionIndex?: string | number | bigint | undefined;
        readonly transactionHash?: import("web3-types").HexString32Bytes | undefined;
        readonly blockHash?: import("web3-types").HexString32Bytes | undefined;
        readonly blockNumber?: string | number | bigint | undefined;
        readonly address: string;
        readonly topics: HexString[];
        readonly data: HexString;
    };
}
/**
 * ## subscribe('pendingTransactions')
 * Subscribes to incoming pending transactions.
 *
 * You can subscribe to pending transactions by calling web3.eth.subscribe('pendingTransactions').
 * @example
 * ```ts
 * (await web3.eth.subscribe('pendingTransactions')).on('data', console.log);
 * ```
 */
export declare class NewPendingTransactionsSubscription extends Web3Subscription<{
    data: HexString;
}> {
    protected _buildSubscriptionParams(): string[];
    protected formatSubscriptionResult(data: string): string;
}
/**
 * ## subscribe('newHeads') ( same as subscribe('newBlockHeaders'))
 *
 * Subscribes to incoming block headers. This can be used as timer to check for changes on the blockchain.
 *
 * The structure of a returned block header is {@link BlockHeaderOutput}:
 * @example
 * ```ts
 * (await web3.eth.subscribe('newHeads')).on( // 'newBlockHeaders' would work as well
 *  'data',
 * console.log
 * );
 * >{
 * parentHash: '0x9e746a1d906b299def98c75b06f714d62dacadd567c7515d76eeaa8c8074c738',
 * sha3Uncles: '0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347',
 * miner: '0x0000000000000000000000000000000000000000',
 * stateRoot: '0xe0f04b04861ecfa95e82a9310d6a7ef7aef8d7417f5209c182582bfb98a8e307',
 * transactionsRoot: '0x31ab4ea571a9e10d3a19aaed07d190595b1dfa34e03960c04293fec565dea536',
 * logsBloom: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
 * difficulty: 2n,
 * number: 21n,
 * gasLimit: 11738125n,
 * gasUsed: 830006n,
 * timestamp: 1678797237n,
 * extraData: '0xd883010b02846765746888676f312e32302e31856c696e757800000000000000e0a6e93cf40e2e71a72e493272210c3f43738ccc7e7d7b14ffd51833797d896c09117e8dc4fbcbc969bd21b42e5af3e276a911524038c001b2109b63b8e0352601',
 * nonce: 0n
 * }
 * ```
 */
export declare class NewHeadsSubscription extends Web3Subscription<{
    data: BlockHeaderOutput;
}> {
    protected _buildSubscriptionParams(): string[];
    protected formatSubscriptionResult(data: BlockHeaderOutput): BlockHeaderOutput;
}
/**
 * ## subscribe('syncing')
 *
 * Subscribe to syncing events. This will return `true` when the node is syncing and when it’s finished syncing will return `false`, for the `changed` event.
 * @example
 * ```ts
 * (await web3.eth.subscribe('syncing')).on('changed', console.log);
 * > `true` // when syncing
 *
 * (await web3.eth.subscribe('syncing')).on('data', console.log);
 * > {
 *      startingBlock: 0,
 *      currentBlock: 0,
 *      highestBlock: 0,
 *      pulledStates: 0,
 *      knownStates: 0
 *   }
 * ```
 */
export declare class SyncingSubscription extends Web3Subscription<{
    data: SyncOutput;
    changed: boolean;
}> {
    protected _buildSubscriptionParams(): string[];
    _processSubscriptionResult(data: {
        syncing: boolean;
        status: SyncOutput;
    } | boolean): void;
}