simple-block-stream
A simple way to stream blockchains with webcoin
This library makes it easy to stream blockchains with webcoin. It provides sensible defaults for most behavior and parameters.
Usage
npm install simple-block-stream
This library uses debug; set the env var DEBUG
to simple-block-stream
to see debug logs.
Options:
db
(required): a LevelUp databaseaddresses
: an array of addresses to include (default[]
)unfiltered
: if true, include all addresses (defaultfalse
)from
: include blocks starting at this height (default0
)params
: the params of the blockchain (default Bitcoin mainnet)network
: the network of the blockchain (default Bitcoin mainnet)peer
: the PeerGroup of the blockchain (default Bitcoin mainnet)json
: if true, produce JSON-serializable objects (defaultfalse
)
var SimpleBlockStream = var memdb = var sbs = // print to the console when we see a blocksbsstream
Call sbs.close
when you're done.
Fixtures
You can use fixtures to make your unit tests fast and reliable.
Use the make-fixture
binary to save a fixture:
make-fixture --outputPath fixture.json --fixtureHeight 1000
Use the fromFixture
method to read a fixture out. The fixture acts just like a SimpleBlockStream
.
var SimpleBlockStream = SimpleBlockStreamstream