https://github.com/ethereumjs/ethereumjs-blockchain

Project is in active development and has been moved to the EthereumJS VM monorepo.
https://github.com/ethereumjs/ethereumjs-blockchain

blockchain blocks ethereum

Last synced: about 2 months ago
JSON representation

Project is in active development and has been moved to the EthereumJS VM monorepo.

• Host: GitHub
• URL: https://github.com/ethereumjs/ethereumjs-blockchain
• Owner: ethereumjs
• Archived: true
• Created: 2015-07-26T23:30:09.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-04-06T12:08:34.000Z (over 4 years ago)
• Last Synced: 2024-09-23T07:04:48.777Z (about 2 months ago)
• Topics: blockchain, blocks, ethereum
• Language: TypeScript
• Homepage: https://github.com/ethereumjs/ethereumjs-vm/tree/master/packages/blockchain
• Size: 327 KB
• Stars: 122
• Watchers: 28
• Forks: 63
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/contributing.md

Awesome Lists containing this project

README

        


  

    

  



# SYNOPSIS

[![NPM Package](https://img.shields.io/npm/v/ethereumjs-blockchain.svg?style=flat-square)](https://www.npmjs.org/package/ethereumjs-blockchain)

[![Actions Status](https://github.com/ethereumjs/ethereumjs-blockchain/workflows/blockchain-test/badge.svg)](https://github.com/ethereumjs/ethereumjs-blockchain/actions)

[![Coverage Status](https://img.shields.io/coveralls/ethereumjs/ethereumjs-blockchain.svg?style=flat-square)](https://coveralls.io/r/ethereumjs/ethereumjs-blockchain)

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/ethereumjs-lib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) or #ethereumjs on freenode

A module to store and interact with blocks.

# INSTALL

`npm install ethereumjs-blockchain`

# API

[./docs/](./docs/README.md)

# EXAMPLE

The following is an example to iterate through an existing Geth DB (needs `level` to be installed separately).

This module performs write operations. Making a backup of your data before trying it is recommended. Otherwise, you can end up with a compromised DB state.

```javascript

const level = require('level')

const Blockchain = require('ethereumjs-blockchain').default

const utils = require('ethereumjs-util')

const gethDbPath = './chaindata' // Add your own path here. It will get modified, see remarks.

const db = level(gethDbPath)

new Blockchain({ db: db }).iterator(

  'i',

  (block, reorg, cb) => {

    const blockNumber = utils.bufferToInt(block.header.number)

    const blockHash = block.hash().toString('hex')

    console.log(`BLOCK ${blockNumber}: ${blockHash}`)

    cb()

  },

  err => console.log(err || 'Done.'),

)

```

**WARNING**: Since `ethereumjs-blockchain` is also doing write operations

on the DB for safety reasons only run this on a copy of your database, otherwise this might lead

to a compromised DB state.

# EthereumJS

See our organizational [documentation](https://ethereumjs.readthedocs.io) for an introduction to `EthereumJS` as well as information on current standards and best practices.

If you want to join for work or do improvements on the libraries have a look at our [contribution guidelines](https://ethereumjs.readthedocs.io/en/latest/contributing.html).