First draft Re-structured Key Concepts; added plenty of diagrams; additional content. Added references to other security docs. Re-structured Key Concepts; added plenty of diagrams; additional content. Added references to other security docs. Updated information, indexes and images. Incorporated feedback from PR review comments (RGB, RW) Reformatted diagrams and incorporated feedback from PR reviewers. Addressed formatting problems. Updated Flow Framework diagram Added colour coding to Flow Framework diagram to aid readibility. Small clarification to vault unconsumed state usage. Added tutorial reference as suggested by RGB Updated TOC tree. Updates following PR review comment from Roger First pass updates following PR review comments from MH. Further updates following PR review (including 2 edited diagrams) Diagram changes and minor text edits following review with MGB Remove unused diagrams. Fixed spurious indentation errors. Changes following review and feedback from JD. Added clauses and merkle-trees back into TOC. Added small sub-section on transaction representation in Data Model. Added future work as note in Vault. Minor updates to diagrams following MH review. Updated Corda Ecosystem diagram. Minor changes to Core & Financial docs following PR review by MH. Updated following review by MBG.
4.2 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 M7.
Corda is an open-source distributed ledger platform. The latest milestone (i.e. stable) release is M7. 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 they 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.
Corda is designed so that developers can easily extend its functionality by writing CorDapps (Corda Distributed Applications). An example CorDapp is available on Github. To get it running, follow the instructions in the readme, or watch the Corda Developers Tutorial.
Additional CorDapp samples are available in the Corda repo's samples directory. These are sophisticated CorDapps that implement more complex functionality. You can find directions for running these samples 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:
inthebox getting-set-up getting-set-up-fault-finding running-the-demos CLI-vs-IDE
key-concepts key-concepts-ecosystem key-concepts-data-model key-concepts-core-types key-concepts-financial-model key-concepts-flow-framework key-concepts-consensus-notaries key-concepts-vault key-concepts-security-model
creating-a-cordapp tutorial-cordapp
clientrpc messaging persistence node-administration corda-configuration-file corda-plugins node-services node-explorer permissioning
tutorial-contract tutorial-contract-clauses tutorial-test-dsl 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 clauses merkle-trees
contract-catalogue contract-irs
loadtesting setting-up-a-corda-network secure-coding-guidelines release-process release-notes codestyle building-the-docs further-notes-on-kotlin publishing-corda azure-vm
glossary