Back to packageRELEASE DETAILS

0.1.4

npm

@0xcert/ethereum-scanner

0xcert Etherium blockchain scanner.

Published12 Apr 2018

Direct dependencies10

Transitive dependenciesNot calculated

README

Current package documentation

Build Status

0xcert Ethereum blockchain parser.

This is an open source package for NodeJS written with TypeScript. It allows for scraping of the Ethereum blockchain for 0xcert protocol related contracts and transactions.

This package is actively maintained, well tested and already used in production environments. The source code is available on GitHub where you can also find our issue tracker.

Installation

Run the command below to install the package.

npm install --save web3 @0xcert/ethereum-scanner

This package uses promises thus you need to use Promise polyfill when promises are not supported.

Getting started

Initialize the Web3 provider.

import * as Web3 from 'web3';

const web3 = new Web3(new Web3.providers.HttpProvider('http://localhost:8545'));

Load and parse data of a particular block.

import { Scanner } from '@0xcert/ethereum-scanner';

const blockNumber = 2996066;
const scanner = new Scanner(web3);

await scanner.parse(blockNumber); // => { transactions: [...], contracts: [...]}

API

Scanner Class

Scanner(web3)

Main class which allows for parsing the Ethereum blockchain.

Option	Type	Required	Default	Description
web3	Web3	Yes	-	Instance of a Web3 provider.

NOTICE: The scanner class extends is a RawModel class and thus exposes all related helper methods.

Scanner.prototype.parse(block): Promise(JSON)

Populates the scanner with block data and then returns serialized scanner data.

Option	Type	Required	Default	Description
block	Integer	Yes	-	Block number.

Scanner.prototype.populateByBlock(block): Promise(Scanner)

Loads and parses transactions and new contracts of a particular block on the Ethereum blockchain.

Option	Type	Required	Default	Description
block	Integer	Yes	-	Block number.

License (MIT)

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 11

Native requirements

10 direct targetsNot calculated transitive count

Package / target	Requirement	Relationship
rawmodel Environment { "local_name": "rawmodel", "alias": false, "peer_metadata": null }	`^1.31.2`	runtime
@types/mocha Environment { "local_name": "@types/mocha", "alias": false, "peer_metadata": null }	`5.0.0`	development
mocha Environment { "local_name": "mocha", "alias": false, "peer_metadata": null }	`5.0.5`	development
solc Environment { "local_name": "solc", "alias": false, "peer_metadata": null }	`^0.4.21`	development
ts-node Environment { "local_name": "ts-node", "alias": false, "peer_metadata": null }	`^3.3.0`	development
tslint Environment { "local_name": "tslint", "alias": false, "peer_metadata": null }	`^5.7.0`	development
tslint-config-standard Environment { "local_name": "tslint-config-standard", "alias": false, "peer_metadata": null }	`^6.0.1`	development
typescript Environment { "local_name": "typescript", "alias": false, "peer_metadata": null }	`^2.8.0`	development
web3 Environment { "local_name": "web3", "alias": false, "peer_metadata": null }	`^1.0.0-beta.33`	development
web3-typescript-typings Environment { "local_name": "web3-typescript-typings", "alias": false, "peer_metadata": null }	`^0.10.2`	development
web3 Environment { "local_name": "web3", "alias": false, "peer_metadata": null }	`^1.0.0-beta.33`	peer

Distribution files

1 collected

Distribution 1

Source distribution

Source file

Checksums from source

{
  "integrity": "sha512-PtMkOvTZWaXVQ9WlaA9r+mfZSMypEXYXLGzcE/1Ownj/0O8gysgjyQKbhAdFnZqgqUuqPV4U5SKmLfFEBrkTfA==",
  "shasum": "f81a38246b70aa24428789b37a0fb088ccca635b",
  "tarball": "https://registry.npmjs.org/@0xcert/ethereum-scanner/-/ethereum-scanner-0.1.4.tgz",
  "fileCount": 32,
  "unpackedSize": 121048,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEYCIQDTmyO81ySZYkKBv1nEwDaLzsHStguCJ1s53z7X/DfrswIhAIZp+91ScvfgI05B6G1g6sHfecBoaLYObnl1jsouE4aV"
    }
  ]
}