Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.76 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.76 KB
Raw

OKExChain Java SDK

The OKExChain Java SDK is a lightweight Java library to interact with OKExChain through rest.

1.Components

  • src - the functions which could interact with OKEXChain are contained in class OKEXChainRPCClientImpl of package com.okexchain.client.impl.
  • test - it seems like a set of examples to show how to use the functions mentioned above. The developers could design their code refering to the test functions of class OKEXChainRPCClientImplTest in package com.okexchain.client in detail.

There are some function modules in path src as well :

  • env - set environment for Java SDK to interact with OKExChain
  • msg - define the message types according to module in OKExChain, and the example is the main function in class Msgxxx not end with "value" or in sample package.
  • common - network communications by RPC；
  • utils.crypto - related with the account info and address info of OKEXChain；
  • utils.encoding - the implementation of go-amino in Java;

2.Installation

git clone https://github.com/okex/okexchain-java-sdk.git
cd okexchain-java-sdk
mvn install -Dmaven.test.skip=true

3.API

Find it on the sdk documents

4.Tesing

All changes and addition of codes will be pushed with unit tests strictly. Right now you can find existing test cases : github.com/okex/okexchain-java-sdk/src/test

5.Contributing

No doubt that it's admirable to make contributions to okexchain Java SDK. You can provide your code as long as you have tested it with a local client, and your unit test showed its validity.

6.maven

<dependency>
  <groupId>io.github.okex</groupId>
  <artifactId>okexchain-java-sdk</artifactId>
  <version>0.18.4</version>
</dependency>