Add NodeToNode Codec for PerasCertDiffusion #1658
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,6 +6,8 @@ | |||||
| {-# LANGUAGE MultiParamTypeClasses #-} | ||||||
| {-# LANGUAGE PolyKinds #-} | ||||||
| {-# LANGUAGE RankNTypes #-} | ||||||
| {-# LANGUAGE RecordWildCards #-} | ||||||
| {-# LANGUAGE ScopedTypeVariables #-} | ||||||
| {-# LANGUAGE StandaloneDeriving #-} | ||||||
| {-# LANGUAGE StandaloneKindSignatures #-} | ||||||
| {-# LANGUAGE UndecidableInstances #-} | ||||||
|
|
@@ -33,8 +35,8 @@ module Ouroboros.Consensus.Node.Serialisation | |||||
| , Some (..) | ||||||
| ) where | ||||||
|
|
||||||
| import Codec.CBOR.Decoding (Decoder, decodeListLenOf) | ||||||
| import Codec.CBOR.Encoding (Encoding, encodeListLen) | ||||||
| import Codec.Serialise (Serialise (decode, encode)) | ||||||
| import Data.Kind | ||||||
| import Data.SOP.BasicFunctors | ||||||
|
|
@@ -47,7 +49,15 @@ import Ouroboros.Consensus.Ledger.SupportsMempool | |||||
| import Ouroboros.Consensus.Node.NetworkProtocolVersion | ||||||
| import Ouroboros.Consensus.TypeFamilyWrappers | ||||||
| import Ouroboros.Consensus.Util (Some (..)) | ||||||
| import Ouroboros.Network.Block | ||||||
| ( Tip | ||||||
| , decodePoint | ||||||
| , decodeTip | ||||||
| , encodePoint | ||||||
| , encodeTip | ||||||
| , unwrapCBORinCBOR | ||||||
| , wrapCBORinCBOR | ||||||
| ) | ||||||
|
|
||||||
| {------------------------------------------------------------------------------- | ||||||
| NodeToNode | ||||||
|
|
@@ -173,6 +183,30 @@ deriving newtype instance | |||||
| SerialiseNodeToNode blk (GenTxId blk) => | ||||||
| SerialiseNodeToNode blk (WrapGenTxId blk) | ||||||
|
|
||||||
| -- TODO: move these orphan instances elsewhere | ||||||
|
There was a problem hiding this comment. Ah, if they are defined here, they actually aren't orphan instances (note that the orphan warning isn't disabled in this file), so this can be removed. |
||||||
| instance ConvertRawHash blk => SerialiseNodeToNode blk (Point blk) where | ||||||
| encodeNodeToNode _ccfg _version = encodePoint $ encodeRawHash (Proxy :: Proxy blk) | ||||||
|
There was a problem hiding this comment. Nitpick:
Suggested change
Also search for " |
||||||
| decodeNodeToNode _ccfg _version = decodePoint $ decodeRawHash (Proxy :: Proxy blk) | ||||||
|
|
||||||
| instance ConvertRawHash blk => SerialiseNodeToNode blk (Tip blk) where | ||||||
| encodeNodeToNode _ccfg _version = encodeTip $ encodeRawHash (Proxy :: Proxy blk) | ||||||
| decodeNodeToNode _ccfg _version = decodeTip $ decodeRawHash (Proxy :: Proxy blk) | ||||||
|
|
||||||
| instance SerialiseNodeToNode blk PerasRoundNo where | ||||||
| encodeNodeToNode _ccfg _version = encode | ||||||
| decodeNodeToNode _ccfg _version = decode | ||||||
| instance ConvertRawHash blk => SerialiseNodeToNode blk (PerasCert blk) where | ||||||
| -- Consistent with the 'Serialise' instance for 'PerasCert' defined in Ouroboros.Consensus.Block.SupportsPeras | ||||||
| encodeNodeToNode ccfg version PerasCert{..} = | ||||||
| encodeListLen 2 | ||||||
| <> encodeNodeToNode ccfg version pcCertRound | ||||||
| <> encodeNodeToNode ccfg version pcCertBoostedBlock | ||||||
| decodeNodeToNode ccfg version = do | ||||||
| decodeListLenOf 2 | ||||||
| pcCertRound <- decodeNodeToNode ccfg version | ||||||
| pcCertBoostedBlock <- decodeNodeToNode ccfg version | ||||||
| pure $ PerasCert pcCertRound pcCertBoostedBlock | ||||||
|
Comment on lines
+198
to
+208
There was a problem hiding this comment. You can also just defer to |
||||||
|
|
||||||
| deriving newtype instance | ||||||
| SerialiseNodeToClient blk (GenTxId blk) => | ||||||
| SerialiseNodeToClient blk (WrapGenTxId blk) | ||||||
|
|
||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: The style guide asks us to not use
RecordWildCards. (I personally like them though 😅 And there are still lots of usages left from before this rule existed.)