corda/docs/source/corda-repo-layout.rst
Joel Dudley f0138dfe17 Tutorial refresh for v1.0 and moving of code into separate files. (#1758)
* Moves code sections in tutorials to code files.

* Removes wallet references.

* Updates repo layout doc.

* Removes remaining cordapp-tutorial references, replaced with cordapp-example.

* Fixes broken link.

* Misc docs fixes.

* Refreshes the ServiceHub and rpc ops api pages.

* Updates the cheat sheet.

* Updates cookbooks.

* Refreshes the running-a-notary tutorial.

* Updates flow-testing tutorial

* Updates tear-offs tutorial.

* Refreshes integration-testing tutorial.

* Updates to contract tutorial and accompanying code to bring inline with V1 release.

* Refreshes contract-upgrade tutorial.

* Fixed broken code sample in "writing a contract" and updated contracts dsl.

* Added contract ref to java code. Fixed broken rst markup.

* Updates transaction-building tutorial.

* Updates the client-rpc and flow-state-machines tutorials.

* Updates the oracles tutorial.

* Amended country in X500 names from "UK" to "GB"

* Update FlowCookbook.kt

* Amended cheatsheet. Minor update on contract upgrades tutoraial.

* Added `extraCordappPackagesToScan` to node driver.

* Changes to match new function signature.

* Update to reflect change in location of cash contract name.
2017-10-02 10:11:33 +01:00

2.0 KiB

Corda repo layout

The Corda repository comprises the following folders:

  • buildSrc contains necessary gradle plugins to build Corda
  • client contains libraries for connecting to a node, working with it remotely and binding server-side data to JavaFX UI
  • confidential-identities contains experimental support for confidential identities on the ledger
  • config contains logging configurations and the default node configuration file
  • core containing the core Corda libraries such as crypto functions, types for Corda's building blocks: states, contracts, transactions, attachments, etc. and some interfaces for nodes and protocols
  • docs contains the Corda docsite in restructured text format
  • experimental contains platform improvements that are still in the experimental stage
  • finance defines a range of elementary contracts (and associated schemas) and protocols, such as abstract fungible assets, cash, obligation and commercial paper
  • gradle contains the gradle wrapper which you'll use to execute gradle commands
  • gradle-plugins contains some additional plugins which we use to deploy Corda nodes
  • lib contains some dependencies
  • node contains the core code of the Corda node (eg: node driver, node services, messaging, persistence)
  • node-api contains data structures shared between the node and the client module, e.g. types sent via RPC
  • samples contains all our Corda demos and code samples
  • testing contains some utilities for unit testing contracts (the contracts testing DSL) and flows (the mock network) implementation
  • tools contains the explorer which is a GUI front-end for Corda, and also the DemoBench which is a GUI tool that allows you to run Corda nodes locally for demonstrations
  • verifier allows out-of-node transaction verification, allowing verification to scale horizontally
  • webserver is a servlet container for CorDapps that export HTTP endpoints. This server is an RPC client of the node