Server

Symbol-based networks rely on nodes to provide a trustless, high-performance, and secure blockchain platform.

These nodes are deployed using catapult-server software, a C++ rewrite of the previous Java-written NEM distributed ledger that has been running since 2015.

Learn more about the protocol by reading the Whitepaper and this documentation.

Building the image

To compile catapult-server source code, follow the building instructions.

Running catapult-server

catapult-server executable can be used either to run different types of nodes or to launch new networks. This section contains the instructions on how to run the catapult-server for various purposes.

Test network node

Developers can deploy test net nodes to experiment with the offered transaction set in a live network without the loss of valuable assets.

To run a test net node, follow this guide.

Main network node

At the time of writing, the main public network has not been launched. Follow the latest updates about the public launch on the Forum.

Private test network

With Symbol, businesses can launch and extend private networks by developing custom plugins and extensions at the protocol level. The package Service Bootstrap contains the necessary setup scripts to deploy a network for testing and development purposes with just one command.

To run a private test net, follow this guide.

Private network

Instructions on how to launch a secure and production-ready private chain will be released here.

Tools

Catapult server comes with tools to check the health of the network, generate nemesis blocks, create keypairs, recover the server in the event of an abrupt exit, and more.

You can find them inside of catapult-server/build/bin.

catapult.tools.address

Generates keypairs and addresses.

Options

-h [ --help ]     print help message
-l [ --loggingConfigurationPath ] arg
                  the path to the logging configuration file
-g [ --generate ] arg (=10)
                  number of random keys to generate
-p [ --public ] arg
                  show address associated with public key
-s [ --secret ] arg
                  show address and public key associated with private key
-n [ --network ] arg (=public)
                  network, possible values: mijin, mijin-test, public (default), public-test
-e [ --useHighEntropySource ]
                  true if a high entropy source should be used for randomness

Command

./catapult.tools.address -g  10 -n mijin-test

If you want the save the output, add an output stream at the end:

./catapult.tools.address -g  10 -n mijin-test > myKeys.txt.

catapult.tools.nemgen

Creates a nemesis block out of a mijin-test.properties file. The output generated is used to start a new chain.

Options

-h [ --help ]     print help message
-l [ --loggingConfigurationPath ] arg
                the path to the logging configuration file
-r [ --resources ] arg (=..)
                the path to the resources directory
-p [ --nemesisProperties ] arg
                the path to the nemesis properties file
-s [ --summary ] arg
                the path to summary output file (default: <bindir>/summary.txt)
-n [ --no-summary ]
                don't generate summary file
-t [ --useTemporaryCacheDatabase ]
                true if a temporary cache database should be created and destroyed

Command

./catapult.tools.nemgen -p <nemesis_block_properties_path> -r <resources_path>

catapult.tools.benchmark

Executes CPU-based performance tests of catapult functions, such as hashing or encryption.

Options

-h [ --help ]     print help message
-l [ --loggingConfigurationPath ] arg
                  the path to the logging configuration file
-t [ --num threads ] arg (=0)
                  the number of threads
-p [ --num partitions ] arg (=0)
                  the number of partitions
-o [ --ops / partition ] arg (=1000)
                  the number of operations per partition
-s [ --data size ] arg (=148)
                  the size of the data to generate

Command

./catapult.tools.benchmark

catapult.tools.network

Outputs node info, partner node connectivity info, and a partner node table for known peers within peers-p2p.json and peers-api.json.

Options

-h [ --help ]     print help message
-l [ --loggingConfigurationPath ] arg
                  the path to the logging configuration file
-r [ --resources ] arg (=..)
                  the path to the resources directory

Command

./catapult.tools.network -r <resources_path>

catapult.tools.statusgen

Generates the list of status errors that the server might return after receiving a transaction.

Options

-h [ --help ]     print help message
-l [ --loggingConfigurationPath ] arg
                  the path to the logging configuration file

Command

./catapult.tools.statusgen

catapult.tools.health

Checks the health and displays statistics (like the unconfirmed transaction cache) for the nodes found inside of peers-p2p.json and peers-api.json.

Options

-h [ --help ]     print help message
-l [ --loggingConfigurationPath ] arg
                  the path to the logging configuration file
-r [ --resources ] arg (=..)
                  the path to the resources directory

./catapult.tools.health -r <resources_path>