Developer Guide

Building web3j

web3j includes integration tests for running against a live Ethereum client. If you do not have a client running, you can exclude their execution as per the below instructions.

To run a full build (excluding integration tests):

$ ./gradlew check

To run the integration tests:

$ ./gradlew  -Pintegration-tests=true :integration-tests:test

Generating documentation

web3j uses the Sphinx documentation generator.

All documentation (apart from the project README.md) resides under the /docs directory.

To build a copy of the documentation, from the project root:

$ cd docs
$ make clean html

Then browse the build documentation via:

$ open build/html/index.html