ethereumjs-blockstream - npm Package Compare versions

Comparing version 2.0.1 to 2.0.2

package.json

 {
   "name": "ethereumjs-blockstream",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "A library to turn an unreliable remote source of Ethereum blocks into a reliable stream of blocks with removals on re-orgs and backfills on skips.",
@@ -5,0 +5,0 @@ "main": "output/source/index.js",

Readme.md

@@ -5,2 +5,9 @@ [![npm version](https://badge.fury.io/js/ethereumjs-blockstream.svg)](https://badge.fury.io/js/ethereumjs-blockstream) [![Build Status](https://travis-ci.org/ethereumjs/ethereumjs-blockstream.svg?branch=master)](https://travis-ci.org/ethereumjs/ethereumjs-blockstream)
 
+# Usage
+[Instantiate](https://github.com/ethereumjs/ethereumjs-blockstream/blob/master/tests/index.ts#L466): `new BlockAndLogStreamer(getBlockByHashFunction, getLogsFunction, { blockRetention: 5 });`
+
+[Subscribe](https://github.com/ethereumjs/ethereumjs-blockstream/blob/master/tests/index.ts#L467-L470): `blockAndLogStreamer.subscribeToOnLogAdded(onLogAddedCallback);`
+
+[Reconcile New Blocks](https://github.com/ethereumjs/ethereumjs-blockstream/blob/master/tests/index.ts#L512-L514): `blockAndLogStreamer.reconcileNewBlock(blockFromGetLatest);`
+
 # Build
@@ -7,0 +14,0 @@ `docker build -t blockstream .`

No alert changes

Improved metrics

Total package byte prevSize

101510

increased by23.27%

Number of package files

56

increased by24.44%

Lines of code

1366

increased by35.79%

Number of lines in readme file

19

increased by58.33%

No dependency changes