Installation and usage of the platform
If your project or solution requires an independent blockchain, you can deploy your own blockchain network based on the Waves Enterprise platform. Contact the Technical Support Service, and our experts will help you configure the platform delivery to meet the needs of your project.
However, if you need to change any settings or configure the platform by yourself, this section provides a step-by-step guide for deploying and manual configuring the platform for a private network.
The order of creating node accounts, signing the genesis block and starting the network in the commercial version of the platform may be different from that described in this section. This procedure is presented in the documentation for the commercial version of the platform. For more information, contact the Waves Enterprise sales team by email: firstname.lastname@example.org.
Create accounts for each node of your future network.
A node account includes an address and a key pair – a public key and a private key.
To generate the keys use the AccountsGeneratorApp utility, which is included in the generator package. You can download this package from the official repository of Waves Enterprise on GitHub selecting the platform version you use.
The address and the public key will be shown on the command line during account creation using the generator utility. Node’s private key is written to the key storage file
keystore.dat, which is placed in the directory of the node.
To create an account, the
accounts.conf configuration file is used, which contains the account generation parameters. This file is located in the directory of each node.
To create a node account, go to its directory and place the downloaded generator-x.x.x.jar (where x.x.x is the number of the blockchain platform release) file into it. Then run it entering the
accounts.conf file as an argument:
java -jar generator-x.x.x.jar AccountsGeneratorApp accounts.conf
When you create a key pair, you can make up your own password to protect the node’s key pair. Later on, you can use it manually every time you start your node, or you can set global variables to ask for the password at system startup. See the description of the account generator for more information on how to use the password for a node key pair.
If you do not want to use a password to protect the key pair, press the
Enter key, leaving the field blank.
The following messages will be displayed as a result of the utility operation:
2021-02-09 16:03:18,940 INFO [main] c.w.g.AccountsGeneratorApp$ - 1 Address: 3Nu7MwQ1eSmDVwBzrN1nyzR8wqb2yzdUcyN; public key: F4ytnnS6H72ypCEpgNKYftGotpdX83ZxtWRX2dyGzDiA 2021-02-09 16:03:18,942 INFO [main] c.w.g.AccountsGeneratorApp$ - Generator done
keystore.dat file will be created in the directory of the node, which contains the account’s public key.
Following files are used for configuration of the platform:
node.confis the main configuration file of a node, which defines its operating principles and a set of options.
api-key-hash.confis a configuration file for generating
privacy-api-key-hashfield values; it is used to configure node authorization when authorization by
api-keyhash method is selected. The guidelines for working with this configuration file will be given when configuring the authorization method of the node.
You can setup node configuration parameters in a single file or in several files, including one file into another, for example:
include required(file("network.conf")) include required(file("local.conf"))
Put the parameters common for all nodes in one file and set unique node parameters (such as
owner-address) in a separate file for each node.
Below is a step-by-step guide on how to manually configure a single node to work on a private network. If you have multiple nodes deployed on your network, you will need to perform similar configuration steps for each of them.
Step 1. General configuration of the platform
This step configures cryptography, consensus, Docker smart contract execution and mining. All the parameters required for this are located in the node.conf file.
Step 2. Precise platform configuration
This step configures the node’s gRPC and REST API tools, their authorization, confidential data access groups, etc. You may need these settings if you change the pre-set settings for your hardware or software configuration.
All necessary parameters are also located in the node.conf node configuration file. The api-key-hash.conf file is also used to configure authorization, which is necessary when selecting the authorization method by a given api-key string hash.
- Precise platform configuration: gRPC and REST API authorization
- Precise platform configuration: node gRPC and REST API configuration
- Precise platform configuration: TLS
- Precise platform configuration: confidential data groups configuration
- Precise platform configuration: logging
- Precise platform configuration: anchoring
- Precise platform configuration: snapshot
- Precise platform configuration: node in the watcher mode
Full examples of configuration files to configure each node are given by here.
To deploy the platform on a private network, you need to get the kind of license that suits your purposes: trial, commercial or non-commercial.
The opensource version of the Waves Enterprise blockchain platform does not require a license.
The license to run a node is tied to the node owner’s key. The license contains the address of the node for which the license is issued.
To discuss the details of your license, contact Waves Enterprise Sales at email@example.com.
After that, you will be sent the license file. Place the file into the folder whose path is specified in the
license-file parameter of the node configuration file.
Before deployment, read the blockchain platform system requirements.
After configuring your network’s nodes, you must create a genesis block, the first private blockchain block which contains the transactions that determine a node’s initial balance and permissions.
A genesis block is signed by the GenesisBlockGenerator utility included in the generator package. It uses the
node.conf node configuration file that you set up as an argument:
java -jar generator-x.x.x.jar GenesisBlockGenerator node.conf
As a result, the utility fills the
signature fields located in the
genesis block of the
blockchain section in the node configuration file with the generated values of the public key and signature of the genesis block.
genesis-public-key-base-58: "4ozcAj...penxrm" signature: "5QNVGF...7Bj4Pc"
After signing the genesis block, the platform is fully configured and ready to run the network.
You can launch the network using one of the following docker container administration tools:
If you plan to use Docker Compose to launch the network, follow the same process you use for the trial mode.
If you plan to use Kubernetes to launch the network, launch it according to the instructions received from the Waves Enterprise Technical Support Team.
Once the network is up and running, attach the Waves Enterprise Client application to it: with this, network users can send transactions to the blockchain, as well as broadcast and call smart contracts.
Open your browser and enter the network address of your computer with the deployed node software in the address bar.
Register to the web client using any valid email address and log in to the web client.
Open the Select address -> Create address page. To open the menu after the first login, you must enter the password that you entered when you registered your account.
Select Add address from the node keystore and click Continue.
Fill in the fields below. The required values are given in the
credentials.txtfile for the first node in the working directory.
Address name – specify the name of the node;
Node URL – specify the
http://<computer network address>/<node address>value;
Type of authorization on the node – select the authorization type you configured earlier: by JWT-token or by
Blockchain address – specify the address of your node;
Key pair password – specify the password to the node key pair if you have set it up while generating the account.
Client description is provided in the Client article.