ac1d14464c
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. |
||
|---|---|---|
| .idea | ||
| buildSrc | ||
| client | ||
| config | ||
| core | ||
| docs | ||
| experimental | ||
| finance | ||
| gradle/wrapper | ||
| gradle-plugins | ||
| lib | ||
| node | ||
| samples | ||
| test-utils | ||
| tools | ||
| .gitignore | ||
| build.gradle | ||
| CONTRIBUTING.md | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| publish.properties | ||
| README.md | ||
| settings.gradle | ||
| TRADEMARK | ||
Corda
Corda is a decentralised database system in which nodes trust each other as little as possible.
Features
- A P2P network of nodes
- Smart contracts
- Flow framework
- "Notary" infrastructure to validate uniqueness of transactions
- Written as a platform for distributed apps called CorDapps
- Written in Kotlin, targeting the JVM
Read our full and planned feature list here.
Getting started
Firstly, read the Getting started documentation.
Next, use the following guides to set up your dev environment:
-
If you are on Windows use this getting started guide which also explains through how to run the sample apps.
-
Alternatively if you are on Mac/Linux, watch this brief Webinar which walks through getting Corda, installing it, building it, running nodes and opening projects in IntelliJ.
After the above, watching the following webinars will give you a great introduction to Corda:
Webinar 1 – Introduction to Corda
Richard Brown, R3 Chief Technology Officer, explains Corda's unique architecture, the only distributed ledger platform designed by and for the financial industry's unique requirements. You may want to read the Corda non-technical whitepaper as pre-reading for this session.
Webinar 2 – Corda Developers’ Tutorial
Roger Willis, R3 Developer Relations Lead, provides an overview of Corda from a developer’s perspective and guidance on how to start building CorDapps. You may want to view Webinar 1 - Introduction to Corda as preparation for this session. NB. This was recorded for the M5 release.
Building on Corda
To build your own CorDapps:
- Clone the CorDapp Template repository
- Read the README (IMPORTANT!)
- Read the Writing a CorDapp documentation
To look at the Corda source and run some sample applications:
- Clone this repository
- To run some sample CorDapps, read the running the demos documentation
- Start hacking and contribute!
Useful links
- Project website
- Documentation
- [Slack channel] (https://slack.corda.net/)
- Forum
Development State
Corda is currently in very early development and should not be used in production systems. Breaking changes will happen on minor versions until 1.0. Experimentation with Corda is recommended.
Pull requests, experiments, and contributions are encouraged and welcomed.
Background
The project is supported by R3, a financial industry consortium, which is why it contains some code for financial use cases and why the documentation focuses on finance. The goal is to use it to construct a global ledger, simplifying finance and reducing the overheads of banking. But it is run as an open source project and the basic technology of a peer-to-peer decentralised database may be useful for many different projects.
Contributing
Please read here.
License
Acknowledgements
YourKit supports open source projects with its full-featured Java Profiler.
YourKit, LLC is the creator of YourKit Java Profiler and YourKit .NET Profiler, innovative and intelligent tools for profiling Java and .NET applications.