nem2-sdk for Java/Kotlin/Scala

The official nem2-sdk for Java, Kotlin and Scala to work with the NEM2 (a.k.a Catapult).

Requirements

• Java 8
• Java 9

Usage

Each SDK user can depend on the best library for its need (example, sdk-vertx-client for server developers or sdk-okhttp-client for android developers).

Maven

<dependency>
    <groupId>io.nem</groupId>
    <artifactId>sdk-vertx-client</artifactId>
    <version>0.16.1</version>
</dependency>

OR

<dependency>
    <groupId>io.nem</groupId>
    <artifactId>sdk-okhttp-client</artifactId>
    <version>0.16.1</version>
</dependency>

Gradle

compile 'io.nem:sdk-vertx-client:0.16.1

OR

compile 'io.nem:sdk-okhttp-client:0.16.1

SBT

libraryDependencies += "io.nem" % "sdk-vertx-client" % "0.16.1"

OR

libraryDependencies += "io.nem" % "sdk-okhttp-client" % "0.16.1"

Documentation and Getting Started

Get started and learn more about nem2-sdk-java, check the official documentation.

Check SDK reference here

Open API Generated Clients

The SDK libs depend on Open API 3 generated clients. The clients Jars are automatically generated and deployed into Maven central by the nem2-open-api-java-generator project.

If you want to change or tune the generated libraries, you would need to clone/fork nem2-open-api-java-generator repository.

Modules

The SDK is composed of multiple sub-modules/folders:

• sdk-core: This module includes the model objects, interfaces and common utility classes. It is Vertx, ok-http, gson, etc agnostic. Clients won't depend on this jar directly, they will depend on one of the implementations below.
• sdk-vertx-client: The nem2-sdk-java Implementation that uses Vertx and generated api-vertx-client lib and dtos. A client may depend on this SDK implementation if Vertx is the selected implementation (e.g. server users).
• sdk-okhttp-client: The nem2-sdk-java Implementation that uses OkHttp and the generated api-okhttp-gson-client. A client may depend on this SDK implementation if OkHttp is the selected implementation (e.g. android users).
• integration-tests: This module is in charge of running integration tests against all implementations. The integration tests exercise how the implementation work against a given catapult server.

nem2-sdk Releases

The release notes for the nem2-sdk can be found here.

Contributing

This project is developed and maintained by NEM Foundation. Contributions are welcome and appreciated. You can find nem2-sdk on GitHub; Feel free to start an issue or create a pull request. Check CONTRIBUTING before start.

Getting help

We use GitHub issues for tracking bugs and have limited bandwidth to address them. Please, use the following available resources to get help:

• nem2-cli documentation
• If you found a bug, open a new issue

License

Copyright (c) 2018 NEM Licensed under the Apache License 2.0