Giter Club home page Giter Club logo

eth-block-tracker's Introduction

eth-block-tracker

This module walks the Ethereum blockchain, keeping track of the latest block. It uses a web3 provider as a data source and will continuously poll for the next block.

const HttpProvider = require('ethjs-provider-http')
const BlockTracker = require('eth-block-tracker')

const provider = new HttpProvider('https://mainnet.infura.io')
const blockTracker = new BlockTracker({ provider })
blockTracker.on('block', console.log)
blockTracker.start()

methods

new BlockTracker({ provider, pollingInterval })

creates a new block tracker with provider as a data source and pollingInterval (ms) timeout between polling for the latest block.

getCurrentBlock()

synchronous returns the current block. may be null.

console.log(blockTracker.getCurrentBlock())
start({ fromBlock })

Start walking from the fromBlock (default: 'latest') forward. fromBlock should be a number as a hex encoded string.

blockTracker.start()
blockTracker.start({ fromBlock: '0x00' })
stop()

Stop walking the blockchain.

blockTracker.stop()

EVENTS

block

The block event is emitted for every block in order. Use this event if you want to operate on every block without missing any.

blockTracker.on('block', (newBlock) => console.log(newBlock))
latest

The latest event is emitted for every that is detected to be the latest block. This means skipping a block if there were two created since the last polling period. Use this event if you don't care about stale blocks.

blockTracker.on('latest', (newBlock) => console.log(newBlock))
sync

The sync event is emitted the same as "latest" but includes the previous block.

blockTracker.on('sync', ({ newBlock, oldBlock }) => console.log(newBlock, oldBlock))

NOTES

Does not currently handle forks.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.