corda/docs/source/index.rst

2.8 KiB

Welcome to the Corda documentation!

Warning

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

This is the developer guide for Corda, a proposed architecture for distributed ledgers. Here are the sources of documentation you may find useful, from highest level to lowest:

  1. The Introductory white paper describes the motivating vision and background of the project. It is the kind of document your boss should read. It describes why the project exists and briefly compares it to alternative systems on the market.
  2. The Technical white paper describes the entire intended design from beginning to end. It is the kind of document that you should read, or at least, read parts of. Note that because the technical white paper describes the intended end state, it does not always align with the implementation.
  3. This user guide. It describes how to use the system to write apps, as currently implemented. It assumes you already have read the relevant sections of the technology white paper and now wish to learn how to use it.
  4. The API docs.

Read on to learn:

inthebox getting-set-up getting-set-up-fault-finding running-the-demos CLI-vs-IDE

data-model transaction-data-types merkle-trees consensus clauses

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 initial-margin-agreement

contract-catalogue contract-irs

loadtesting setting-up-a-corda-network secure-coding-guidelines release-process release-notes codestyle building-the-docs

glossary