Add Serialization & Deserialization information to Casper Docs[Jira CD-59]

[devendran-m]

As Casper Docs, I should add Serialization & Deserialization information.

Repurposing this ticket to fix the Casper 2.0 SSE contents updates.

[zajko]

Things that I noticed when going through the types system:

Things that have mixed up enum variants or mixed up fields:

• TransactionConfig
• OpcodeCosts
• ControlFlowCosts
• DeployConfig
• TransactionV1Config
• VacancyConfig
• MessageTopicSummary
• SingleBlockRewardedSignatures - the description is bologny
• MessageTopics - refers to BTreeMap which is a rust implementation detail
• Key - most of the variants are not mentioned
• Signature - this has not enough data to reproduce serialization
• ContractWasmHash - the description is bonkers
• NamedKeys - references BTreeMap
• TransactionV1Hash - the description is insufficient to reproduce serialization
• PricingMode - needs to be covered by calltable-types docs
• TransactionInvocationTarget - needs to be covered by calltable-types docs
• TransactionTarget - needs to be covered by calltable-types docs
• ExecutableDeployItem - needs to be covered by calltable-types docs
• TransactionEntryPoint - needs to be covered by calltable-types docs
• InitiatorAddr - needs to be covered by calltable-types docs
• TransactionV1 - needs to be covered by calltable-types docs
• ContractPackageHash - weird description
• EntryPoints- referencing BTreeMap, also should be named "contract entry points"
• Bytes - the description mangles in the concept of hex encoding which is only confusing
• BidKind - missing a lot of variants
• ValidatorBid - missing fields
• BidAddr - missing variants
• SeigniorageAllocation - missing variants
• CallStackElement - missing variants
• Package - to many fields
• AssociatedKey - it should be named AssociatedKeys since in the docs it describes a collection. In the description it references BTreeMap which is probably a mistake
• Digest - the description does not explain how to serialize values of this type
• NamedKeys - references BTreeMap
• EntryPoints - references BTreeMap
• EntryPointAddr - has too many variants
• EntryPointValue - too many variants
• ExecutionResultV2 - completely wrong

Missing things

• SystemConfig
• HandlePaymentCosts
• HostFunctionCostsV1
• HostFunctionCostsV2
• WasmV1Config
• BrTableCost
• MintCosts
• StandardPaymentCosts
• AuctionCosts
• WasmConfig
• WasmV2Config
• HoldBalanceHandling
• FeeHandling
• RuntimeConfig
• AccountsConfig
• AccountConfig
• DelegatorConfig
• AdministratorAccount
• AccountConfig
• PricingHandling
• ProtocolConfig
• CoreConfig
• ConsensusProtocolName
• LegacyRequiredFinality
• NetworkConfig
• HighwayConfig
• RefundHandling
• GlobalStateUpdate
• RuntimeArgs - this should be in the calltable-types docs
• TransactionArgs - this should be in the calltable-types docs
• TransactionV1Payload - this should be in the calltable-types docs
• TransactionRuntimeParams - this should be in the calltable-types docs
• ContractPackage - missing from the serialization docs (only in json-rpc)
• EntryPoints - there is contract entry points, missing addressable entity entry points
• StoredValue
• Chainspec
• Reservation
• UnbondKind
• Unbond
• UnbondEra
• DelegatorKind
• DelegatorBid
• Bridge
• PrepaymentKind
• Transfer (not sure, we have a storage component for this but I don't think we use it to calculate state root hash)
• TransferV1 - we need to have this, it's a variant of storedvalue
• TransferV2 (not sure, we have a storage component for this but I don't think we use it to calculate state root hash)
• EntryPointType
• EntryPointPayment
• EntryPointAccess
• TransferAddr
• TransformKindV1 - missing variants, also the description of existing ones are questionable - for instance AddKeys is murky, not clear how to serialize this value
• executionresult - to confirm with Ed, do we use this type to calculate the has that gets included in global state?

Misplaced things

• ByteCodeHash - this should be in types or structs
• ByteCodeKind - this needs to go to "core" types descriptions, not only json-rpc