block-by-date-ethers

Ethereum Block By Date

Get Ethereum block number by a given date. Or blocks by a given period duration. Works with any Ethereum based mainnet or testnet networks.

Installation

Use npm:

npm i block-by-date-ethers

Or Yarn:

yarn add block-by-date-ethers

Usage

const EthDater = require('block-by-date-ethers');

const dater = new EthDater(
    provider // ethers provider, required.
);

// Getting block by date:
let block = await dater.getDate(
    '2016-07-20T13:20:40Z', // Date, required. Any valid moment.js value: string, milliseconds, Date() object, moment() object.
    true // Block after, optional. Search for the nearest block before or after the given date. By default true.
);

/* Returns an object: {
    date: '2016-07-20T13:20:40Z', // searched date
    block: 1920000 // block number
} */

// Getting block by period duration. For example: every first block of Monday's noons of October 2019.
let blocks = await dater.getEvery(
    'weeks', // Period, required. Valid value: years, quarters, months, weeks, days, hours, minutes
    '2019-09-02T12:00:00Z', // Start date, required. Any valid moment.js value: string, milliseconds, Date() object, moment() object.
    '2019-09-30T12:00:00Z', // End date, required. Any valid moment.js value: string, milliseconds, Date() object, moment() object.
    1, // Duration, optional, integer. By default 1.
    true // Block after, optional. Search for the nearest block before or after the given date. By default true.
);

/* Returns an array of objects: [
    { date: '2019-09-02T12:00:00Z', block: 8470641 },
    { date: '2019-09-09T12:00:00Z', block: 8515536 },
    { date: '2019-09-16T12:00:00Z', block: 8560371 },
    { date: '2019-09-23T12:00:00Z', block: 8605314 },
    { date: '2019-09-30T12:00:00Z', block: 8649923 }
] */

let requests = dater.requests;

/* Returns a count of made requests */

Note: if the given date is before the first block date in the blockchain, the script will return 1 as block number. If the given date is in the future, the script will return the last block number in the blockchain.

Moment.js

The package uses moment.js plugin to parse dates. Read more about valid dates and time zones in the plugin's documentation: Moment.js

Examples

Every first block of the year:

let blocks = await dater.getEvery('years', '2016-01-01T00:00:00Z', '2019-01-01T00:00:00Z');

/* Returns [
    { date: '2016-01-01T00:00:00Z', block: 778483 },
    { date: '2017-01-01T00:00:00Z', block: 2912407 },
    { date: '2018-01-01T00:00:00Z', block: 4832686 },
    { date: '2019-01-01T00:00:00Z', block: 6988615 }
] */

Every last block of the year:

let blocks = await dater.getEvery('years', '2016-01-01T00:00:00Z', '2019-01-01T00:00:00Z', 1, false);

/* Returns [
    { date: '2016-01-01T00:00:00Z', block: 778482 },
    { date: '2017-01-01T00:00:00Z', block: 2912406 },
    { date: '2018-01-01T00:00:00Z', block: 4832685 },
    { date: '2019-01-01T00:00:00Z', block: 6988614 }
] */

Every first block of every 4 hours of October 10, 2019:

let blocks = await dater.getEvery('hours', '2019-10-10T00:00:00Z', '2019-10-11T00:00:00Z', 4);

/* Returns [
    { date: '2019-10-10T00:00:00Z', block: 8710742 },
    { date: '2019-10-10T04:00:00Z', block: 8711802 },
    { date: '2019-10-10T08:00:00Z', block: 8712836 },
    { date: '2019-10-10T12:00:00Z', block: 8713926 },
    { date: '2019-10-10T16:00:00Z', block: 8715001 },
    { date: '2019-10-10T20:00:00Z', block: 8716033 },
    { date: '2019-10-11T00:00:00Z', block: 8717086 }
] */