onix-labs / onixlabs-corda-core

An essential library for every Corda developer's toolkit comprising several features for contract and workflow design.

ONIXLabs Corda Core

The ONIXLabs Corda Core API provides Corda developers with a suite of APIs to empower development of Corda contracts, workflows and integration. These APIs are not intended to be used as CorDapps, since they do not contain any states or contracts, however they are partitioned into contract, workflow and integration modules containing features to improve and simplify CorDapp design and development.

CorDapp Signing

As of version 2.0.0 of the ONIXLabs Corda Core API, this repository ships with the ONIXLabs developer signing key so that this repository can be checked out and built locally. Official releases of this API are signed with the ONIXLabs production signing key.

Integration Guide

Follow these steps to integrate the ONIXLabs Corda Core API into your application

1. Add the following to your project's top level build.gradle file.

   buildscript {
       ext {
           onixlabs_group = 'io.onixlabs'
           onixlabs_corda_core_release_version = '2.0.0'
       }
   }
   

2. Implement the ONIXLabs Corda Core contract module into your contract.

   dependencies {
       cordapp "$onixlabs_group:onixlabs-corda-core-contract:$onixlabs_corda_core_release_version"
   }
   

3. Implement the ONIXLabs Corda Core workflow module into your workflow.

   dependencies {
       cordapp "$onixlabs_group:onixlabs-corda-core-workflow:$onixlabs_corda_core_release_version"
   }
   

4. Implement the ONIXLabs Corda Core integration module into your integration.

   dependencies {
       implementation "$onixlabs_group:onixlabs-corda-core-integration:$onixlabs_corda_core_release_version"
   }
   

Package Versioning

The ONIXLabs Corda Core API uses semantic versioning for every published release of the API. Version numbers apply the following format, major.minor.patch; for example 1.2.34

• Major - The API contains breaking changes which are not backwards compatible.
• Minor - The API contains new features which are backwards compatible.
• Patch - The API contains bug fixes which are backwards compatible.

Release Candidate versions are considered unstable and likely to change quickly. Release Candidate version numbers apply the following format, major.minor.patch-rc#; for example 1.2.0-rc3