EthereumJS Monorepo

This was originally the EthereumJS VM repository. In Q1 2020 we brought some of its building blocks together to simplify development. Below you can find the packages included in this repository.

🚧 Please note that the master branch is updated on a daily basis, and to inspect code related to a specific package version, refer to the tags.

package	npm	issues	tests	coverage
@ethereumjs/block
@ethereumjs/blockchain
@ethereumjs/client
@ethereumjs/common
@ethereumjs/devp2p
@ethereumjs/ethash
merkle-patricia-tree
rlp		[![rlp Issues][rlp-issues-badge]][rlp-issues-link]	[![Actions Status][rlp-actions-badge]][rlp-actions-link]	[![Code Coverage][rlp-coverage-badge]][rlp-coverage-link]
@ethereumjs/tx
[ethereumjs-util][util-package]	[![NPM Package][util-npm-badge]][util-npm-link]	[![Util Issues][util-issues-badge]][util-issues-link]	[![Actions Status][util-actions-badge]][util-actions-link]	[![Code Coverage][util-coverage-badge]][util-coverage-link]
[@ethereumjs/vm][vm-package]	[![NPM Package][vm-npm-badge]][vm-npm-link]	[![VM Issues][vm-issues-badge]][vm-issues-link]	[![Actions Status][vm-actions-badge]][vm-actions-link]	[![Code Coverage][vm-coverage-badge]][vm-coverage-link]

Coverage report

Detailed version can be seen on Codecov.io

Package dependency relationship

mermaid graph TD vm{vm} client{client} ethash --> blockchain devp2p --> client block --> blockchain block --> client block --> vm blockchain --> client blockchain --> vm trie --> client trie --> vm trie --> block common --> block common --> blockchain common --> tx common --> vm common --> client common --> devp2p tx --> block tx --> vm vm --> client

To update the diagram above edit the README file and open a new PR with the changes.

Getting Started

See our monorepo documentation to get started on setting up the repository and installing dependencies. The config folder gives an overview on shared configuration and scripts between packages.

EthereumJS

See our organizational documentation 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.

LICENSE

Most packages are MPL-2.0 licensed, see package folder for the respective license.