open-api-jvm-sdk

OPEN Platform JVM SDK

License	License MIT licence
GroupId	GroupId io.openfuture
ArtifactId	ArtifactId sdk
Last Version	Last Version 2.0.0
Release Date	Release Date Dec 19, 2019
Type	Type jar
Description	Description open-api-jvm-sdk OPEN Platform JVM SDK
Project URL	Project URL https://github.com/OpenFuturePlatform/open-api-jvm-sdk
Source Code Management	Source Code Management https://github.com/OpenFuturePlatform/open-api-jvm-sdk

Download sdk

Filename	Size
sdk-2.0.0.pom
sdk-2.0.0.jar	61 KB
sdk-2.0.0-sources.jar	13 KB
sdk-2.0.0-javadoc.jar	261 bytes
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.openfuture/sdk/ -->
<dependency>
    <groupId>io.openfuture</groupId>
    <artifactId>sdk</artifactId>
    <version>2.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.openfuture/sdk/
implementation 'io.openfuture:sdk:2.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.openfuture/sdk/
implementation ("io.openfuture:sdk:2.0.0")

Apache Buildr

'io.openfuture:sdk:jar:2.0.0'

Apache Ivy

<dependency org="io.openfuture" name="sdk" rev="2.0.0">
  <artifact name="sdk" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.openfuture', module='sdk', version='2.0.0')
)

Scala SBT

libraryDependencies += "io.openfuture" % "sdk" % "2.0.0"

Leiningen

[io.openfuture/sdk "2.0.0"]

Dependencies

compile (8)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-stdlib-jdk8	jar	1.2.50
org.apache.httpcomponents : httpclient	jar	4.5
com.fasterxml.jackson.core : jackson-databind	jar	2.0.1
com.fasterxml.jackson.module : jackson-module-kotlin	jar	2.9.4.1
junit : junit	jar	4.12
org.assertj : assertj-core	jar	3.10.0
org.mockito : mockito-all	jar	1.10.19
org.powermock : powermock-mockito-release-full	jar	1.6.4

Project Modules

There are no modules declared in this project.

OpenJ

OpenJ is a library for interaction with Open Platform.

Content

Installing

Using gradle:

compile("io.openfuture:sdk:1.0.0")

Using maven:

<dependency>
    <groupId>io.openfuture</groupId>
    <artifactId>sdk</artifactId>
    <version>1.0.0</version>
</dependency>

Get started

token - your open key

Kotlin:

val open = OpenJ(token)

Java:

OpenJ open = new OpenJ(token)

Entity

Base

Page request attributes

Attribute	Type	Description
offset	Long	Page offset
limit	Int	Page limit

Page response attributes

Attribute	Type	Description
totalCount	Long	Total count of entities in a database
list	T[]	List of entities with type T (T is generic)

Scaffold

Ethereum scaffold attributes

Attribute	Type	Description
address	String	Scaffold address
abi	String	Scaffold json interface
description	String	Scaffold description
fiatAmount	String	Scaffold fiat amount
currency	String	Fiat amount currency
conversionAmount	String	Fiat amount converted to ethereum
developerAddress	String	Scaffold developer address
webHook	String	Scaffold webhook for events
properties	EthereumScaffoldProperty[]	Ethereum scaffold properties

Ethereum scaffold properties attributes

Attribute	Type	Description
name	String	Property name
type	PropertyType	Property type
defaultValue	String	Property default value

Ethereum scaffold summary attributes

Attribute	Type	Description
scaffold	EthereumScaffold	Ethereum scaffold
transactionIndex	BigInteger	Transaction index
tokenBalance	BigInteger	Scaffold token balance
enabled	Boolean	Scaffold enabled
currency	String	Fiat amount currency
shareHolders	EthereumShareHolder	Ethereum scaffold share holders

Ethereum scaffold quota attributes

Attribute	Type	Description
currentCount	Int	Current deactivated scaffolds count
limitCount	Int	Limit of deactivated scaffolds count

Deploy ethereum scaffold request

Attribute	Type	Description
openKey	String	User open key
description	String	Scaffold description
fiatAmount	String	Scaffold fiat amount
currency	String	Fiat amount currency
conversionAmount	String	Fiat amount converted to ethereum
developerAddress	String	Scaffold developer address
webHook	String	Scaffold webhook for events
properties	EthereumScaffoldProperty[]	Ethereum scaffold properties

