Skip to content

Latest commit

 

History

History
87 lines (68 loc) · 5.17 KB

01_the_genesis_block.md

File metadata and controls

87 lines (68 loc) · 5.17 KB
Raw

genesis file

The genesis file is the file that allows you to create a new blockchain from block 0. It lays out the different parameters of your blockchain: the initial utxo, the start time, the slot duration time, etc...

Example of a BFT genesis file with an initial address UTxO and an account UTxO. More info regarding starting a BFT blockchain here and regarding addresses there. You could also find information regarding the jcli genesis tooling.

You can generate a documented pre-generated genesis file:

jcli genesis init

For example your genesis file may look like:

{{#include ../../jormungandr-lib/src/interfaces/block0_configuration/BLOCKCHAIN_CONFIGURATION_DOCUMENTED_EXAMPLE.yaml}}

There are multiple parts in the genesis file:

  • blockchain_configuration: this is a list of configuration parameters of the blockchain, some of which can be changed later via the update protocol;
  • initial: list of steps to create initial state of ledger

blockchain_configuration options

option format description
block0_date number the official start time of the blockchain, in seconds since UNIX EPOCH
discrimination string production or test
block0_consensus string bft
slot_duration number the number of seconds between the creation of 2 blocks
epoch_stability_depth number allowed size of a fork (in number of block)
consensus_leader_ids array the list of the BFT leader at the beginning of the blockchain
block_content_max_size number the maximum size of the block content (excluding the block header), in bytes.
linear_fees object linear fee settings, set the fee for transaction and certificate publishing
consensus_genesis_praos_active_slot_coeff number genesis praos active slot coefficient. Determines minimum stake required to try becoming slot leader, must be in range (0,1]
kes_update_speed number the speed to update the KES Key in seconds
slots_per_epoch number number of slots in each epoch

for more information about the BFT leaders in the genesis file, see Starting a BFT Blockchain

initial options

Each entry can be one of 3 variants:

variant format description
fund sequence initial deposits present in the blockchain (up to 255 outputs per entry)
cert string initial certificate
legacy_fund sequence same as fund, but with legacy Cardano address format

Example:

initial:
  - fund:
      - address: <address>
        value: 10000
      - address: <address2>
        value: 20000
      - address: <address3>
        value: 30000
  - cert: <certificate>
  - legacy_fund:
      - address: <legacy address>
        value: 123
  - fund:
      - address: <another address>
        value: 1001

fund and legacy_fund format

variant format description
address string can be a single address or an account address
value number assigned value

legacy_fund differs only in address format, which is legacy Cardano