Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 3.28 KB

README.md

File metadata and controls

85 lines (56 loc) · 3.28 KB
Raw

symbol-node-configurator

Build Status

This repository contains a few tools:

  • pemtool.py - allows conversion from raw private key to (encrypted) PEM file (openssl format)
  • certtool.py - openssl wrapper for easy certificate generation
  • votingkey.py - this is alternative voting key file generator
  • generate.py - actual catapult.server configuration generator, that will be described below

Prerequisites:

apt-get install python3 python3-pip openssl
python3 -m pip install -r requirements.txt

All commands below assume scripts are started from PARENT directory.

Pem tool

Get help:

python3 symbol-node-configurator/pemtool.py --help

Convert private key in hex format to encrypted PEM file

python3 symbol-node-configurator/pemtool.py --output ca.key.pem --ask-pass

Cert tool

Get help:

python3 symbol-node-configurator/certtool.py --help

Create symbol server certificates using ca.key.pem

python3 symbol-node-configurator/certtool.py --output certificates --ca ca.key.pem

Generate - config generator

Generator tool assumes that in working directory, there is directory called certificates that contains:

  • ca.pubkey.pem
  • ca.crt.pem
  • node.full.crt.pem
  • node.crt.pem
  • node.key.pem

When running with --harvesting switch, generator tool additionally expects:

  • private.harvesting.txt and private.vrf.txt, containing respectively harvesting private key and vrf private key in hex OR
  • private.harvesting.pem and private.vrf.pem pem files, containing private keys, if pem files are password protected --ask-pass switch needs to be present

When running with --voting switch, generator tool additionally expects voting key file:

  • private_key_tree*.dat - the file will be MOVED to destination directory,

note: in case of --voting if destination directory contains file with given name, the index will be incremented, until "empty" one will be found

Create configuration for api node

python3 symbol-node-configurator/generator.py --mode api --output ../settings

Create configuration for harvesting peer node

To create a configuration for harvesting node two files are needed, with keys in hex:

  • private.harvesting.txt
  • private.vrf.txt
echo "C0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FF" > private.harvesting.txt
echo "B007B007B007B007B007B007B007B007B007B007B007B007B007B007B007B007" > private.vrf.txt
python3 symbol-node-configurator/generator.py --mode peer --output ../settings

Create configuration for harvesting and voting peer node

echo "C0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FF" > private.harvesting.txt
echo "B007B007B007B007B007B007B007B007B007B007B007B007B007B007B007B007" > private.vrf.txt
python3 symbol-node-configurator/generator.py --mode peer --output ../settings --voting

Create configuration for harvesting and voting DUAL node

echo "C0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FFEC0FF" > private.harvesting.txt
echo "B007B007B007B007B007B007B007B007B007B007B007B007B007B007B007B007" > private.vrf.txt
python3 symbol-node-configurator/generator.py --mode dual --output ../settings --voting