@synonymdev/slashtags-widget-bitcoin-feed
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

slashtags-widget-bitcoin-feed

Populates the data for the Bitcoin stats widget.

Usage

Feed

Copy config/config.example.json to config/config.json then edit the relay address.

cp config/config.example.json config/config.json

Start the feed writer

npm start

It will generate a keyPair and persist that in config/config.json for future sessions.

It should print: Running Bitcoin price feed: slashfeed:<id>/Bitcoin Price?relay=<relay-address>

Reader

To read The price feed use the Reader helper class.

const { Feed, Reader } = require('slashtags-widget-price-feed');

(async () => {
  const client = new Client({ storage: './path/to/feed/storage', relay: 'https://web-relay.example.com' })
  const feed = new Feed(client, config, { icon })

  await feed.ready() 

  const client = new Client({ storage: './path/to/reader/storage'})

  const readerClient = new Client({ storage: tmpdir() })
  const reader = new Reader(readerClient, feed.url)

  const unsubscribe = reader.subscribeBlockInfo(latestBlock => {
    // latestBlock:
    // {
    //     height: <block height>,
    //     timestamp: <timestamp of last block>,
    //     transactionCount: <tx count>,
    //     size: <size of block>,
    //     weight: <weight of block>,
    //     difficulty: <difficulty>,
    //     hash: <blocks hash>,
    //     merkleRoot: <blocks merkle root>
    // }
  })

  // Either call unsubscribe or close reader to close subscriptions
  unsubscribe()
  reader.close()
})

Readme

Keywords

none

Package Sidebar

Install

npm i @synonymdev/slashtags-widget-bitcoin-feed

Weekly Downloads

65

Version

1.0.0

License

MIT

Unpacked Size

13.9 kB

Total Files

16

Last publish

Collaborators

  • dzdidi_restored
  • pwltr
  • miguelmedeirosweb
  • rbndg
  • bitcoinerrorlog
  • jayvdb
  • coreyphillips
  • nzh