Branch name will be changed

We will change the master branch to main on Dec 15, 2022. After the branch policy change, please check your local or forked repository settings.

Klaytn

Official golang implementation of the Klaytn protocol. Please visit KlaytnDocs for more details on Klaytn design, node operation guides and application development resources.

Building from Sources

Building the Klaytn node binaries as well as utility tools, such as kcn, kpn, ken, kbn, kscn, kspn, ksen, kgen, homi and abigen requires both a Go (version 1.14.1 or later) and a C compiler. You can install them using your favorite package manager. Once the dependencies are installed, run

make all (or make {kcn, kpn, ken, kbn, kscn, kspn, ksen, kgen, homi, abigen})

Executables

After successful build, executable binaries are installed at build/bin/.

Command	Description
`kcn`	The CLI client for Klaytn Consensus Node. Run `kcn --help` for command-line flags.
`kpn`	The CLI client for Klaytn Proxy Node. Run `kpn --help` for command-line flags.
`ken`	The CLI client for Klaytn Endpoint Node, which is the entry point into the Klaytn network (main-, test- or private net). It can be used by other processes as a gateway into the Klaytn network via JSON RPC endpoints exposed on top of HTTP, WebSocket, gRPC, and/or IPC transports. Run `ken --help` for command-line flags.
`kscn`	The CLI client for Klaytn ServiceChain Consensus Node. Run `kscn --help` for command-line flags.
`kspn`	The CLI client for Klaytn ServiceChain Proxy Node. Run `kspn --help` for command-line flags.
`ksen`	The CLI client for Klaytn ServiceChain Endpoint Node. Run `ksen --help` for command-line flags.
`kbn`	The CLI client for Klaytn Bootnode. Run `kbn --help` for command-line flags.
`kgen`	The CLI client for Klaytn Nodekey Generation Tool. Run `kgen --help` for command-line flags.
`homi`	The CLI client for Klaytn Helper Tool to generate initialization files. Run `homi --help` for command-line flags.
`abigen`	Source code generator to convert Klaytn contract definitions into easy to use, compile-time type-safe Go packages.

Both kcn and ken are capable of running as a full node (default) or an archive node (retaining all historical state).

Running a Core Cell

Core Cell (CC) is a set of one consensus node (CN) and one or more proxy nodes (PNs). Core Cell plays a role of generating blocks in the Klaytn network. We recommend to visit the CC Operation Guide for the details of CC bootstrapping process.

Running an Endpoint Node

Endpoint Node (EN) is an entry point from the outside of the network in order to interact with the Klaytn network. Currently, two official networks are available: Baobab (testnet) and Cypress (mainnet). Please visit the official EN Operation Guide.

Running a Service Chain Node

Service chain node is a node for Service Chain which is an auxiliary blockchain independent from the main chain tailored for individual service requiring special node configurations, customized security levels, and scalability for high throughput services. Service Chain expands and augments Klaytn by providing a data integrity mechanism and supporting token transfers between different chains. Although the service chain feature is under development, we provide the operation guide for testing purposes. Please visit the official document Service Chain Operation Guide. Furthermore, for those who are interested in the Klaytn Service Chain, please check out Klaytn - Scaling Solutions.

License

The Klaytn library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The Klaytn binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.

Contributing

As an open source project, Klaytn always welcomes your contribution. Please read our CONTRIBUTING.md for a walk-through of the contribution process.

Project Name	Stars	Repos Using This	Packages Using This	Most Recent Commit	Total Releases	Latest Release	Open Issues	License	Language
Pm2	39,172	5,370	1,435	14 days ago	275	February 17, 2022	778	other	JavaScript
Node.js Production Process Manager with a built-in Load Balancer.
Zx	37,571		435	2 days ago	77	September 18, 2022	51	apache-2.0	JavaScript
A tool for writing better scripts
30 Days Of Javascript	36,422			a day ago	1	January 25, 2022	254		JavaScript
30 days of JavaScript programming challenge is a step-by-step guide to learn JavaScript programming language in 30 days. This challenge may take more than 100 days, please just follow your own pace. These videos may help too: https://www.youtube.com/channel/UC7PNRuno1rzYPb1xLa4yktw
Awesome Cheatsheets	33,706			3 days ago			84	mit	JavaScript
👩‍💻👨‍💻 Awesome cheatsheets for popular programming languages, frameworks and development tools. They include everything you should know in one single file.
N8n	30,968	11	162	5 hours ago	120	September 23, 2022	305	other	TypeScript
Free and source-available fair-code licensed workflow automation tool. Easily automate tasks across different services.
Pkg	23,243	882	986	a month ago	96	July 13, 2022	58	mit	JavaScript
Package your Node.js project into an executable
Ava	20,377	44,279	29,305	2 days ago	104	September 04, 2022	92	mit	JavaScript
Node.js test runner that lets you develop with confidence 🚀
Svgo	19,281	281,763	2,549	21 hours ago	92	November 02, 2021	287	mit	JavaScript
⚙️ Node.js tool for optimizing SVG files
Inquirer.js	18,057	433,368	34,117	3 days ago	125	September 18, 2022	206	mit	JavaScript
A collection of common interactive command line user interfaces.
Nx	17,760	126	264	4 hours ago	846	September 23, 2022	628	mit	TypeScript
Smart, Fast and Extensible Build System