Skip to main content

isSyncing

Callable

  • isSyncing(web3Context: Web3Context<EthExecutionAPI, any>): Promise<SyncingStatusAPI>

  • Checks if the node is currently syncing.


    Parameters

    • web3Context: Web3Context<EthExecutionAPI, any>

      (Web3Context) Web3 configuration object that contains things such as the provider, request manager, wallet, etc.

    Returns Promise<SyncingStatusAPI>

    Either a SyncingStatusAPI, or false.

    web3.eth.isSyncing().then(console.log);
    > {
    startingBlock: 100,
    currentBlock: 312,
    highestBlock: 512,
    knownStates: 234566,
    pulledStates: 123455
    }