Lightweight Java and Android library for integration with Ethereum clients
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
George Tebrean 356a686aed
Merge pull request #1826 from ajsutton/service-loader-race
2 weeks ago
.github Fix repo owner in release script 1 year ago
abi naming refactor 2 weeks ago
besu Fix private transaction manager (#1748) 8 months ago
codegen Merge pull request #1837 from matthewrkula/bug/fix-typo 3 weeks ago
contracts renamed eips -> contracts 4 years ago
core Merge pull request #1857 from alexdupre/fee-history 3 weeks ago
crypto updated and verified test 1 month ago
eea Fix private transaction manager (#1748) 8 months ago
geth Fix gradle warnings (#1101) 3 years ago
gradle Update build.gradle (#1448) 2 years ago
hosted-providers Updated Junit and mockito refactored the tests. (#1084) 3 years ago
integration-tests bump version 3 weeks ago
logos Updated web3j icon for documentation. 6 years ago
parity Spotless (#1630) 1 year ago
rlp Add precautionary cast to long in length calculation 3 years ago
tuples Fix gradle warnings (#1101) 3 years ago
utils Merge pull request #1823 from Michael-Ge/master 3 weeks ago
.gitignore build: use nexus sonatype for release process 3 years ago Update Contributions guide 1 year ago
LICENSE Migrated accross to Apache 2.0 license. 7 years ago remove Spongy 2 weeks ago
build.gradle bump version 3 weeks ago bump version 3 weeks ago
gradlew Makes everything work with Java 11/12, upgrades to Gradle 5.0 (#1086) 3 years ago
gradlew.bat Makes everything work with Java 11/12, upgrades to Gradle 5.0 (#1086) 3 years ago
settings.gradle build: update build tools 3 years ago
web3j.asc.enc Restore key (#1442) 2 years ago

Web3j: Web3 Java Ethereum Ðapp API

Documentation Status Build Status codecov Discord

Web3j is a lightweight, highly modular, reactive, type safe Java and Android library for working with Smart Contracts and integrating with clients (nodes) on the Ethereum network:


This allows you to work with the Ethereum blockchain, without the additional overhead of having to write your own integration code for the platform.

The Java and the Blockchain talk provides an overview of blockchain, Ethereum and Web3j.


It has five runtime dependencies:

It also uses JavaPoet for generating smart contract wrappers.


The simplest way to start your journey with Web3j is to create a project. We provide this functionality using the Web3j CLI. This latter can be installed as follows:

For Unix:

curl -L | sh && source ~/.web3j/

For Windows, in Powershell:

Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString(''))

Create a new project by running:

$ web3j new 

Or use our Maven or Gradle plugins to generate java files from Solidity contracts.

Please head to the Web3j Documentation for further instructions on using Web3j.








implementation ('org.web3j:core:4.8.7')


implementation ('org.web3j:core:4.8.7-android')

Build instructions

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, you will need to set up these variables in order to pull the Docker images from the Docker Hub registry:

  • registry.username
  • registry.password

Then run the following command:

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

If you do not want the integration test to run:

$ ./gradlew -Pintegration-tests=false :test

Check the Docker client API for more information on configuration options.

Commercial support and training

Commercial support and training is available from


Apache 2.0