3f-web3-core-subscriptions

3f-web3-core-subscriptions

tus]deps-image]deps-url

This is a sub-package of web3.js

This subscriptions package is used within some web3.js packages.

Please read the documentation for more.

Installation

Node.js

npm install 3f-web3-core-subscriptions

Usage

const Web3Subscriptions = require('3f-web3-core-subscriptions');

const sub = new Web3Subscriptions({
    name: 'subscribe',
    type: 'eth',
    subscriptions: {
        'newBlockHeaders': {
            subscriptionName: 'newHeads',
            params: 0,
            outputFormatter: formatters.outputBlockFormatter
        },
        'pendingTransactions': {
            params: 0,
            outputFormatter: formatters.outputTransactionFormatter
        }
    }
});
sub.attachToObject(myCoolLib);

myCoolLib.subscribe('newBlockHeaders', function(){ ... });