ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2024-12-26 16:11:12 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
89191e9ef1
corda/docs/source/api-index.rst
Viktor Kolomeyko 71a2ac0bce Improve API page wording (#1784)
2017-10-03 11:02:16 +01:00

2.4 KiB
Raw Blame History

API

This section describes the APIs that are available for the development of CorDapps:

api-states api-persistence api-contracts api-vault-query api-transactions api-flows api-identity api-service-hub api-rpc api-core-types

Before reading this page, you should be familiar with the key concepts of Corda <key-concepts>.

Internal APIs and stability guarantees

Warning

For Corda 1.0 we do not currently provide a stable wire protocol or support for database upgrades. Additionally, the JSON format produced by the client-jackson module may change in future. Therefore, you should not expect to be able to migrate persisted data from 1.0 to future versions.

Additionally, it may be necessary to recompile applications against future versions of the API until we begin offering ABI stability as well. We plan to do this soon after the release of Corda 1.0.

Finally, please note that the 1.0 release has not yet been security audited. You should not run it in situations where security is required.

As of Corda 1.0, the following modules export public API that we promise to maintain backwards compatibility for, unless an incompatible change is required for security reasons:

  • core
  • client-rpc
  • client-jackson

The following modules don't yet have a completely stable API, but we will do our best to minimise disruption to developers using them until we are able to graduate them into the public API:

  • the Gradle plugins (cordformation)
  • node-driver
  • confidential-identities
  • test-utils
  • client-jfx, client-mock
  • finance
  • anything under the experimental directory (sub-components here may never graduate)

We hope to graduate the node-driver, test-utils and confidential-identities modules in the next feature release after 1.0. The bulk of the Corda API is found in the core module. Other modules should be assumed to be fully internal.

The web server module will be removed in future: you should build web front-ends for CorDapps using standard frameworks like Spring Boot, J2EE, Play, etc.

Code that falls into the following packages namespaces are for internal use only and not for public use:

  • Any package in the net.corda namespace which contains .internal
  • net.corda.node

In the future releases the node upon starting up will reject any CorDapps which uses classes from these packages.