From ac71936de26f46a31f2e10293500971359731471 Mon Sep 17 00:00:00 2001 From: Rodney Lorrimar Date: Thu, 13 Sep 2018 13:24:17 +1000 Subject: [PATCH] [CO-354] docs: add configuration info for "protocolMagic" --- docs/configuration.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index cefc55d11c3..672ca3fe622 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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,