Marketplace has launched, further enabling blockchain developers! Learn more

How to connect to Ethereum network using Java / Web3j

September 09, 2022

Overview

We can say that Java is one of the most versatile languages out there, and it continues to be relevant in today's time. Java is so popular because of its massive user base and use cases. In this guide/tutorial, we'll learn how to connect to the Ethereum Blockchain network using Java/ Web3j.

Some Background on Java
Java’s slogan is 'Write once, run anywhere,' which means a Java program should be able to run on any machine. The Java JVM (Java Virtual Machine) enables Java code to run on multiple platforms.

Features of Java:
  • Fully object-oriented.
  • Has one of the most mature developer communities.
  • Backed by tech giant Oracle. 
  • Has tons of frameworks to make reliable apps.
  • Has a massive set of IDEs.

In this guide, we will be connecting to the Ethereum network using Java with the help of a Java library called Web3j.

What is Web3j?

What is Web3j?
Web3j is a Java library that interacts with Ethereum Smart contracts and integrates with Ethereum nodes. It is highly modular, type-safe, and reactive, built for Java and Android development on Ethereum. Web3j eliminates the overhead of writing a custom integration code to connect to the Ethereum blockchain network.

Features of Web3j:
  • Complete Ethereum JSON-RPC client API over HTTP and IPC implementation and support for Ethereum wallet.
  • Auto-generation of Java smart contract wrappers to create, deploy, transact with, and call smart contracts from native Java code (Solidity and Truffle definition formats supported).
  • Reactive-functional API for working with filters.
  • Ethereum Name Service (ENS) support.
  • Support for Hosted Ethereum nodes.
  • Support for ERC20 and ERC721 token standards
  • Command-line tools.
  • Android compatible.

Prerequisites
  • Java installed on your system.
  • A Java IDE, we'll use Jet Brains IntelliJ IDEA (community version) here.
  • An Ethereum node.

Installing the web3j java library

To install Web3j and run our code, we'll need Java installed in our systems. To check if you have Java installed or not, type the following in your Terminal/command prompt:

installing the web3j java library

Copy
java -version

It must return the installed version of Java on your system. If not installed, download it from here, based on your OS type. 

We can install Web3j using either Maven or Gradle. 

For Maven:

Java 8:

installing the web3j java library

Copy
<dependency>
  <groupId>org.web3j</groupId>
  <artifactId>core</artifactId>
  <version>4.6.3</version>
</dependency>

Android:

installing the web3j java library

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

For Gradle:

Java 8:

installing the web3j java library

Copy
compile ('org.web3j:core:4.6.3')

Android:

installing the web3j java library

Copy
compile ('org.web3j:core:4.6.0-android')

We'll use Maven to manage our Java library dependency and install it. First, Let's set up our IntelliJ IDE, create a new project, and select a Maven project, then click next.



Now You'll see a pom.xml file opened up in a window, Take out the code from Line 10-14 and copy-paste the following in your pom.xml file:


installing the web3j java library

Copy
<dependencies>
    <dependency>
        <groupId>org.web3j</groupId>
        <artifactId>core</artifactId>
        <version>4.6.3</version>
    </dependency>
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-nop</artifactId>
        <version>1.7.5</version>
        <scope>compile</scope>
    </dependency>
</dependencies>
<properties>
    <maven.compiler.target>1.8</maven.compiler.target>
    <maven.compiler.source>1.8</maven.compiler.source>
</properties>

Here we're adding web3j dependency in the pom.xml file to interact with the Ethereum blockchain and slf4j dependency to manage the logging error; learn more about it here.

Your pom.xml file must look something like this (Web3j_Demo is the project name):

 


Then from the right panel, click on Maven and expand your project directory, select Lifecycle, and then double-click on install; this will install Web3j. You’ll see a 'BUILD SUCCESS' message in the IDE terminal (In the image below, see steps 1-5).


Booting our Ethereum node

For our purposes today, we could use pretty much any Ethereum client, such as Geth or OpenEthereum (fka Parity). Since that is a bit too involved for just querying for block height, we'll just grab a free endpoint from QuickNode to make this easy. After you've created your free ethereum endpoint, copy your HTTP Provider endpoint:

Screenshot of Quicknode Ethereum endpoint


You'll need this later, so copy it and save it.

Connecting via Java / Web3j

Now let's write a small piece of Java code to fetch the latest Block number from the Ethereum Blockchain. To accomplish this, Expand your project from the left panel, then click on src, then main, and then right-click on Java, select New, and select a Java class; you can name your Java class anything (ref image below). Then, copy/paste this into your newly created Java class file (BlockNumber.java in the following example):


connecting via java web3j

Copy
import org.web3j.protocol.Web3j;
import org.web3j.protocol.http.HttpService;
import org.web3j.protocol.core.methods.response.EthBlockNumber;
import .lang.String;
import .lang.*;
import .util.concurrent.ExecutionException;

public class BlockNumber {
    public static void main(String[] args) throws ExecutionException, InterruptedException{
        Web3j web3 = Web3j.build(new HttpService("ADD_YOUR_ETHEREUM_NODE_URL")); 
        EthBlockNumber result = web3.ethBlockNumber().sendAsync().get(); 
        System.out.println(" The Block Number is: " + result.getBlockNumber().toString());
    }
}

Make sure to replace `ADD_YOUR_ETHEREUM_NODE_URL` with the http provider from the section above.

A quick explanation of the code above: 

Lines 1-6:
Importing Web3j library, Web3j's HttpService, which will enable us to use the HTTP endpoint, EthBlockNumber method of Web3j, java.lang.String and java.lang.* to convert the block hash into a number, java.util.concurrent.ExecutionException to catch Execution error (line 1 - line 6),

