Lightweight Java and Android library for integration with Ethereum clients
You cannot 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 2a2da158ad
Merge pull request #1961 from web3j/offset_encode
fix Dynamic Arrays encode
2 weeks ago
.github update commands 1 month ago
abi add static decoding 2 weeks ago
besu fix gradle 5 months ago
codegen remove first approach 4 months ago
contracts update gradle and java 5 months ago
core add yParity 4 weeks ago
crypto add unit test 1 month ago
eea fix gradle 5 months ago
geth fix gradle 5 months ago
gradle refactor 1 month ago
hosted-providers fix gradle 5 months ago
integration-tests Update EthCallIT.java 1 month ago
logos Updated web3j icon for documentation. 7 years ago
parity fix gradle 5 months ago
rlp fix gradle 5 months ago
tuples update gradle and java 5 months ago
utils Add Bloom filter utility. 3 months ago
.gitignore build: use nexus sonatype for release process 4 years ago
CONTRIBUTING.md Update Contributions guide 2 years ago
LICENSE Migrated accross to Apache 2.0 license. 7 years ago
README.md Update README.md 1 month ago
build.gradle fix versions 1 month ago
gradle.properties fix versions 1 month ago
gradlew Makes everything work with Java 11/12, upgrades to Gradle 5.0 (#1086) 4 years ago
gradlew.bat Makes everything work with Java 11/12, upgrades to Gradle 5.0 (#1086) 4 years ago
settings.gradle build: update build tools 4 years ago
web3j.asc.enc Restore key (#1442) 2 years ago

README.md

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:

image

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.

Features

It has five runtime dependencies:

It also uses JavaPoet for generating smart contract wrappers.

QuickStart

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 get.web3j.io | sh && source ~/.web3j/source.sh

For Windows, in Powershell:

Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/web3j/web3j-installer/master/installer.ps1'))

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.

Maven

Java:

<dependency>
  <groupId>org.web3j</groupId>
  <artifactId>core</artifactId>
  <version>4.10.3</version>
</dependency>

Android:

<dependency>
  <groupId>org.web3j</groupId>
  <artifactId>core</artifactId>
  <version>4.8.7-android</version>
</dependency>

Gradle

Java:

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

Android:

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 web3labs.com.

License

Apache 2.0