https://github.com/fibercrypto/libjava-skyfiber

Skycoin Java client library
https://github.com/fibercrypto/libjava-skyfiber

client-library java java-8 java-library java8 jni openapi rest-api rest-client restapi skycoin swagger swig

Last synced: 3 months ago
JSON representation

Skycoin Java client library

• Host: GitHub
• URL: https://github.com/fibercrypto/libjava-skyfiber
• Owner: fibercrypto
• Created: 2018-04-22T07:09:51.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2022-12-10T04:45:06.000Z (about 2 years ago)
• Last Synced: 2023-05-12T06:25:21.177Z (almost 2 years ago)
• Topics: client-library, java, java-8, java-library, java8, jni, openapi, rest-api, rest-client, restapi, skycoin, swagger, swig
• Language: Java
• Size: 98.3 MB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# LibSkyfiber for Java

[![Build Status](https://travis-ci.org/fibercrypto/libjava-skyfiber.svg?branch=develop)](https://travis-ci.org/fibercrypto/libjava-skyfiber)

Java client library for Skycoin API. This library is a .Net assembly generated with SWIG to access Skycoin API from Java.

## Table of Contents

- [LibSkycoin for Java](#libskycoin-for-java)

  - [Table of Contents](#table-of-contents)

  - [Install from sources](#install-from-sources)

  - [Usage](#usage)

    - [Naming](#naming)

    - [Parameters](#parameters)

      - [Handles](#handles)

      - [Byte slices](#byte-slices)

      - [Structures](#structures)

      - [Fixed Sized Arrays](#fixed-sized-arrays)

      - [Other Slices](#other-slices)

    - [Memory Management](#memory-management)

  - [Make Rules](#make-rules)

  - [Development setup](#development-setup)

    - [Running tests](#running-tests)

    - [Releases](#releases)

      - [Update the version](#update-the-version)

      - [Pre-release testing](#pre-release-testing)

      - [Creating release builds](#creating-release-builds)

  

## Install from sources

Download the repository from https://github.com/fibercrypto/libjava-skyfiber.git.

Execute (`mvn compile`) to install the library. Although executing (`mvn test`) is a better choice for making changes to the library. However, when using tox these commands are not required at all because calling tox will make any necessary installation and execute the tests.

## Install from Maven

Add this dependency to your project's POM: 

```xml

  

    skycoin-libjava-skyfiber

    https://packagecloud.io/fibercrypto/libjava-skyfiber/maven2

    

      true

    

    

      true

    

  

```

## Usage

### Naming

The exported function in Libskycoin Java have the following naming format: `SKY_package_func_name` where package is replace by the package where the original Skycoin function is and func_name is the name of the function. For example, `LoadConfig` function from `cli` package is called in Java `SKY_cli_LoadConfig`

### Parameters

All skycoin exported functions return an error object as the last of the return parameters. In Java error is return as an `long` and it is the first return parameter. The rest of the parameters are returned in the same order.

Receivers in Skycoin are the first of the input parameters. Simple types, like integer, float, string will be used as the corresponding types in Java, except what act as pointers.

#### Handles

Some of Skycoin types are too complex to be exported to a scripting language. So, handles are used instead. Therefore all functions taking a complex type will receive a handle instead of the original Skycoin type. For example, having these functions exported from Skycoin:

```go

  func LoadConfig() (Config, error)

  func (c Config) FullWalletPath() string

```

Config is a struct type that is treated as a handle in Libskycoin Java . The usage in Java will be:

```java

    public class Skycoin extends skycoin {

        public void main() {

            SWIGTYPE_p_Config__Handle configHandle = new_Config_HandlePtr();

            long err = SKY_cli_LoadConfig(configHandle);

            if (err == SKY_OK) {

                // SkY_OK means no error

                _GoString_ fullWalletPath = new _GoString_();

                err = SKY_cli_FullWalletPath(configHandle, fullWallerPath);

                assertEquals(err, SKY_OK);

                System.out.println(fullWallerPath.getP());

                //Close the handle after using the it

                //so the garbage collector can delete the object associated with  it.

                SKY_handle_close(configHandle);

            } else {

    //        Error

                System.out.println(err);

            }

        }

  }

```

#### Byte slices

Parameters of type byte[] will treated as string . Example, this function in Skycoin:

```go

func (s ScryptChacha20poly1305) Encrypt(data, password []byte) ([]byte, error)

```

... should be invoked like this:

```java

encrypt__ScryptChacha20poly1305 encrypt_settings = new encrypt__ScryptChacha20poly1305();

GoSlice data = new GoSlice(); //It will be passed as a parameter of type []byte

GoSlice pwd = new GoSlice(); //As []byte too

_GoString_ dataStr = new _GoString_();

_GoString_ pwdStr = new _GoString_();

GoSlice encrypted = new GoSlice();

dataStr.setString("Data to encrypt" );

data.convertString(dataStr);

pwdStr.SetString("password");

pwd.convertString(pwdStr);

long err = SKY_encrypt_ScryptChacha20poly1305_Encrypt(encrypt_settings, data, pwd,encrypted);

if(err == SKY_OK){

  System.out.println(encrypted.getString().getP()); //Encrypted is GoSlice

}

```

#### Structures

Structures that are not exported as handles are treated like .NET classes. In the previous example type ScryptChacha20poly1305 is created in Java like:

```java

encrypt__ScryptChacha20poly1305 encrypt_settings = new encrypt__ScryptChacha20poly1305()

```

And passed as first parameter in call to `SKY_encrypt_ScryptChacha20poly1305_Encrypt`.

#### Fixed Sized Arrays

Parameters of fixed size array are wrapped in structures when called from Java.

Given these types in Skycoin and this exported function:

```go

  type PubKey [33]byte

  type SecKey [32]byte

  func GenerateDeterministicKeyPair(seed []byte) (PubKey, SecKey)

```

This is a way to use them to write assertions in Java:

```java

//Generates random seed

GoSlice data = new GoSlice();

long err = SKY_cipher_RandByte(32,data);

assertEquals(err,SKY_OK);

cipher_PubKey pubkey = new cipher_PubKey();

cipher_SecKey seckey = new cipher_SecKey();

err = SKY_cipher_GenerateDeterministicKeyPair(data, pubkey,seckey);

```

In the example above `pubkey` and `seckey` are objects of an structure type containing a field named `data` holding the corresponding instance of `PubKey` and `SecKey`. Something like:

```cpp

  cipher_PubKey struct{

    data [33]byte;

  } cipher_PubKey;

  cipher_SecKey struct{

    data [32]byte;

  } ;

```

#### Other Slices

Other slices of base type different from `byte` are indeed wrapped inside classes. Let's see how to call the following function:

```go

func GenerateDeterministicKeyPairs(seed []byte, n int) []SecKey

```

In Java this how it should be used to generate a deterministic sequence of pairs of public / private keys given a random seed:

```java

//Generates random seed

GoSlice seed = new GoSlice();

long err = SKY_cipher_RandByte(32,seed);

cipher__SecKeys seckeys = new cipher__SecKeys();

err = SKY_cipher_GenerateDeterministicKeyPairs(seed, 2,seckeys);

for(int i=0;i