Lines 8-12:
Starting our Java code with public class BlockNumber (line 8), Starting our main class and catching execution and interruption exception (line 9), Supplying our Ethereum node to the web3 variable (line 10), Using ethBlockNumber method to send an async get request to the node (line 11), printing our block number after getting the number using getBlockNumber method and then converting it to a string using toString method (line 12).

Run the code from the left panel by right-clicking on the Java class name and selecting run, or using Ctrl+Shift+F1. A successful output should like this:

Output


Conclusion

Congratulations! You have connected to the Ethereum network using Java / Web3j! Check out Web3j GitHub repository for more information and to examine the code that utilizes web3j. Also, study their documentation to learn more.

Subscribe to our newsletter for more articles and guide on Ethereum. If you have any feedback, please feel free to reach out to us via Twitter and you can always chat with us if you have a question via our community server on Discord, thanks :)

Related articles 35

How to do a non-custodial transaction with QuickNode
Originally Published On: Jun 19, 2021
Updated On: Sep 9, 2022

Private keys are one of the most... A non-custodial wallet is a... Custodian of Private... At We could use pretty much any... We could use any of the many... Let us create a token transfer... Congratulations on making a...

Continue reading
How to Set Up a Near Project from Scratch
Originally Published On: Jan 27, 2022
Updated On: Sep 9, 2022

In this tutorial we will look at... In this section, we will... In this section, we will look at... In this section, we will look at... When writing smart contracts on... In the last section, we looked... In the last section, we looked... In the last section, we looked... We have finally come to the end...

Continue reading
Estimating gas price using pending transactions in Python
Originally Published On: Feb 20, 2021
Updated On: Sep 9, 2022

To send a transaction on the... Gas is the unit to measure the... Why do we want to estimate gas?... Our first step here would be to... For our purposes today, we could... The first thing we’re going to... Now you know how to estimate gas...

Continue reading
Como crear y lanzar un ERC-721 (NFT)
Originally Published On: Dec 27, 2021
Updated On: Sep 9, 2022

Coleccionables digitales que son... Fungible significa que es lo... ERC es la abreviación para... Ahora que conocemos qué es y... Antes de escribir nuestro... Felicidades por crear tu propio...

Continue reading
How to Access Bitcoin Mempool
Originally Published On: Aug 16, 2021
Updated On: Sep 21, 2022

Bitcoin is the father of... The transactions which are sent... For our purpose today, we need a... We will use Bitcoin RPC methods... Congratulations on mastering the...

Continue reading
How to Mint an NFT on Polygon with Ethers.js
Originally Published On: Mar 28, 2022
Updated On: Sep 9, 2022

This guide demonstrates how to... Ethers.js is a complete Ethereum... As a reminder, the act of... We will deploy our contract on... Time to write the code! Start by... Note, you will need some... That’s it! You have minted an...

Continue reading
How to access Ethereum Mempool
Originally Published On: Oct 15, 2020
Updated On: Sep 15, 2022

On Ethereum, when a transaction... In blockchain terminology, a... For the purpose of this guide,... First, query the Let’s examine how to subscribe... This short guide showed you how...

Continue reading
The Web3 Developer Stack
Originally Published On: Jul 3, 2021
Updated On: Sep 15, 2022

A developer stack is a bag of... If we can imagine web3 as a car... The Chainlink price feed... Head over to the We’ll need a Kovan node to... We’ll now write a short... Congratulations :D You’ve taken...

Continue reading
How to Mint NFTs on the Stacks Blockchain
Originally Published On: Aug 19, 2022
Updated On: Sep 9, 2022

Stacks is an emerging blockchain... The Stacks ecosystem has adopted... Open up a terminal window and... Implementing the SIP-009... This section will demonstrate... The moment you've been waiting... Awesome Work! You’ve learned how...

Continue reading
Introduction to Scaffold-ETH 🏗
Originally Published On: Oct 7, 2021
Updated On: Sep 9, 2022

Developing applications involves... First of all, before getting... Scaffold-ETH comes with a demo... We will set up a QuickNode... Congratulations, and thank you...

Continue reading
How to connect to Ethereum using PHP
Originally Published On: Jun 11, 2021
Updated On: Sep 9, 2022

PHP is a very popular choice... Before installing the web3.php,... We could use pretty much any... Now, make a PHP script file... Congratulations on connecting to...

Continue reading
How to use Subspace with QuickNode
Originally Published On: Sep 8, 2020
Updated On: Sep 9, 2022

In this guide, we'll understand... To install Subspace, we'll need... For our purposes today, we could... Now let's create a short script,... Run the file using the node...

Continue reading
How to Connect Your Dapp With MetaMask Using Ethers.js
Originally Published On: Dec 13, 2021
Updated On: Sep 9, 2022

In our dApp, we will have a... A dApp is an application that... We will need to install the... Ethers.js is a lightweight... With this application, we will... Next, we will create a function... After connecting to MetaMask, we... To handle the wallet address of... This section will show us how to... In this tutorial, we...

Continue reading
How to Lazy Mint an NFT on Rarible with Rarepress
Originally Published On: Feb 23, 2022
Updated On: Sep 9, 2022

NFTs are great for creators to... To mint an NFT, you write data... Lazy Minting is a process in... We will write some JavaScript... Rarepress interacts with the... Now that we have everything in... Congratulations on listing your...

Continue reading
How to get the balance of an ERC-20 token
Originally Published On: Jun 14, 2021
Updated On: Sep 21, 2022

When a new token is made on the... You could use any Ethereum... Now that you've done the legwork... Getting the ERC20-Token Balance... In the top of your... ABI is short for You will most likely interact... You can use a similar process... We now have a connection to an... Having made it to the end, you...

Continue reading