corda/docs/source/setting-up-a-corda-network.rst
2016-12-02 18:11:08 +00:00

3.8 KiB

Introduction - What is a corda network?

A Corda network consists of a number of machines running nodes, including a single node operating as the network map service. These nodes communicate using persistent protocols in order to create and validate transactions.

There are four broader categories of functionality one such node may have. These pieces of functionality are provided as services, and one node may run several of them.

  • Network map: The node running the network map provides a way to resolve identities to physical node addresses and associated public keys.
  • Notary: Nodes running a notary service witness state spends and have the final say in whether a transaction is a double-spend or not.
  • Oracle: Network services that link the ledger to the outside world by providing facts that affect the validity of transactions.
  • Regular node: All nodes have a vault and may start protocols communicating with other nodes, notaries and oracles and evolve their private ledger.

Setting up your own network

Certificates

All nodes belonging to the same Corda network must have the same root CA. For testing purposes you can use certSigningRequestUtility.jar to generate a node certificate with a fixed test root:

# Build the jars
./gradlew buildCordaJAR
# Generate certificate
java -jar build/libs/certSigningRequestUtility.jar --base-dir NODE_DIRECTORY/

Configuration

A node can be configured by adding/editing node.conf in the node's directory. For details see corda-configuration-file.

An example configuration:

example-code/src/main/resources/example-node.conf

The most important fields regarding network configuration are:

  • artemisAddress: This specifies a host and port. Note that the address bound will NOT be my-corda-node, but rather :: (all addresses on all interfaces). The hostname specified is the hostname that must be externally resolvable by other nodes in the network. In the above configuration this is the resolvable name of a machine in a vpn.
  • webAddress: The address the webserver should bind. Note that the port should be distinct from that of artemisAddress.
  • networkMapAddress: The resolvable name and artemis port of the network map node. Note that if this node itself is to be the network map this field should not be specified.

Starting the nodes

You may now start the nodes in any order. Note that the node is not fully started until it has successfully registered with the network map!

You should see a banner, some log lines and eventually Node started up and registered, indicating that the node is fully started.

In terms of process management there is no prescribed method. You may start the jars by hand or perhaps use systemd and friends.

Logging

Only a handful of important lines are printed to the console. For details/diagnosing problems check the logs.

Logging is standard log4j2 and may be configured accordingly. Logs are by default redirected to files in NODE_DIRECTORY/logs/.

Connecting to the nodes

Once a node has started up successfully you may connect to it as a client to initiate protocols/query state etc. Depending on your network setup you may need to tunnel to do this remotely.

See the tutorial-clientrpc-api on how to establish an RPC link.

Sidenote: A client is always associated with a single node with a single identity, which only sees their part of the ledger.