Skip to content

Latest commit

 

History

History
109 lines (67 loc) · 5.36 KB

README.md

File metadata and controls

109 lines (67 loc) · 5.36 KB

JLibra

GitHub Actions - Build Codacy Badge Known Vulnerabilities Maven Central javadoc

A Java library for building applications on Diem

The project previously know as Libra has been renamed to Diem. Read more about it from here: Announcing the name Diem.

The API for creating transactions and querying the database of Diem uses json-rpc - a simple remote procedure call protocol utilizing JSON for encoding data. Sending new transactions to the Diem network requires also another type of serialization - the Object Canonical Serialization. JLibra implements both of these and provides a simple api for Java applications to integrate to Diem.

JLibra simplifies integration to Diem but does not hide any features of the Diem api, this makes it possible to implement anything supported by Diem with Java.

Prerequisites

  • JDK 11+
  • Maven 3+

Setup

  • Clone this repo
  • Build project with mvn install (this is important because the project contains classes that will be created during the Maven build and simply checking the project out is not enough)

Start a local Diem instance

A running local instance is required for the examples and the integration tests

  • cd docker/validator-testnet
  • define the Diem version to use export IMAGE_TAG=release-1.1_639d5ab4
  • docker-compose up

Try the examples

Start sample Main classes in dev.jlibra.example package for examples (for a complete example with creating accounts to moving coins between them check the how to)

AsyncExample

BatchRequestExample

CreateChildVaspAccountExample

DualAttestationExample

GenerateKeysExample

GetAccountStateExample

GetAccountTransactionsExample

GetAccountTransactionBySequenceNumberExample

GetEventsByEventKeyExample

GetStateProofExample

GetTransactionsExample

ImportAccountMnemonicExample

KeyRotationExample

MintExample

TransferExample

TransferMultisigExample

Use JLibra in your project

Versions of JLibra are deployed to the Central Maven repository, you can add JLibra as a dependency to your project:

Maven:

<dependency>
  <groupId>dev.jlibra</groupId>
  <artifactId>jlibra-core</artifactId>
  <version>0.20.0</version>
</dependency>

Gradle:

compile("dev.jlibra:jlibra-core:0.20.0")

How-Tos & Step-by-Step Guides

How-Tos and Step-by-Step Guides are gathered in a separate document.

Known Issues

Transaction is not executed, but without errors (no events, no transaction in librabrowser.io)

  1. You might have specified too few gas.
  • Try increasing maxGasAmount.

Contributors

Projects using JLibra