mirror of
https://github.com/corda/corda.git
synced 2025-01-29 15:43:55 +00:00
Put missing content back into the toctree after a bad merge.
Fix a bunch of ReST markup errors.
This commit is contained in:
Mike Hearn
parent
43c61bfea1
commit
dbce25b575
@ -329,7 +329,7 @@ If an attachment constraint cannot be resolved, a ``MissingContractAttachments``
|
||||
``MissingContractAttachments`` exceptions:
|
||||
|
||||
Not setting CorDapp packages in tests
|
||||
*************************************
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You are running a test and have not specified the CorDapp packages to scan.
|
||||
When using ``MockNetwork`` ensure you have provided a package containing the contract class in ``MockNetworkParameters``. See :doc:`api-testing`.
|
||||
@ -368,14 +368,14 @@ Example of creation of two Cordapps with Finance App Flows and Finance App Contr
|
||||
);
|
||||
|
||||
Starting a node missing CorDapp(s)
|
||||
**********************************
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
When running the Corda node ensure all CordDapp JARs are placed in ``cordapps`` directory of each node.
|
||||
By default Gradle Cordform task ``deployNodes`` copies all JARs if CorDapps to deploy are specified.
|
||||
See :doc:`generating-a-node` for detailed instructions.
|
||||
|
||||
Wrong fully-qualified contract name
|
||||
***********************************
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
You are specifying the fully-qualified name of the contract incorrectly. For example, you've defined ``MyContract`` in
|
||||
the package ``com.mycompany.myapp.contracts``, but the fully-qualified contract name you pass to the
|
||||
|
||||
@ -542,7 +542,7 @@ Corda installs four initiating subflow pairs on each node by default:
|
||||
|
||||
.. warning:: ``SwapIdentitiesFlow``/``SwapIdentitiesHandler`` are only installed if the ``confidential-identities`` module
|
||||
is included. The ``confidential-identities`` module is still not stabilised, so the
|
||||
``SwapIdentitiesFlow``/``SwapIdentitiesHandler`` API may change in future releases. See :doc:`corda-api`.
|
||||
``SwapIdentitiesFlow``/``SwapIdentitiesHandler`` API may change in future releases. See :doc:`api-stability-guarantees`.
|
||||
|
||||
Corda also provides a number of built-in inlined subflows that should be used for handling common tasks. The most
|
||||
important are:
|
||||
|
||||
@ -44,7 +44,7 @@ Confidential identities
|
||||
-----------------------
|
||||
|
||||
.. warning:: The ``confidential-identities`` module is still not stabilised, so this API may change in future releases.
|
||||
See :doc:`corda-api`.
|
||||
See :doc:`api-stability-guarantees`.
|
||||
|
||||
Confidential identities are key pairs where the corresponding X.509 certificate (and path) are not made public, so that
|
||||
parties who are not involved in the transaction cannot identify the owner. They are owned by a well-known identity,
|
||||
|
||||
@ -26,6 +26,9 @@ The following modules form part of Corda's public API and we commit to API/ABI b
|
||||
* **Dummy Contracts (net.corda.testing.contracts)**: dummy state and contracts for testing purposes
|
||||
* **Mock Services (net.corda.testing.services)**: mock service implementations for testing purposes
|
||||
|
||||
Additionally, the **Tokens SDK (com.r3.corda.lib.tokens)** available in `the Tokens GitHub repository <https://github.com/corda/token-sdk>`_
|
||||
has a stable API.
|
||||
|
||||
.. _non-public-api:
|
||||
|
||||
Non-public API (experimental)
|
||||
@ -36,11 +39,13 @@ The following modules are not part of the Corda's public API and no backwards co
|
||||
* the incubating modules, for which we will do our best to minimise disruption to developers using them until we are able to graduate them into the public API
|
||||
* the internal modules, which are not to be used, and will change without notice
|
||||
|
||||
The **finance module** was the first CorDapp ever written and is a legacy module. Although it is not a part of our API guarantees, we also
|
||||
don't anticipate much future change to it. Users should use the tokens SDK instead.
|
||||
|
||||
Corda incubating modules
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
* **net.corda.confidential**: experimental support for confidential identities on the ledger
|
||||
* **net.corda.finance**: a range of elementary contracts (and associated schemas) and protocols, such as abstract fungible assets, cash, obligation and commercial paper
|
||||
* **net.corda.client.jfx**: support for Java FX UI
|
||||
* **net.corda.client.mock**: client mock utilities
|
||||
* **Cordformation**: Gradle integration plugins
|
||||
@ -8,7 +8,7 @@ Upgrading CorDapps to newer Platform Versions
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
These notes provide instructions for upgrading your CorDapps from previous versions. Corda provides backwards compatibility for public,
|
||||
non-experimental APIs that have been committed to. A list can be found in the :doc:`corda-api` page.
|
||||
non-experimental APIs that have been committed to. A list can be found in the :doc:`api-stability-guarantees` page.
|
||||
|
||||
This means that you can upgrade your node across versions *without recompiling or adjusting your CorDapps*. You just have to upgrade
|
||||
your node and restart.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
Checkpoint Tooling
|
||||
================
|
||||
==================
|
||||
|
||||
This page contains information about checkpoint tooling. These tools can be used to debug the causes of stuck flows.
|
||||
|
||||
|
||||
@ -371,7 +371,7 @@ Once an account has been moved, it is at the discretion of the previous host nod
|
||||
|
||||
The key idea is to decouple the creation of external IDs from the assigning of state participants to external IDs. As such, a table will be needed to hold the mapping from public keys to external IDs and there must exist a way to map states to these external IDs.
|
||||
|
||||
##### Entity to store `Key -> external ID` mapping
|
||||
#### Entity to store `Key -> external ID` mapping
|
||||
|
||||
The following exists in Corda 4.
|
||||
|
||||
@ -402,7 +402,7 @@ class PublicKeyHashToExternalId(
|
||||
}
|
||||
```
|
||||
|
||||
##### Key creation
|
||||
#### Key creation
|
||||
|
||||
When a new key pair is created, it can be assigned to an external ID, like so:
|
||||
|
||||
@ -418,7 +418,7 @@ fun freshKey(externalId: UUID): PublicKey {
|
||||
|
||||
This exists in Corda 4 and is accessible from the `KeyManagementService`.
|
||||
|
||||
##### Transaction recording
|
||||
#### Transaction recording
|
||||
|
||||
Public key hashes must be are stored for each state. This enables each state party to be mapped to an external ID.
|
||||
|
||||
@ -457,7 +457,7 @@ class PersistentParty(
|
||||
}
|
||||
```
|
||||
|
||||
##### State querying
|
||||
#### State querying
|
||||
|
||||
Create a view called `StateToExternalId` based upon joining the `PublicKeyHashToExternalId` and `PersistentParty` tables.
|
||||
|
||||
|
||||
@ -22,4 +22,5 @@ Design Docs
|
||||
data-model-upgrades/migrate-to-signature-constraint.md
|
||||
versioning/contract-versioning.md
|
||||
linear-pointer/design.md
|
||||
maximus/design.md
|
||||
maximus/design.md
|
||||
accounts/design.md
|
||||
@ -15,7 +15,7 @@ A good example to examine for learning how to unit test flows is the ``ResolveTr
|
||||
flow takes care of downloading and verifying transaction graphs, with all the needed dependencies. We start
|
||||
with this basic skeleton:
|
||||
|
||||
.. literalinclude:: ../../core/src/test/kotlin/net/corda/core/internal/ResolveTransactionsFlowTest.kt
|
||||
.. literalinclude:: ../../core-tests/src/test/kotlin/net/corda/coretests/internal/ResolveTransactionsFlowTest.kt
|
||||
:language: kotlin
|
||||
:start-after: DOCSTART 3
|
||||
:end-before: DOCEND 3
|
||||
@ -25,7 +25,7 @@ of the notary in our test network, which will come in handy later. We also tidy
|
||||
|
||||
Next, we write a test case:
|
||||
|
||||
.. literalinclude:: ../../core/src/test/kotlin/net/corda/core/internal/ResolveTransactionsFlowTest.kt
|
||||
.. literalinclude:: ../../core-tests/src/test/kotlin/net/corda/coretests/internal/ResolveTransactionsFlowTest.kt
|
||||
:language: kotlin
|
||||
:start-after: DOCSTART 1
|
||||
:end-before: DOCEND 1
|
||||
@ -44,7 +44,7 @@ on the node's persistent state.
|
||||
|
||||
Here's what ``makeTransactions`` looks like:
|
||||
|
||||
.. literalinclude:: ../../core/src/test/kotlin/net/corda/core/internal/ResolveTransactionsFlowTest.kt
|
||||
.. literalinclude:: ../../core-tests/src/test/kotlin/net/corda/coretests/internal/ResolveTransactionsFlowTest.kt
|
||||
:language: kotlin
|
||||
:start-after: DOCSTART 2
|
||||
:end-before: DOCEND 2
|
||||
|
||||
@ -55,18 +55,18 @@ The set-up instructions are available for the following platforms:
|
||||
|
||||
* :ref:`fedora-label`
|
||||
|
||||
.. _windows-label:
|
||||
|
||||
.. note:: These setup instructions will guide you on how to install the Oracle JDK. Each JDK can be found on their respective sites:
|
||||
|
||||
* `Oracle <http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html>`_
|
||||
* `Oracle Downloads <http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html>`_
|
||||
|
||||
* `Amazon Corretto <https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html>`_
|
||||
* `Amazon Corretto Downloads <https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html>`_
|
||||
|
||||
* `Red Hat OpenJDK <https://developers.redhat.com/products/openjdk/download/>`_
|
||||
|
||||
* `Zulu OpenJDK <https://www.azul.com/downloads/zulu/>`_
|
||||
|
||||
.. _windows-label:
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
@ -205,7 +205,7 @@ Next, read through the :doc:`Corda Key Concepts <key-concepts>` to understand ho
|
||||
|
||||
By then, you'll be ready to start writing your own CorDapps. Learn how to do this in the
|
||||
:doc:`Hello, World tutorial <hello-world-introduction>`. You may want to refer to the
|
||||
:doc:`API documentation <corda-api>`, the :doc:`flow cookbook <flow-cookbook>` and the
|
||||
API documentation in the sidebar, the :doc:`flow cookbook <flow-cookbook>` and the
|
||||
`samples <https://www.corda.net/samples/>`_ along the way.
|
||||
|
||||
If you encounter any issues, please ask on `Stack Overflow <https://stackoverflow.com/questions/tagged/corda>`_ or via
|
||||
|
||||
@ -62,7 +62,6 @@ Welcome to Corda !
|
||||
release-notes
|
||||
app-upgrade-notes
|
||||
node-upgrade-notes
|
||||
corda-api
|
||||
cheat-sheet
|
||||
|
||||
.. toctree::
|
||||
@ -79,9 +78,29 @@ Welcome to Corda !
|
||||
node-internals-index.rst
|
||||
component-library-index.rst
|
||||
serialization-index.rst
|
||||
json.rst
|
||||
versioning-and-upgrades.rst
|
||||
cordapp-advanced-concepts.rst
|
||||
troubleshooting.rst
|
||||
|
||||
.. toctree::
|
||||
:caption: Corda API
|
||||
:maxdepth: 1
|
||||
:titlesonly:
|
||||
|
||||
api-contracts.rst
|
||||
api-contract-constraints.rst
|
||||
api-core-types.rst
|
||||
api-flows.rst
|
||||
api-identity.rst
|
||||
api-persistence.rst
|
||||
api-rpc.rst
|
||||
api-service-classes.rst
|
||||
api-service-hub.rst
|
||||
api-states.rst
|
||||
api-testing.rst
|
||||
api-transactions.rst
|
||||
api-vault-query.rst
|
||||
|
||||
.. toctree::
|
||||
:caption: Operations
|
||||
:maxdepth: 2
|
||||
|
||||
@ -17,7 +17,8 @@ The ledger
|
||||
|
||||
|
||||
The Ledger Data
|
||||
--------
|
||||
---------------
|
||||
|
||||
In Corda, there is **no single central store of data**. Instead, each node maintains its own database of those facts that it is aware of.
|
||||
|
||||
The facts that a node knows about are those that it is involved with. For example, if there are nodes representing Alice and Bob on the network and Alice loans Bob some money, both Alice and Bob will store an identical record of the facts about that loan. If the only parties involved with the loan are Alice and Bob, then they will be the only nodes that ever see or store this data.
|
||||
|
||||
@ -8,5 +8,6 @@ Serialization
|
||||
cordapp-custom-serializers
|
||||
serialization-default-evolution.rst
|
||||
serialization-enum-evolution.rst
|
||||
json.rst
|
||||
blob-inspector
|
||||
wire-format.rst
|
||||
|
||||
@ -138,8 +138,7 @@ After completing this tutorial, your CorDapp should look like this:
|
||||
* Kotlin: https://github.com/corda/corda-tut2-solution-kotlin
|
||||
|
||||
You should now be ready to develop your own CorDapps. You can also find a list of sample CorDapps
|
||||
`here <https://www.corda.net/samples/>`_. As you write CorDapps, you'll also want to learn more about the
|
||||
:doc:`Corda API <corda-api>`.
|
||||
`here <https://www.corda.net/samples/>`_. You are now ready to learn more about the Corda API.
|
||||
|
||||
If you get stuck at any point, please reach out on `Slack <https://slack.corda.net/>`_ or
|
||||
`Stack Overflow <https://stackoverflow.com/questions/tagged/corda>`_.
|
||||
|
||||
@ -35,7 +35,7 @@ To enable the service, add the following to the node configuration:
|
||||
}
|
||||
|
||||
Testing your custom notary service
|
||||
---------------------------------
|
||||
----------------------------------
|
||||
|
||||
To create a flow test that uses your custom notary service, you can set the class name of the custom notary service as follows in your flow test:
|
||||
|
||||
|
||||
@ -18,6 +18,7 @@ the world changes is a key part of any professionally built software.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
api-stability-guarantees
|
||||
versioning
|
||||
upgrading-cordapps
|
||||
cordapp-constraint-migration
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user