README.md

Ontology Java SDK User Guide

Version 1.0.0

English / 中文

Overview

This official Ontology Java SDK is a comprehensive Java library for the Ontology blockchain. This SDK supports multiple functions including native wallet management, digital identity management, digital asset management, smart contract deployment and invocation and node communication. This SDK will continue to be updated with new features.

Main functions

• Getting Started
• Interface
• Basic operation of blockchain nodes
• Wallet file specification
• Digital identity and verifable claim management
• Digital assets
• Digital Attestment
• Authorization management
• Smart contract deployment and invocation
• Error codes
• API reference

Code structure:

The SDK is broken down into the following key areas:

• account: Account operations, e.g. public/private key generation
• common: Common interface
• core: Core layer, including smart contract, transaction and signature
• crypto: Relevant to crytography, e.g. ECC/SM
• io: IO operations
• network: Interfacing with the restful, RPC or websocket interfaces of the chain.
• sdk: Underlying encapsulation, info management, communications management, UTXO management, wallet file management, exception class.
• ontsdk class: Provide manager and transaction use cases and there are two types of managers:
  • walletMgr: Manages digital identities and digital asset accounts. Transactions sent to the blockchain need to be digitally signed with the user's private key.
  • connManager: Manages blockchain communications system. Any transactions and query needs to be processed by connManager.

Installation Environment

Please configure JDK 8 and above.

Note: As the length of the key used in the Java SDK is greater than 128 and due to the restrictions of JAVA security policy files, it is necessary to download local_policy.jar and US_export_policy.jar from the official website to replace the two jar files in ${java_home}/jre/lib/security in JRE directory.

Download URL：

http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html

Build

$ mvn clean install

How to Use

Add maven dependency:

<!-- https://mvnrepository.com/artifact/com.github.ontio/ontology-sdk-java -->
<dependency>
    <groupId>com.github.ontio</groupId>
    <artifactId>ontology-sdk-java</artifactId>
    <version>1.0.16</version>
</dependency>

Preparations

Ensure you have access to an Ontology Blockchain (mainnet, testnet or privaenet) and access via RPC ports is available.