Skip to content

Latest commit

 

History

History
235 lines (152 loc) · 10.2 KB

RUNNETWORKLIN.md

File metadata and controls

235 lines (152 loc) · 10.2 KB
Raw

Running a Private Network on Ubuntu 18.04 (LTS)

The instructions below describe the minimum amount of changes to run a network from the catapult-client build.

NOTE: Replace private-test occurrences with the network type selected. The possible network values are: private, private-test, public and public-test.

Prerequisites

  • Have built catapult-client following either Conan or manual instructions.

Copy the configuration template

After building catapult-client, copy the configuration templates from the root folder of the repository under the _build directory.

cd catapult-client/_build
cp ../resources/* resources/
cp ../tools/nemgen/resources/private-test.properties resources/

WARNING: Using the default configuration values in production environments is NOT recommended.

Generate accounts

Generate a set of accounts. The accounts stored in the file nemesis.addresses.txt will be used at a later step to receive the network's currency and harvest mosaics on the first block.

./bin/catapult.tools.addressgen --count 10 --network private-test --output nemesis.addresses.txt --suppressConsole
cat nemesis.addresses.txt

The script generates ten accounts for the nemesis block, but the number of accounts is customizable.

Create the seed and transactions directory

  1. Create a directory to save the generated nemesis block under catapult-client/_build.

    mkdir -p seed/00000

  2. Create a directory to save additional transactions embedded in the nemesis block.

    mkdir txes

Edit the nemesis block

catapult-client calls the first block in the chain the nemesis block. The first block is defined before launching a new network and sets the initial distribution of mosaics.

The file resources/private-test.properties defines the transactions issued in the nemesis block.

  1. Open private-test.properties and edit the [nemesis] section. Replace nemesisGenerationHashSeed with a unique SHA3-256 hash that will identify the network and nemesisSignerPrivateKey with a private key from nemesis.addresses.txt.

    [nemesis]

networkIdentifier = private-test
nemesisGenerationHashSeed = 57F7DA205008026C776CB6AED843393F04CD458E0AA2D9F1D5F31A402072B2D6
nemesisSignerPrivateKey = ●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●

  2. Replace [cpp] and [output] sections with the following configuration.

    [cpp]

cppFileHeader =

[output]

cppFile =
binDirectory = ../seed

  3. Edit the [distribution] and [mosaics] sections. The accounts defined under each distribution list (For example distribution>cat:currency and distribution>cat:harvest) will receive mosaics units. Replace at least one address in each list with an address from nemesis.addresses.txt.

    The total amount of units distributed must match the supply defined in the [mosaic] sections (For example mosaic>cat:currency and mosaic>cat:harvest).

    WARNING: Do not add the nemesisSignerPrivateKey account to the distribution list. The nemesis signer account cannot announce or participate in transactions. The mosaics received by the nemesis account will be lost forever.

    Here is an example of how the distribution list looks like after replacing some addresses:

    [distribution>cat:currency]

SAIBNNG7QJXY54Z334HOKA36NTH7FRRCKFRM4XY = 409'090'909'000'000
...

[distribution>cat:harvest]

SBMEZB54VXTH4PRAUJJQJJFB2SNQZQ2SUI6J7BA = 1'000'000
...

    Your addresses should be different, as catapult.tools.addressgen generates different accounts after every execution. Make sure that someone holds the private keys associated with every address listed before the network is launched.

  4. Edit the [transactions] section.

    [transactions]

transactionsDirectory = ../txes

  5. Continue editing the nemesis block properties to fit your network requirements and save the configuration before moving to the next step.

Edit the network properties

The file resources/config-network.properties defines the network configuration. Learn more about each network property in this guide.

Edit the properties file to match the nemesis block with the desired network configuration. Important properties to check are:

  • initialCurrencyAtomicUnits: Initial currency units available in the network, as specified in the supply property in the [mosaic>cat:currency] in private-test.properties.
  • totalChainImportance: Total importance units available in the network.
    • The sum of all mosaics distributed in the distribution>cat:harvest section in private-test.properties must be divisible by this number.
    • The result of the division must be a non-negative power of ten.
    • For example, if 500 mosaics have been distributed by the nemesis block, totalChainImportance could be 500, 50 or 5.
  • identifier: Network identifier, must be one of private, private-test, public or public-test.
  • nemesisSignerPublicKey: The public key corresponding to the nemesisSignerPrivateKey used in private-test.properties.
  • generationHashSeed: The same value used as nemesisGenerationHashSeed in private-test.properties.
  • harvestNetworkFeeSinkAddress: Address of the harvest network fee sink account.
  • mosaicRentalFeeSinkAddress: Address of the mosaic rental fee sink account.
  • namespaceRentalFeeSinkAddress: Address of the namespace rental fee sink account.

Append the VRF Keys to the nemesis block

The process of creating new blocks is called harvesting. Each node of the network can host zero or more harvester accounts to create new blocks and get rewarded.

In order to be an eligible harvester, the account must:

  1. Own an amount of harvesting mosaics (harvestingMosaicId) between minHarvesterBalance and maxHarvesterBalance as defined in config-network.properties.

    See Configuring network properties.

  2. Announce a valid VrfKeyLinkTransaction. The VRF transaction links the harvester account with a second key pair to randomize block production and leader selection.

    In order to ensure that the network produces a second block after its launch, the nemesis block must include at least one valid VrfKeyLinkTransaction linking a harvester account with a second key pair.

    Run the linker tool to create a VrfKeyLinkTransaction:

    cd bin
./catapult.tools.linker --resources ../ --type vrf --secret <HARVESTER_PRIVATE_KEY> --linkedPublicKey <VRF_PUBLIC_KEY> --output ../txes/vrf_tx0.bin

    • Replace <HARVESTER_PRIVATE_KEY> with the private key of an account that owns sufficient harvesting mosaics in resources/private-test.properties [distribution>cat:harvest].

    • Replace <VRF_PUBLIC_KEY> with the public key of an unused account from nemesis.addresses.txt.

Append the Voting Keys to the nemesis block

Each node of the network can optionally host a voting account (to partake in the finalization process). In order to be an eligible voter an account must:

  1. Own at least minVoterBalance harvesting mosaics (harvestingMosaicId) as defined in config-network.properties.

    See Configuring network properties.

  2. Announce a valid VotingKeyLinkTransaction.

    First run the voting key tool to generate the key. It will be printed on the standard output:

    mkdir votingkeys
cd bin
./catapult.tools.votingkey --output ../votingkeys/private_key_tree1.dat

    NOTE: Do not backup any file generated by the voting key tool (private_key_tree1.dat in the above example). If a key is lost or compromised, just unlink it and link a new one.

    Then run the linker tool to create a VotingKeyLinkTransaction:

    ./catapult.tools.linker --resources ../ --type voting --secret <VOTER_PRIVATE_KEY> --linkedPublicKey <VOTING_PUBLIC_KEY> --output ../txes/voting_tx0.bin

    • Replace <VOTER_PRIVATE_KEY> with the private key of an account that owns sufficient harvesting mosaics.

    • Replace <VOTING_PUBLIC_KEY> with the public key obtained from catapult.tools.votingkey.

Generate the network mosaic ids

The network mosaic ids are autogenerated based on the configuration provided in the file resources/private-test.properties.

  1. Run the nemesis block generator.

    ./catapult.tools.nemgen --nemesisProperties ../resources/private-test.properties

    It will error out because the mosaic ids currently in config-network.properties do not match the calculated values. Do not worry, we are going to fix that now.

  2. Copy the currency and harvest mosaic ids displayed on the command line prompt (the hex string in parentheses):

    Mosaic Summary
 - cat:currency (621EC5B403856FC2)
...
 - cat:harvest (4291ED23000A037A)

  3. Set currencyMosaicId and harvestingMosaicId in resources/config-network.properties with the values obtained in the previous step (You will find these properties in the chain section).

    [chain]

currencyMosaicId = 0x621EC5B403856FC2
harvestingMosaicId = 0x4291ED23000A037A

Generate the nemesis block

Run the nemesis block generator a second time, this time with the correct mosaic ids values.

./catapult.tools.nemgen --nemesisProperties ../resources/private-test.properties

Configure the node

Follow the next guide to configure a peer node and start the network.