Symbol-based networks rely on nodes to provide a trustless, high-performance, and secure blockchain platform.
These nodes are deployed using catapult-client 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 the developer documentation.
catapult-client code is organized as follows:
| Folder name | Description |
|---|---|
| /extensions | Modules that add features to the bare catapult-client. These capabilities are all optional because none of them impact consensus. |
| /external | External dependencies that are built with the client. |
| /plugins | Modules that introduce new and different ways to alter the chain's state via transactions. |
| /resources | Default properties. These can be configured per network and node. |
| /scripts | Utility scripts for developers. |
| /sdk | Reusable code used by tests and tools. |
| /seed | Nemesis blocks used in tests. |
| /src | Symbol's core engine. |
| /tests | Collection of tests. |
| /tools | Tools to deploy and monitor networks and nodes. |
Versioning starting with 1.0.0.0 release. Testnet releases use odd numbers for minor field.
| description | versions |
|---|---|
| example mainnet build numbers | 1.0.0.0, 1.2.x.x, 1.4.x.x, 2.2.x.x, 3.4.x.x |
| example testnet build numbers | 1.1.0.0, 1.3.x.x, 1.5.x.x, 2.3.x.x, 3.5.x.x |
To compile catapult-client source code, follow the developer notes.
catapult-client 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-client for various purposes.
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.
At the time of writing, the main public network has not been launched. Follow the latest updates about the public launch on the [Forum].
With Symbol, businesses can launch and extend private networks by developing custom plugins and extensions at the protocol level. The package Shoestring 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.
Instructions on how to launch a secure and production-ready private chain will be released here.
Before contributing please read this.
- Symbol Developer Documentation
- Symbol Technical Reference
- Join the community Discord server
- If you found a bug, open a new issue
Copyright (c) 2018 Jaguar0625, gimre, BloodyRookie, Tech Bureau, Corp Licensed under the GNU Lesser General Public License v3