Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/web3j/sample-project-gradle

Sample web3j project using Gradle
https://github.com/web3j/sample-project-gradle

blockchain ethereum gradle java web3j

Last synced: 2 days ago
JSON representation

Sample web3j project using Gradle

Awesome Lists containing this project

README 

        
# web3j Sample Project



This project provides a very simple starter application for working with web3j and the test 

Ethereum network (testnet) known as Rinkeby.



The demo deploys a *hello world* smart contract which contains a greeting message. The current 

greeting message can be read and modified in the smart contract.  



In order to run this demo, three pieces of information are required:



1. Ethereum client (or node) endpoint. The simplest thing to do is 

[request a free access token](https://infura.io/register) from Infura.

1. A wallet file. This can be generated using the [Epirus CLI](https://docs.epirus.io/sdk/cli/). 

1. Some Ether. This can be requested from the [Rinkeby Faucet](https://www.rinkeby.io/#faucet).



Once these details have been added to the main Application class, you'll be good to go.



## Functionality



This application demonstrates a number of core features of web3j and Ethereum:



- Connecting to a node on the Ethereum network

- Loading an Ethereum wallet file

- Sending Ether from one address to another

- Deploying a smart contract to the network

- Reading a value from the deployed smart contract

- Updating a value in the deployed smart contract

- Viewing an event logged by the smart contract



## Background



This application has purposefully been kept as simple as possible with the aim of demonstrating 

how to deploy and work with a smart contract on the decentralised Ethereum network.



If you require further background information about the above configuration items for the project

you can refer to the below.



For a more comprehensive overview, I recommend you read the 

[Java Magazine Article](https://web3j.io/articles/web3j%20article%20-%20Java%20Magazine%20JanuaryFebruary%202017.pdf), watch 

the 

[YouTube](https://youtube.com/watch?v=ea3miXs_P6Y) talk, and read all of the 

[documentation](https://docs.web3j.io).



### Smart contracts



The contained smart contract is based on the 

[Greeter contract example](https://www.ethereum.org/greeter), with the addition that the value 

stored in the Greeter can be modified.



The associated Java smart contract wrapper is named Greeter.



For more background on smart contracts, refer to the 

[smart contracts](https://docs.web3j.io/smart_contracts/) section of the docs.



### Infura



If you don't want to sign up to Infura, and would like to run a node yourself, there are 

instructions in the [getting started](https://docs.web3j.io/getting_started/#start-a-client) 

section of the docs.



### Testnets



For more information on the different Ethereum test networks (or testnets), refer 

to the 

[testnet overview](https://docs.web3j.io/transactions/#ethereum-testnets) in the docs.



### Ether



For background on Ether, refer to the transactions 

[overview](https://docs.web3j.io/transactions/#transactions) section of the docs.



### Wallets and transaction signing



For a more technical overview of working with wallet files, refer to the 

[Offline transaction signing](https://docs.web3j.io/transactions/#offline-transaction-signing)

section of the docs.

 



## Viewing requests



A logback configuration is included in the project dependencies allowing the logging of protocol 

messages if required. To enable, simply change the following line in the [logback configuration](https://github.com/web3j/sample-project-maven/blob/master/src/main/resources/logback.xml)

to read:



```xml



```