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

Commit e1c07c4

Browse files
committed
[CO-354] docs: add configuration info for "protocolMagic"
1 parent f8ea576 commit e1c07c4

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/configuration.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -264,13 +264,29 @@ mechanism (hex-encoded).
264264
Section `"protocolConsts"` contains basic protocol constants:
265265

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

273+
Section `"protocolMagic"` defines the protocol magic number. When the
274+
protocol magic is changed, all signatures become invalid. This is used
275+
to distinguish different networks.
276+
277+
* `"pm"` - is the protocol magic number, is included in serialized
278+
blocks and headers, and is part of signed data.
279+
* `"requiresNetworkMagic"` - has two options:
280+
* `"NMMustBeNothing"` (mainnet setting) - means that the protocol
281+
magic value will *not* be included in the address format or
282+
transactions.
283+
* `"NMMustBeJust"` (public testnet setting) - means that the
284+
protocol magic value will be included in the address format and
285+
hence transactions.
286+
287+
If `"protocolMagic"` is just a plain integer, `"requiresNetworkMagic"`
288+
will take the default value of `"NMMustBeJust"`.
289+
274290
Section `"heavyDelegation"` contains an information about heavyweight delegation:
275291

276292
* `"cert"` - delegation certificate,

0 commit comments

Comments
 (0)