Code Monkey home page Code Monkey logo

catapult-client's Introduction

catapult-client

docs build rel build dev docker

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.

Package Organization

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

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

Building the Image

To compile catapult-client source code, follow the developer notes.

Running catapult-client

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.

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.

Contributing

Before contributing please read this.

Getting Help

License

Copyright (c) 2018 Jaguar0625, gimre, BloodyRookie, Tech Bureau, Corp Licensed under the GNU Lesser General Public License v3

catapult-client's People

Contributors

jaguar0625 avatar gimre-xymcity avatar bloodyrookie avatar segfaultxavi avatar dgarcia360 avatar wayonb avatar anthonylaw avatar jontey avatar kemi04 avatar ryo-opening-line avatar

Stargazers

Mabel Oza avatar

Forkers

resoftware-org

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.