Set web hook request

Attribute	Type	Description
address	String	Ethereum scaffold address
webHook	String	Ethereum scaffold webhook for events

Open scaffold attributes

Attribute	Type	Description
description	String	Scaffold description
developerAddress	String	Scaffold developer address
webHook	String	Scaffold webhook

Save open scaffold request

Attribute	Type	Description
openKey	String	User open key
developerAddress	String	Scaffold developer address
description	String	Scaffold description
webHook	String	Scaffold webhook

Shareholder

Ethereum shareholder attributes

Attribute	Type	Description
address	String	Ethereum shareholder address
percent	Int	Ethereum shareholder percent

Add ethereum shareholder request

Attribute	Type	Description
address	String	Ethereum shareholder address
percent	Int	Ethereum shareholder percent

Update ethereum shareholder request

Attribute	Type	Description
address	String	Ethereum shareholder address
percent	Int	Ethereum shareholder percent

Remove ethereum shareholder request

Attribute	Type	Description
address	String	Ethereum shareholder address

Transaction

Ethereum transaction attributes

Attribute	Type	Description
scaffold	EthereumScaffold	Ethereum scaffold
event	Event	Event

Event

Each event has field type which define an event type

Activate ethereum scaffold event

Attribute	Type	Description
activated	Boolean	Ethereum scaffold state
type	String	"ACTIVATED_SCAFFOLD"

Added ethereum share holder event

Attribute	Type	Description
userAddress	String	Share holder address
partnerShare	BigInteger	Share holder share
type	String	"ADDED_SHARE_HOLDER"

Delete ethereum share holder event

Attribute	Type	Description
userAddress	String	Share holder address
type	String	"DELETED_SHARE_HOLDER"

Edit ethereum share holder event

Attribute	Type	Description
userAddress	String	Shareholder address
partnerShare	BigInteger	Shareholder share
type	String	"EDITED_SHARE_HOLDER"

Ethereum funds deposited event

Attribute	Type	Description
amount	BigInteger	Funds amount
toAddress	String	To address
type	String	"FUNDS_DEPOSITED"

Paid for ethereum shareholder event

Attribute	Type	Description
userAddress	String	Shareholder address
amount	BigInteger	Paid amount
type	String	"PAID_FOR_SHARE_HOLDER"

Payment completed event

Attribute	Type	Description
customerAddress	String	Customer address
transactionAmount	BigInteger	Paid amount
scaffoldTransactionIndex	BigInteger	Transaction index
properties	Map<String, Any>	Transaction properties
type	String	"PAYMENT_COMPLETED"

API

sender - an object that produces requests for each entity type

Ethereum scaffold

Scaffold

Kotlin:

val sender = open.ethereumScaffold()

Java:

EthereumScaffoldSender sender = open.ethereumScaffold()

Get All

Can be used with page request

Kotlin:

val scaffolds = sender.getAll()

Java:

PageResponse<EthereumScaffold> scaffolds = sender.getAll()

Response entity is PageResponse with param EthereumScaffold

Get one

Kotlin:

val scaffold = sender.get(address)

Java:

EthereumScaffold scaffold = sender.get(address)

address - Ethereum scaffold address

Response entity is EthereumScaffold

Deploy

Kotlin:

val scaffold = sender.deploy(DeployEthereumScaffoldRequest(openKey, developerAddress, description, fiatAmount, currency, 
                                                   conversionAmount, properties, webHook))

Java:

EthereumScaffold scaffold = sender.deploy(new DeployEthereumScaffoldRequest(openKey, developerAddress, description, fiatAmount, currency, 
                                                   conversionAmount, properties, webHook))

Request entity is DeployEthereumScaffoldRequest

Response entity is EthereumScaffold

Set webhook

Kotlin:

val scaffold = sender.setWebHook(SetWebHookRequest(address, webHook))

Java:

EthereumScaffold scaffold = sender.setWebHook(new SetWebHookRequest(address, webHook))

Request entity is SetWebHookRequest

Response entity is EthereumScaffold

Get summary

Kotlin:

val summary = sender.summary(address)

Java:

EthereumScaffoldSummary summary = sender.summary(address)

