gavinzheng / browser-builds

Browser builds of ethereumjs libraries.

ethereumjs - Browser Builds

This repository contains browser builds of the following ethereumjs libraries:

• ethereumjs-vm
• ethereumjs-tx
• ethereumjs-wallet
• ethereumjs-wallet-hd
• ethereumjs-wallet-thirdparty
• ethereumjs-icap
• ethereumjs-abi
• ethereumjs-all

They are built using browserify with a known set of working dependencies.

For every library/build collection there is a larger plain source version also including the source mappings (e.g. ethereumjs-vm-x.x.x.js) and a minified version for use in production (e.g. ethereumjs-vm-x.x.x.min.js).

Note:

This repository was just lately (October 2017) revived. Currently all builds are considered experimental in terms of API stability, functionality and security!

Usage

In your web application, include only one of the builds from the dist directory. All exports will be available under the global ethereumjs.

Note: all packages expect ECMAScript 6 (ES6) as a minimum environment. From browsers lacking ES6 support, please use a shim (like es6-shim) before including any of the builds from this repo.

Examples

Examples for usage of the browser builds can be found in the examples directory:

• examples/

Start an http-server from the main directory of the repository to run the examples in the browser.

Build

Builds are done using the .js exports compilation files from the src/ directory and using the build.js script from the main directory to create the build in the dist/ folder.

Version numbers for the builds are directly extracted from the versions installed in the local node_modules folder.

For creating new builds:

1. Change package.json to require desired/up-to-date versions of the libraries
2. Reinstall/update local node_modules packages
3. Run npm run build to generate new set of builds