Skip to content
This repository has been archived by the owner on Aug 18, 2020. It is now read-only.

Commit

Permalink
[CO-354] docs: add configuration info for "protocolMagic"
Browse files Browse the repository at this point in the history
  • Loading branch information
rvl committed Sep 13, 2018
1 parent f8ea576 commit ac71936
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,13 +264,31 @@ mechanism (hex-encoded).
Section `"protocolConsts"` contains basic protocol constants:

* `"k"` - security parameter from the paper,
* `"protocolMagic"` - protocol magic value (it's included into a
serialized block and header and it's part of signed data, so when protocol
magic is changed, all signatures become invalid) used to
distinguish different networks,
* `"protocolMagic"` - protocol magic section, described fully below:
* `"pm"` - protocol magic number,
* `"requiresNetworkMagic"` - either `"NMMustBeNothing"` or `"NMMustBeJust"`,
* `"vssMaxTTL"` - VSS certificates maximum timeout to live (number of epochs),
* `"vssMinTTL"` - VSS certificates minimum timeout to live (number of epochs).

Section `"protocolMagic"` defines the protocol magic number. When the
protocol magic is changed, all signatures become invalid. This is used
to distinguish different networks.

* `"pm"` - is the protocol magic number, is included in serialized
blocks and headers, and is part of signed data.
* `"requiresNetworkMagic"` - has two options:
* `"NMMustBeNothing"` (mainnet setting) - means that the protocol
magic value will *not* be included in the address format or
transactions.
* `"NMMustBeJust"` (public testnet setting) - means that the
protocol magic value will be included in the address format and
hence transactions.

The `"protocolMagic"` value can either be an object with the two
fields described above, or just a plain integer. In the latter case,
`"requiresNetworkMagic"` will take the default value of
`"NMMustBeJust"`.

Section `"heavyDelegation"` contains an information about heavyweight delegation:

* `"cert"` - delegation certificate,
Expand Down

0 comments on commit ac71936

Please sign in to comment.