iota.lib.java/README.md

##Introduction

The JOTA library is a simple Java8 wrapper around [IOTA] Node's JSON-REST HTTP interface.

It allows to connect easily using java directly to a local or a remote [IOTA node].

• Latest release: 0.0.1 Snapshot
• Compatibility: IOTA IRI v1.0.6
• API coverage: 10 of 20 commands fully implemented
• License: Apache License 2.0
• Readme updated: 2016-10-07 14:23:43 (UTC)

A list of all IOTA JSON-REST API commands currently supported by jota wrapper can be found in the Commands enum (see here for more details).

JOTA java wrapper is being designed to be thread-safe and simplest as possible in order to be easily mantainable, accordingly with the ongoing natural evolution of IOTA'api. All the boilerplate code for connecting to the node rest interface has been eliminated using Retrofit.

##Technologies & dependencies

The JOTA library has been designed to be used exclusively with Java 8+.

Core dependencies:

• Retrofit Client 2.1.0 [link]
• Gson JSON Processor : [link]
• Lombok 1.16.2 [link]

Other dependencies:

• Simple Logging Facade for Java 1.7.21 [link]
• Apache Commons Lang 3.3.2 [link]

##Getting started

Connect to your local node with the default settings is quite straitforward: it requires only 2 lines of code. For example, in order to fetch the Node Info:

IotaApiProxy api = new IotaApiProxy.Builder.build();
GetNodeInfoResponse response = api.getNodeInfo();

of if you need to connect to a remote node on https:

IotaApiProxy api = new IotaApiProxy.Builder 
	.protocol("https")
	.nodeAddress("somewhere_remotely") 
	.port(54321) 
	.build();

GetNodeInfoResponse response = api.getNodeInfo();

Next, modify your pom.xml to include btcd-cli4j-core as a dependency:

<dependency>
	<groupId>com.neemre.btcd-cli4j</groupId>
	<artifactId>btcd-cli4j-core</artifactId>
	<version>0.5.1</version>
</dependency>

In order to communicate with IOTA node, JOTA needs to be aware of your node's exact configuration. The easiest way of providing this information is via a node_config.properties file, for example:

node.bitcoind.rpc.protocol = http
node.bitcoind.rpc.host = 127.0.0.1
node.bitcoind.rpc.port = 8332
node.bitcoind.rpc.user = falcon-pc
node.bitcoind.rpc.password = 3F4DN9QGqWrB4DCdfYMXp8xdDYL4HDFzpaS9r76DbNhw
node.bitcoind.http.auth_scheme = Basic

That's it!

##Examples

There's an extensive list of test coverages on the src/test/java package of the project that can be used as reference.

##Supporting the project

If JOTA has been useful to you and you feel like contributing, consider posting a bug report or a pull request. Alternatively, donations are very welcome too!

• Bitcoin: 3FGCHqhG1SUpgn2eS1Agq2KnxJemWnQFbB