corda/docs/source/index.rst
2017-06-05 17:04:59 +01:00

5.0 KiB

Welcome to the Corda documentation!

Warning

This build of the docs is from the "" branch, not a milestone release. It may not reflect the current state of the code. Read the docs for milestone release M11.1.

Corda is an open-source distributed ledger platform. The latest milestone (i.e. stable) release is M11.1. The codebase is on GitHub, and our community can be found on Slack and in our forum.

If you're new to Corda, you should start by learning about its motivating vision and architecture. A good introduction is the Introduction to Corda webinar and the Introductory white paper. As you become more familiar with Corda, readers with a technical background will also want to dive into the Technical white paper, which describes the platform's envisioned end-state.

Note

Corda training is now available in London, New York and Singapore! Learn more.

Corda is designed so that developers can easily extend its functionality by writing CorDapps (Corda Distributed Applications). Some example CorDapps are available in the Corda repo's samples directory. To run these yourself, make sure you follow the instructions in getting-set-up, then go to running-the-demos.

If, after running the demos, you're interested in writing your own CorDapps, you can use the CorDapp template as a base. A simple example CorDapp built upon the template is available here, and a video primer on basic CorDapp structure is available here.

From there, you'll be in a position to start extending the example CorDapp yourself (e.g. by writing new states, contracts, and/or flows). For this, you'll want to refer to this docsite, and to the tutorials in particular. If you get stuck, get in touch on Slack or the forum.

Once you're familiar with Corda and CorDapp development, we'd encourage you to get involved in the development of the platform itself. Find out more about contributing to Corda.

Documentation Contents:

getting-set-up tutorial-cordapp running-the-demos CLI-vs-IDE

key-concepts key-concepts-ecosystem key-concepts-ledger key-concepts-states key-concepts-contracts key-concepts-transactions key-concepts-flows key-concepts-consensus key-concepts-notaries key-concepts-time-windows key-concepts-oracles key-concepts-node key-concepts-tradeoffs

cordapp-overview writing-cordapps api api-states api-contracts api-transactions api-flows api-core-types cheat-sheet

running-a-node clientrpc shell node-administration corda-configuration-file out-of-process-verification

setting-up-a-corda-network permissioning versioning

tutorial-contract tutorial-contract-clauses tutorial-test-dsl contract-upgrade tutorial-integration-testing tutorial-clientrpc-api tutorial-building-transactions flow-state-machines flow-testing running-a-notary using-a-notary oracles tutorial-attachments event-scheduling

network-simulator demobench node-explorer azure-vm loadtesting

node-services vault serialization messaging persistence

flow-library contract-catalogue financial-model contract-irs

release-process release-notes changelog publishing-corda codestyle

faq

troubleshooting

clauses merkle-trees json secure-coding-guidelines corda-repo-layout building-the-docs

glossary