Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 3.23 KB

README.md

File metadata and controls

53 lines (33 loc) · 3.23 KB
Raw

Clustered-Polkadot/Kusama-nodes

If you want to setup your own clusted polkadot or kusama nodes we hereby give you a guide that has enabled the clusted node service found on nnode.io. It was partly funded by the Web3 Foundation. Read more about it here: https://github.com/Validators/Nnode.io-Public-Node-Documentation/blob/master/nnode.md

The setup consists of these main parts:

  1. Developer portal for API-Key creation and transaction analytics
  2. Running blockchain nodes
  3. Reverse proxies with a node load balancer and API authentication

1 Developer portal

This step is not mandatory but gives you the capability to register several projects with their invidual API-Keys that can be used for transaction limits, load allocation, and analytics. If you only have one single project you can generate an API-Key manually by using the RandomKeyGenerator.GetUniqueKey(128) method found in the Utilities folder in the project to create the Api Secret, and just create a new Guid for the Api Key.

Option 1: Manually creating one API-Key set:

var apiKey = Guid.NewGuid();
var apiSecret = RandomKeyGenerator.GetUniqueKey(128);

Option 2: Setup developer portal for multiple users

Please follow the instructions from the "Developer Portal" repository to setup the developer portal: https://github.com/Validators/Developer-Portal

2 Running blockchain nodes

This is the actual Node Cluster that is part of the blockchain. When running several nodes behind a proxy you are able to perform node and OS updates with zero downtime and mitigate agains denial-of-service attacks. Please follow the excellent tutorial found at the main repository of Polkadot to familiaze yourself with running a node:

https://github.com/paritytech/polkadot

Then goto our Scripts repository that shows you how to run blockchain nodes as a service on Ubuntu along with different scripts to automate upgrades:

https://github.com/Validators/Polkadot-Infrastructure

You now have your API-Keys ready along with a couple of nodes running. Its time to setup the reverse proxy layer.

3 Reverse proxies

The proxy layer consists of custom implementations of HMAC API Authentication, and a Node load balancer. It uses the ProxyKit library created by Damian Hickey (https://github.com/damianh/ProxyKit).

Its a .Net Core Kestrel solution that can be deployed on Linux, Mac, and Windows.

Please goto the main "Proxies" repository for instructions on how to get started: https://github.com/Validators/Polkadot-Infrastructure/tree/master/Proxies

Finally, after setting up all three part up you have a clustered network of nodes running that can be manually tested using this guide: https://github.com/Validators/Nnode.io-Public-Node-Documentation.

In addition, the endpoint can be stress tested by using this example: https://github.com/Validators/Polkadot-Infrastructure/tree/master/Loadtests

You will now be able to create a DNS record that directs to your proxy server. For instance, Nnode.io has an kusama proxy endpoint at: https://kusama.nnoide.io that relays the traffic to a set of kusama nodes.

Please goto nnode.io to register for our free public nodes.

This software is released as open source under the Apache license version 2.0. Use at own risk.