address - Ethereum scaffold address

Response entity is EthereumScaffoldSummary

Deactivate

Kotlin:

val summary = sender.deactivate(address)

Java:

EthereumScaffoldSummary summary = sender.deactivate(address)

address - Ethereum scaffold address

Response entity is EthereumScaffoldSummary

Get quota

Kotlin:

val quota = sender.quota()

Java:

EthereumScaffoldQuota quota = sender.quota()

Response entity is EthereumScaffoldQuota

Shareholder

Kotlin:

val sender = open.EthereumShareHolderSender(address)

Java:

EthereumShareHolderSender sender = open.EthereumShareHolderSender(address)

address - Ethereum scaffold address

Add

Kotlin:

val summary = sender.add(AddEthereumShareHolderRequest(address, percent))

Java:

EthereumScaffoldSummary summary = sender.add(new AddEthereumShareHolderRequest(address, percent))

Request entity is AddEthereumShareHolderRequest

Response entity is EthereumScaffoldSummary

Update

Kotlin:

val summary = sender.add(UpdateEthereumShareHolderRequest(address, percent))

Java:

EthereumScaffoldSummary summary = sender.add(new UpdateEthereumShareHolderRequest(address, percent))

Request entity is UpdateEthereumShareHolderRequest

Response entity is EthereumScaffoldSummary

Remove

Kotlin:

val summary = sender.add(RemoveEthereumShareHolderRequest(address))

Java:

EthereumScaffoldSummary summary = sender.add(new RemoveEthereumShareHolderRequest(address))

Request entity is RemoveEthereumShareHolderRequest

Response entity is EthereumScaffoldSummary

Ethereum transaction

Kotlin:

val sender = open.ethereumTransaction(address)

Java:

EthereumTransactionSender sender = open.ethereumTransaction(address)

address - Scaffold address

Get All

Can be used with page request

Kotlin:

val transactions = sender.getAll()

Java:

PageResponse<EhereumTransaction> transactions = sender.getAll()

Response entity is PageResponse with param EthereumTransaction

Open scaffold

Scaffold

Kotlin:

val sender = open.openScaffold()

Java:

OpenScaffoldSender sender = open.openScaffold()

Get all

Can be used with page request

Kotlin:

val scaffolds = sender.getAll()

Java:

PageResponse<OpenScaffold> scaffolds = sender.getAll()

Response entity is PageResponse with param OpenScaffold

Create

Kotlin:

val scaffold = sender.create(SaveOpenScaffoldRequest(openKey, developerAddress, description, webHook))

Java:

OpenScaffold scaffold = sender.create(new SaveOpenScaffoldRequest(openKey, developerAddress, description, webHook))

Request entity is SaveOpenScaffoldRequest

Response entity is OpenScaffold

OPEN Platform

Versions

Version
2.0.0 Dec 19, 2019
1.0.1 Aug 2, 2018
1.0.0 Jul 17, 2018
0.0.4 Jul 13, 2018
0.0.3 Jul 13, 2018

open-api-jvm-sdk

License

GroupId

ArtifactId

Last Version

Release Date

Type

Description

Project URL

Source Code Management

Download sdk

How to add to project

Dependencies

compile (8)

Project Modules

OpenJ

Content

Installing

Get started

Entity

Base

Page request attributes

Page response attributes

Scaffold

Ethereum scaffold attributes

Ethereum scaffold properties attributes

Ethereum scaffold summary attributes

Ethereum scaffold quota attributes

Deploy ethereum scaffold request

Set web hook request

Open scaffold attributes

Save open scaffold request

Shareholder

Ethereum shareholder attributes

Add ethereum shareholder request

Update ethereum shareholder request

Remove ethereum shareholder request

Transaction

Ethereum transaction attributes

Event

Activate ethereum scaffold event

Added ethereum share holder event

Delete ethereum share holder event

Edit ethereum share holder event

Ethereum funds deposited event

Paid for ethereum shareholder event

Payment completed event

API

Ethereum scaffold

Scaffold

Get All

Get one

Deploy

Set webhook

Get summary

Deactivate

Get quota

Shareholder

Add

Update

Remove

Ethereum transaction

Get All

Open scaffold

Scaffold

Get all

Create

OPEN Platform

Versions