Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/emeraldpay/etherjar

Java integration library for Ethereum blockchain
https://github.com/emeraldpay/etherjar

blockchain ethereum java

Last synced: about 2 months ago
JSON representation

Java integration library for Ethereum blockchain

Host: GitHub
URL: https://github.com/emeraldpay/etherjar
Owner: emeraldpay
License: apache-2.0
Created: 2016-08-28T12:04:57.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-10-22T18:51:44.000Z (3 months ago)
Last Synced: 2024-10-23T17:55:51.420Z (3 months ago)
Topics: blockchain, ethereum, java
Language: Java
Homepage:
Size: 2.08 MB
Stars: 40
Watchers: 14
Forks: 17
Open Issues: 8
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

DeFi-Developer-Road-Map - Ether Jar

README

        # EtherJar

![Build Status](https://github.com/emeraldpay/etherjar/workflows/Tests/badge.svg)

[![codecov](https://codecov.io/gh/emeraldpay/etherjar/branch/master/graph/badge.svg)](https://codecov.io/gh/emeraldpay/etherjar)

[![license](https://img.shields.io/github/license/emeraldpay/etherjar.svg?maxAge=2592000)](https://github.com/emeraldpay/etherjar/blob/master/LICENSE)

Framework agnostic modular Java 17+ integration library for [Ethereum blockchains](https://www.ethereum.org)

- Latest Stable Version: 0.12.0

- Latest Snapshot Version: 0.13.0-SNAPSHOT

## Modules

Structure of dependencies between modules:

* `etherjar-abi`

  * `etherjar-domain`

  * `etherjar-hex`

* `etherjar-domain`

* `etherjar-hex`

* `etherjar-rlp`

* `etherjar-rpc-json`

  * `etherjar-domain`

  * `etherjar-hex`

* `etherjar-rpc-api`

  * `etherjar-rpc-json`

  * `etherjar-domain`

  * `etherjar-hex`

* `etherjar-rpc-emerald`

  * `etherjar-rpc-api`

* `etherjar-rpc-http`

  * `etherjar-rpc-api`

  * `etherjar-domain`

  * `etherjar-hex`

* `etherjar-rpc-ws`

  * `etherjar-rpc-api`

* `etherjar-solidity`

  * `etherjar-abi`

  * `etherjar-domain`

* `etherjar-tx`

  * `etherjar-rlp`

  * `etherjar-domain`

* `etherjar-contract`

  * `etherjar-abi`

  * `etherjar-domain`

  * `etherjar-rpc-api` 

* `etherjar-erc20`  

  * `etherjar-abi`

  * `etherjar-domain`

  * `etherjar-contract`

where

* `etherjar-abi` - Smart

  contract [Application Binary Interface (ABI)](https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI)

* `etherjar-contract` - Methods to organize contract call

* `etherjar-domain` - Core module contains pure domain logic (`Address`, `Block`, `Transaction`

  , `Wei` and so on)

* `etherjar-erc20` - Classes to simplify use of ERC-20 tokens

* `etherjar-hex` - Hexadecimal encoding and encoding utils for `String`, `BigInteger`, byte arrays

* `etherjar-rlp` - Reading and writing RLP (Recursive Length Prefix) encoded data

* `etherjar-rpc-json` - JSON mapping to/from Java objects

* `etherjar-rpc-api` - [JSON-RPC API](https://github.com/ethereum/wiki/wiki/JSON-RPC) generic

  implementation

* `etherjar-rpc-emerald` - gRPC transport,

  see [Emerald Dshackle](https://github.com/emeraldpay/dshackle)

* `etherjar-rpc-http` - HTTP transport implementation for JSON-RPC API data-layer

* `etherjar-rpc-ws` - WebSocket transport to subscribe to new blocks

* `etherjar-solidity` - Thin wrapper

  around [`solc` Solidity compiler](https://github.com/ethereum/solidity)

* `etherjar-tx` - Read, verify and manipulate Transactions

## Usage

### Maven

```xml

    

      etherjar

      https://maven.emrld.io

    

  io.emeraldpay.etherjar

  etherjar-rpc-http

  0.12.0

```

### Gradle

```groovy

repositories {

  maven {

    url "https://maven.emrld.io"

  }

}

dependencies {

    implementation "io.emeraldpay.etherjar:etherjar-rpc-http:0.12.0"

}

```

## Examples

How to call `web3_clientVersion` low-level JSON-RPC API method:

```java

public class GetClientVersion {

    public static void main(String[] args)

            throws URISyntaxException, IOException, ExecutionException, InterruptedException {        

        try (RpcTransport transport = HttpRpcTransport.newBuilder().connectTo("http://127.0.0.1:8545").build()) {

            RpcClient client = new DefaultRpcClient(transport);

            Future req = client.execute(Commands.web3().clientVersion());

            System.out.println(String.format("Client version: %s", req.get()));

        }

    }

}

```

How to call `eth_gasPrice` low-level JSON-RPC API method:

```java

public class GetGasPrice {

    public static void main(String[] args)

            throws URISyntaxException, IOException, ExecutionException, InterruptedException {

        try (RpcTransport transport = HttpRpcTransport.newBuilder().connectTo("http://127.0.0.1:8545").build()) {

            RpcClient client = new DefaultRpcClient(transport);

            Future req = client.execute(Commands.eth().getGasPrice());

            System.out.println(String.format("Gas Price: %s Ether", req.get().toEthers(12)));

        }

    }

}

```

## Documentation

* [Reference Guide](./docs/index.md)

## Bugs and Feedback

For bugs, questions and discussions please use the [GitHub Issues](https://github.com/emeraldpay/etherjar/issues).

## Licence

Copyright 2021 EmeraldPay, Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. 

You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

See the License for the specific language governing permissions and limitations under the License.