Safe Haskell	None
Language	Haskell2010

Cardano.Chain.Block

Contents

UTxO
Header
Header Constructors
Header Accessors
Header Binary Serialization
Header Formatting
Boundary Header
HeaderHash
BlockSignature
ToSign
Block
Block Constructors
Block Accessors
Block Binary Serialization
Block Formatting
ABlockOrBoundary
ABoundaryBlock
ABlockOrBoundaryHdr

Synopsis

data BlockValidationMode
- = BlockValidation
- | NoBlockValidation
toTxValidationMode :: BlockValidationMode -> TxValidationMode
adoptedProtocolParameters :: State -> ProtocolParameters
updateBody :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => BodyEnvironment -> BodyState -> ABlock ByteString -> m BodyState
updateChainBlockOrBoundary :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => Config -> ChainValidationState -> ABlockOrBoundary ByteString -> m ChainValidationState
updateChainBoundary :: MonadError ChainValidationError m => ChainValidationState -> ABoundaryBlock ByteString -> m ChainValidationState
epochTransition :: EpochEnvironment -> State -> SlotNumber -> State
headerIsValid :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => State -> AHeader ByteString -> m ()
validateHeaderMatchesBody :: MonadError ProofValidationError m => AHeader ByteString -> ABody ByteString -> m ()
updateBlock :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => Config -> ChainValidationState -> ABlock ByteString -> m ChainValidationState
data BodyState = BodyState {
- utxo :: ! UTxO
- updateState :: ! State
- delegationState :: ! State
}
data BodyEnvironment = BodyEnvironment {
- protocolMagic :: !( AProtocolMagic ByteString )
- utxoConfiguration :: ! UTxOConfiguration
- k :: ! BlockCount
- allowedDelegators :: !( Set KeyHash )
- protocolParameters :: ! ProtocolParameters
- currentEpoch :: ! EpochNumber
}
data EpochEnvironment = EpochEnvironment {
- protocolMagic :: !( Annotated ProtocolMagicId ByteString )
- k :: ! BlockCount
- allowedDelegators :: !( Set KeyHash )
- delegationMap :: ! Map
- currentEpoch :: ! EpochNumber
}
data ChainValidationState = ChainValidationState {
- cvsLastSlot :: ! SlotNumber
- cvsPreviousHash :: !( Either GenesisHash HeaderHash )
- cvsUtxo :: ! UTxO
- cvsUpdateState :: ! State
- cvsDelegationState :: ! State
}
initialChainValidationState :: MonadError Error m => Config -> m ChainValidationState
data ChainValidationError
- = ChainValidationBoundaryTooLarge
- | ChainValidationBlockAttributesTooLarge
- | ChainValidationBlockTooLarge Natural Natural
- | ChainValidationHeaderAttributesTooLarge
- | ChainValidationHeaderTooLarge Natural Natural
- | ChainValidationDelegationPayloadError Text
- | ChainValidationInvalidDelegation VerificationKey VerificationKey
- | ChainValidationGenesisHashMismatch GenesisHash GenesisHash
- | ChainValidationExpectedGenesisHash GenesisHash HeaderHash
- | ChainValidationExpectedHeaderHash HeaderHash GenesisHash
- | ChainValidationInvalidHash HeaderHash HeaderHash
- | ChainValidationMissingHash HeaderHash
- | ChainValidationUnexpectedGenesisHash HeaderHash
- | ChainValidationInvalidSignature BlockSignature
- | ChainValidationDelegationSchedulingError Error
- | ChainValidationProtocolMagicMismatch ProtocolMagicId ProtocolMagicId
- | ChainValidationSignatureLight
- | ChainValidationTooManyDelegations VerificationKey
- | ChainValidationUpdateError SlotNumber Error
- | ChainValidationUTxOValidationError UTxOValidationError
- | ChainValidationProofValidationError ProofValidationError
newtype HeapSize a = HeapSize {
- unHeapSize :: Int
}
newtype UTxOSize = UTxOSize {
- unUTxOSize :: Int
}
calcUTxOSize :: UTxO -> ( HeapSize UTxO , UTxOSize )
foldUTxO :: Environment -> UTxO -> Stream ( Of ( ABlock ByteString )) ( ExceptT ParseError ResIO ) () -> ExceptT Error ( ReaderT ValidationMode ResIO ) UTxO
foldUTxOBlock :: Environment -> UTxO -> ABlock ByteString -> ExceptT Error ( ReaderT ValidationMode ResIO ) UTxO
data Proof = Proof {
- proofUTxO :: ! TxProof
- proofSsc :: ! SscProof
- proofDelegation :: !( Hash Payload )
- proofUpdate :: ! Proof
}
data ProofValidationError
- = DelegationProofValidationError
- | UTxOProofValidationError
- | UpdateProofValidationError
mkProof :: Body -> Proof
recoverProof :: ABody ByteString -> Proof
type Header = AHeader ()
data AHeader a = AHeader {
- aHeaderProtocolMagicId :: !( Annotated ProtocolMagicId a)
- aHeaderPrevHash :: !( Annotated HeaderHash a)
- aHeaderSlot :: !( Annotated SlotNumber a)
- aHeaderDifficulty :: !( Annotated ChainDifficulty a)
- headerProtocolVersion :: ! ProtocolVersion
- headerSoftwareVersion :: ! SoftwareVersion
- aHeaderProof :: !( Annotated Proof a)
- headerGenesisKey :: ! VerificationKey
- headerSignature :: !( ABlockSignature a)
- headerAnnotation :: !a
- headerExtraAnnotation :: !a
}
mkHeader :: ProtocolMagicId -> Either GenesisHash Header -> EpochSlots -> SlotNumber -> SigningKey -> Certificate -> Body -> ProtocolVersion -> SoftwareVersion -> Header
mkHeaderExplicit :: ProtocolMagicId -> HeaderHash -> ChainDifficulty -> EpochSlots -> SlotNumber -> SigningKey -> Certificate -> Body -> ProtocolVersion -> SoftwareVersion -> Header
headerProtocolMagicId :: AHeader a -> ProtocolMagicId
headerPrevHash :: AHeader a -> HeaderHash
headerProof :: AHeader a -> Proof
headerSlot :: AHeader a -> SlotNumber
headerIssuer :: AHeader a -> VerificationKey
headerLength :: AHeader ByteString -> Natural
headerDifficulty :: AHeader a -> ChainDifficulty
headerToSign :: EpochSlots -> AHeader a -> ToSign
toCBORHeader :: EpochSlots -> Header -> Encoding
toCBORHeaderSize :: Proxy EpochSlots -> Proxy ( AHeader a) -> Size
toCBORHeaderToHash :: EpochSlots -> Header -> Encoding
fromCBORAHeader :: EpochSlots -> Decoder s ( AHeader ByteSpan )
fromCBORHeader :: EpochSlots -> Decoder s Header
fromCBORHeaderToHash :: EpochSlots -> Decoder s ( Maybe Header )
wrapHeaderBytes :: ByteString -> ByteString
toCBORBlockVersions :: ProtocolVersion -> SoftwareVersion -> Encoding
toCBORBlockVersionsSize :: Proxy ProtocolVersion -> Proxy SoftwareVersion -> Size
renderHeader :: EpochSlots -> Header -> Builder
data ABoundaryHeader a = UnsafeABoundaryHeader {
- boundaryPrevHash :: !( Either GenesisHash HeaderHash )
- boundaryEpoch :: ! Word64
- boundaryDifficulty :: ! ChainDifficulty
- boundaryHeaderAnnotation :: !a
}
mkABoundaryHeader :: Either GenesisHash HeaderHash -> Word64 -> ChainDifficulty -> a -> ABoundaryHeader a
toCBORABoundaryHeader :: ProtocolMagicId -> ABoundaryHeader a -> Encoding
toCBORABoundaryHeaderSize :: Proxy ProtocolMagicId -> Proxy ( ABoundaryHeader a) -> Size
fromCBORABoundaryHeader :: Decoder s ( ABoundaryHeader ByteSpan )
boundaryHeaderHashAnnotated :: ABoundaryHeader ByteString -> HeaderHash
wrapBoundaryBytes :: ByteString -> ByteString
type HeaderHash = Hash Header
headerHashF :: Format r ( HeaderHash -> r)
hashHeader :: EpochSlots -> Header -> HeaderHash
headerHashAnnotated :: AHeader ByteString -> HeaderHash
genesisHeaderHash :: GenesisHash -> HeaderHash
type BlockSignature = ABlockSignature ()
data ABlockSignature a = ABlockSignature {
- delegationCertificate :: !( ACertificate a)
- signature :: !( Signature ToSign )
}
data ToSign = ToSign {
- tsHeaderHash :: ! HeaderHash
- tsBodyProof :: ! Proof
- tsSlot :: ! EpochAndSlotCount
- tsDifficulty :: ! ChainDifficulty
- tsProtocolVersion :: ! ProtocolVersion
- tsSoftwareVersion :: ! SoftwareVersion
}
recoverSignedBytes :: EpochSlots -> AHeader ByteString -> Annotated ToSign ByteString
fromCBORBoundaryConsensusData :: Decoder s ( Word64 , ChainDifficulty )
dropBoundaryExtraHeaderData :: Dropper s
dropBoundaryExtraHeaderDataRetainGenesisTag :: Decoder s Bool
dropBoundaryBody :: Dropper s
dropBoundaryExtraBodyData :: Dropper s
type Body = ABody ()
pattern Body :: TxPayload -> SscPayload -> Payload -> Payload -> Body
data ABody a = ABody {
- bodyTxPayload :: !( ATxPayload a)
- bodySscPayload :: ! SscPayload
- bodyDlgPayload :: !( APayload a)
- bodyUpdatePayload :: !( APayload a)
}
bodyTxs :: Body -> [ Tx ]
bodyWitnesses :: Body -> [ TxWitness ]
type Block = ABlock ()
data ABlock a = ABlock {
- blockHeader :: AHeader a
- blockBody :: ABody a
- blockAnnotation :: a
}
mkBlock :: ProtocolMagicId -> ProtocolVersion -> SoftwareVersion -> Either GenesisHash Header -> EpochSlots -> SlotNumber -> SigningKey -> Certificate -> Body -> Block
mkBlockExplicit :: ProtocolMagicId -> ProtocolVersion -> SoftwareVersion -> HeaderHash -> ChainDifficulty -> EpochSlots -> SlotNumber -> SigningKey -> Certificate -> Body -> Block
blockHash :: EpochSlots -> Block -> HeaderHash
blockHashAnnotated :: ABlock ByteString -> HeaderHash
blockAProtocolMagicId :: ABlock a -> Annotated ProtocolMagicId a
blockProtocolMagicId :: ABlock a -> ProtocolMagicId
blockPrevHash :: ABlock a -> HeaderHash
blockProof :: ABlock a -> Proof
blockSlot :: ABlock a -> SlotNumber
blockGenesisKey :: ABlock a -> VerificationKey
blockIssuer :: ABlock a -> VerificationKey
blockDifficulty :: ABlock a -> ChainDifficulty
blockToSign :: EpochSlots -> ABlock a -> ToSign
blockSignature :: ABlock a -> ABlockSignature a
blockProtocolVersion :: ABlock a -> ProtocolVersion
blockSoftwareVersion :: ABlock a -> SoftwareVersion
blockTxPayload :: ABlock a -> ATxPayload a
blockSscPayload :: ABlock a -> SscPayload
blockDlgPayload :: ABlock a -> APayload a
blockUpdatePayload :: ABlock a -> APayload a
blockLength :: ABlock ByteString -> Natural
toCBORBlock :: EpochSlots -> Block -> Encoding
fromCBORABlock :: EpochSlots -> Decoder s ( ABlock ByteSpan )
renderBlock :: EpochSlots -> Block -> Builder
data ABlockOrBoundary a
- = ABOBBlock ( ABlock a)
- | ABOBBoundary ( ABoundaryBlock a)
toCBORABOBBlock :: EpochSlots -> ABlock a -> Encoding
fromCBORABOBBlock :: EpochSlots -> Decoder s ( Maybe Block )
fromCBORABlockOrBoundary :: EpochSlots -> Decoder s ( ABlockOrBoundary ByteSpan )
toCBORABlockOrBoundary :: ProtocolMagicId -> EpochSlots -> ABlockOrBoundary a -> Encoding
data ABoundaryBlock a = ABoundaryBlock {
- boundaryBlockLength :: ! Int64
- boundaryHeader :: !( ABoundaryHeader a)
- boundaryBody :: !( ABoundaryBody a)
- boundaryAnnotation :: !a
}
boundaryHashAnnotated :: ABoundaryBlock ByteString -> HeaderHash
fromCBORABoundaryBlock :: Decoder s ( ABoundaryBlock ByteSpan )
toCBORABoundaryBlock :: ProtocolMagicId -> ABoundaryBlock a -> Encoding
toCBORABOBBoundary :: ProtocolMagicId -> ABoundaryBlock a -> Encoding
boundaryBlockSlot :: EpochSlots -> Word64 -> SlotNumber
data ABoundaryBody a = ABoundaryBody {
- boundaryBodyAnnotation :: !a
}
data ABlockOrBoundaryHdr a
- = ABOBBlockHdr !( AHeader a)
- | ABOBBoundaryHdr !( ABoundaryHeader a)
aBlockOrBoundaryHdr :: ( AHeader a -> b) -> ( ABoundaryHeader a -> b) -> ABlockOrBoundaryHdr a -> b
fromCBORABlockOrBoundaryHdr :: EpochSlots -> Decoder s ( ABlockOrBoundaryHdr ByteSpan )
toCBORABlockOrBoundaryHdr :: ABlockOrBoundaryHdr ByteString -> Encoding
toCBORABlockOrBoundaryHdrSize :: Proxy ( ABlockOrBoundaryHdr a) -> Size
abobHdrFromBlock :: ABlockOrBoundary a -> ABlockOrBoundaryHdr a
abobHdrSlotNo :: EpochSlots -> ABlockOrBoundaryHdr a -> SlotNumber
abobHdrChainDifficulty :: ABlockOrBoundaryHdr a -> ChainDifficulty
abobHdrHash :: ABlockOrBoundaryHdr ByteString -> HeaderHash
abobHdrPrevHash :: ABlockOrBoundaryHdr a -> Maybe HeaderHash

Documentation

data BlockValidationMode Source #

Indicates what sort of block validation should be performed.

Constructors

BlockValidation	Perform all block validations.
NoBlockValidation	Perform no block validations.

Instances

Instances details

Eq BlockValidationMode Source #
Instance details Defined in Cardano.Chain.Block.ValidationMode Methods (==) :: BlockValidationMode -> BlockValidationMode -> Bool Source # (/=) :: BlockValidationMode -> BlockValidationMode -> Bool Source #
Show BlockValidationMode Source #
Instance details Defined in Cardano.Chain.Block.ValidationMode Methods showsPrec :: Int -> BlockValidationMode -> ShowS Source # show :: BlockValidationMode -> String Source # showList :: [ BlockValidationMode ] -> ShowS Source #

toTxValidationMode :: BlockValidationMode -> TxValidationMode Source #

Translate a BlockValidationMode to an appropriate TxValidationMode .

adoptedProtocolParameters :: State -> ProtocolParameters Source #

Adopted protocol parameters

updateBody :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => BodyEnvironment -> BodyState -> ABlock ByteString -> m BodyState Source #

This is an implementation of the BBODY rule as per the chain specification.

Compared to updateChain , this does not validate any header level checks, nor does it carry out anything which might be considered part of the protocol.

updateChainBlockOrBoundary :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => Config -> ChainValidationState -> ABlockOrBoundary ByteString -> m ChainValidationState Source #

updateChainBoundary :: MonadError ChainValidationError m => ChainValidationState -> ABoundaryBlock ByteString -> m ChainValidationState Source #

epochTransition :: EpochEnvironment -> State -> SlotNumber -> State Source #

Perform epoch transition if we have moved across the epoch boundary

We pass through to the update interface UPIEC rule, which adopts any confirmed proposals and cleans up the state. This corresponds to the EPOCH rules from the Byron chain specification.

headerIsValid :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => State -> AHeader ByteString -> m () Source #

This is an implementation of the headerIsValid function from the Byron chain specification

validateHeaderMatchesBody :: MonadError ProofValidationError m => AHeader ByteString -> ABody ByteString -> m () Source #

updateBlock :: ( MonadError ChainValidationError m, MonadReader ValidationMode m) => Config -> ChainValidationState -> ABlock ByteString -> m ChainValidationState Source #

This represents the CHAIN rule. It is intended more for use in tests than in a real implementation, which will want to invoke its constituent rules directly.

Note that this also updates the previous block hash, which would usually be done as part of the PBFT rule.

data BodyState Source #

Constructors

BodyState
Fields utxo :: ! UTxO updateState :: ! State delegationState :: ! State

data BodyEnvironment Source #

Constructors

BodyEnvironment
Fields protocolMagic :: !( AProtocolMagic ByteString ) utxoConfiguration :: ! UTxOConfiguration k :: ! BlockCount allowedDelegators :: !( Set KeyHash ) protocolParameters :: ! ProtocolParameters currentEpoch :: ! EpochNumber

data EpochEnvironment Source #

Constructors

EpochEnvironment
Fields protocolMagic :: !( Annotated ProtocolMagicId ByteString ) k :: ! BlockCount allowedDelegators :: !( Set KeyHash ) delegationMap :: ! Map currentEpoch :: ! EpochNumber

data ChainValidationState Source #

Constructors

ChainValidationState
Fields cvsLastSlot :: ! SlotNumber cvsPreviousHash :: !( Either GenesisHash HeaderHash ) GenesisHash for the previous hash of the zeroth boundary block and HeaderHash for all others. cvsUtxo :: ! UTxO cvsUpdateState :: ! State cvsDelegationState :: ! State

Instances

Instances details

Eq ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods (==) :: ChainValidationState -> ChainValidationState -> Bool Source # (/=) :: ChainValidationState -> ChainValidationState -> Bool Source #
Show ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods showsPrec :: Int -> ChainValidationState -> ShowS Source # show :: ChainValidationState -> String Source # showList :: [ ChainValidationState ] -> ShowS Source #
Generic ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Associated Types type Rep ChainValidationState :: Type -> Type Source # Methods from :: ChainValidationState -> Rep ChainValidationState x Source # to :: Rep ChainValidationState x -> ChainValidationState Source #
NFData ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods rnf :: ChainValidationState -> () Source #
ToCBOR ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods toCBOR :: ChainValidationState -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ChainValidationState -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ChainValidationState ] -> Size Source #
FromCBOR ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods fromCBOR :: Decoder s ChainValidationState Source # label :: Proxy ChainValidationState -> Text Source #
NoThunks ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods noThunks :: Context -> ChainValidationState -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ChainValidationState -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ChainValidationState -> String Source #
type Rep ChainValidationState Source #
Instance details Defined in Cardano.Chain.Block.Validation type Rep ChainValidationState = D1 (' MetaData "ChainValidationState" "Cardano.Chain.Block.Validation" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ChainValidationState" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "cvsLastSlot") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 SlotNumber ) :: S1 (' MetaSel (' Just "cvsPreviousHash") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Either GenesisHash HeaderHash ))) :: ( S1 (' MetaSel (' Just "cvsUtxo") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 UTxO ) :: ( S1 (' MetaSel (' Just "cvsUpdateState") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 State ) :: S1 (' MetaSel (' Just "cvsDelegationState") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 State )))))

initialChainValidationState :: MonadError Error m => Config -> m ChainValidationState Source #

Create the state needed to validate the zeroth epoch of the chain. The zeroth epoch starts with a boundary block where the previous hash is the genesis hash.

data ChainValidationError Source #

Constructors

ChainValidationBoundaryTooLarge	The size of an epoch boundary block exceeds the limit
ChainValidationBlockAttributesTooLarge	The size of a block's attributes is non-zero
ChainValidationBlockTooLarge Natural Natural	The size of a regular block exceeds the limit
ChainValidationHeaderAttributesTooLarge	The size of a block header's attributes is non-zero
ChainValidationHeaderTooLarge Natural Natural	The size of a block header exceeds the limit
ChainValidationDelegationPayloadError Text	There is a problem with the delegation payload signature
ChainValidationInvalidDelegation VerificationKey VerificationKey	The delegation used in the signature is not valid according to the ledger
ChainValidationGenesisHashMismatch GenesisHash GenesisHash	Genesis hash mismatch
ChainValidationExpectedGenesisHash GenesisHash HeaderHash	Expected GenesisHash but got HeaderHash
ChainValidationExpectedHeaderHash HeaderHash GenesisHash	Expected HeaderHash but GenesisHash
ChainValidationInvalidHash HeaderHash HeaderHash	The hash of the previous block does not match the value in the header
ChainValidationMissingHash HeaderHash	The hash of the previous block is missing and should be given hash.
ChainValidationUnexpectedGenesisHash HeaderHash	There should not be a hash of the previous but there is.
ChainValidationInvalidSignature BlockSignature	The signature of the block is invalid
ChainValidationDelegationSchedulingError Error	A delegation certificate failed validation in the ledger layer
ChainValidationProtocolMagicMismatch ProtocolMagicId ProtocolMagicId	The `ProtocolMagic` in the block doesn't match the configured one
ChainValidationSignatureLight	A block is using unsupported lightweight delegation
ChainValidationTooManyDelegations VerificationKey	The delegator for this block has delegated in too many recent blocks
ChainValidationUpdateError SlotNumber Error	Something failed to register in the update interface
ChainValidationUTxOValidationError UTxOValidationError	A transaction failed validation in the ledger layer
ChainValidationProofValidationError ProofValidationError	A payload proof did not match.

Instances

Instances details

Eq ChainValidationError Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods (==) :: ChainValidationError -> ChainValidationError -> Bool Source # (/=) :: ChainValidationError -> ChainValidationError -> Bool Source #
Show ChainValidationError Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods showsPrec :: Int -> ChainValidationError -> ShowS Source # show :: ChainValidationError -> String Source # showList :: [ ChainValidationError ] -> ShowS Source #

UTxO

newtype HeapSize a Source #

Size of a heap value, in words

Constructors

HeapSize
Fields unHeapSize :: Int

Instances

Instances details

Show ( HeapSize a) Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods showsPrec :: Int -> HeapSize a -> ShowS Source # show :: HeapSize a -> String Source # showList :: [ HeapSize a] -> ShowS Source #
Buildable ( HeapSize a) Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods build :: HeapSize a -> Builder Source #

newtype UTxOSize Source #

Number of entries in the UTxO

Constructors

UTxOSize
Fields unUTxOSize :: Int

Instances

Instances details

Show UTxOSize Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods showsPrec :: Int -> UTxOSize -> ShowS Source # show :: UTxOSize -> String Source # showList :: [ UTxOSize ] -> ShowS Source #
Buildable UTxOSize Source #
Instance details Defined in Cardano.Chain.Block.Validation Methods build :: UTxOSize -> Builder Source #

calcUTxOSize :: UTxO -> ( HeapSize UTxO , UTxOSize ) Source #

foldUTxO :: Environment -> UTxO -> Stream ( Of ( ABlock ByteString )) ( ExceptT ParseError ResIO ) () -> ExceptT Error ( ReaderT ValidationMode ResIO ) UTxO Source #

Fold transaction validation over a Stream of Block s

foldUTxOBlock :: Environment -> UTxO -> ABlock ByteString -> ExceptT Error ( ReaderT ValidationMode ResIO ) UTxO Source #

Fold updateUTxO over the transactions in a single Block

data Proof Source #

Proof of everything contained in the payload

Constructors

Proof
Fields proofUTxO :: ! TxProof proofSsc :: ! SscProof proofDelegation :: !( Hash Payload ) proofUpdate :: ! Proof

Instances

Instances details

Eq Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods (==) :: Proof -> Proof -> Bool Source # (/=) :: Proof -> Proof -> Bool Source #
Show Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods showsPrec :: Int -> Proof -> ShowS Source # show :: Proof -> String Source # showList :: [ Proof ] -> ShowS Source #
Generic Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Associated Types type Rep Proof :: Type -> Type Source # Methods from :: Proof -> Rep Proof x Source # to :: Rep Proof x -> Proof Source #
NFData Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods rnf :: Proof -> () Source #
ToJSON Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods toJSON :: Proof -> Value Source # toEncoding :: Proof -> Encoding Source # toJSONList :: [ Proof ] -> Value Source # toEncodingList :: [ Proof ] -> Encoding Source #
ToCBOR Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods toCBOR :: Proof -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Proof -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Proof ] -> Size Source #
FromCBOR Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods fromCBOR :: Decoder s Proof Source # label :: Proxy Proof -> Text Source #
Buildable Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods build :: Proof -> Builder Source #
NoThunks Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods noThunks :: Context -> Proof -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Proof -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Proof -> String Source #
type Rep Proof Source #
Instance details Defined in Cardano.Chain.Block.Proof type Rep Proof = D1 (' MetaData "Proof" "Cardano.Chain.Block.Proof" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "Proof" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "proofUTxO") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TxProof ) :: S1 (' MetaSel (' Just "proofSsc") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 SscProof )) :: ( S1 (' MetaSel (' Just "proofDelegation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Hash Payload )) :*: S1 (' MetaSel (' Just "proofUpdate") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Proof ))))

data ProofValidationError Source #

Error which can result from attempting to validate an invalid payload proof.

Constructors

DelegationProofValidationError	The delegation payload proof did not match
UTxOProofValidationError	The UTxO payload proof did not match
UpdateProofValidationError	The update payload proof did not match

Instances

Instances details

Eq ProofValidationError Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods (==) :: ProofValidationError -> ProofValidationError -> Bool Source # (/=) :: ProofValidationError -> ProofValidationError -> Bool Source #
Show ProofValidationError Source #
Instance details Defined in Cardano.Chain.Block.Proof Methods showsPrec :: Int -> ProofValidationError -> ShowS Source # show :: ProofValidationError -> String Source # showList :: [ ProofValidationError ] -> ShowS Source #

mkProof :: Body -> Proof Source #

recoverProof :: ABody ByteString -> Proof Source #

Header

type Header = AHeader () Source #

data AHeader a Source #

Constructors

AHeader

Fields

aHeaderProtocolMagicId :: !( Annotated ProtocolMagicId a)
aHeaderPrevHash :: !( Annotated HeaderHash a)

Pointer to the header of the previous block
aHeaderSlot :: !( Annotated SlotNumber a)

The slot number this block was published for
aHeaderDifficulty :: !( Annotated ChainDifficulty a)

The chain difficulty up to this block
headerProtocolVersion :: ! ProtocolVersion

The version of the protocol parameters this block is using
headerSoftwareVersion :: ! SoftwareVersion

The software version this block was published from
aHeaderProof :: !( Annotated Proof a)

Proof of body
headerGenesisKey :: ! VerificationKey

The genesis key that is delegating to publish this block
headerSignature :: !( ABlockSignature a)

The signature of the block, which contains the delegation certificate
headerAnnotation :: !a

An annotation that captures the full header bytes
headerExtraAnnotation :: !a

An annotation that captures the bytes from the deprecated ExtraHeaderData

Instances

Instances details

Functor AHeader Source #
Instance details Defined in Cardano.Chain.Block.Header Methods fmap :: (a -> b) -> AHeader a -> AHeader b Source # (<$) :: a -> AHeader b -> AHeader a Source #
Eq a => Eq ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods (==) :: AHeader a -> AHeader a -> Bool Source # (/=) :: AHeader a -> AHeader a -> Bool Source #
Show a => Show ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods showsPrec :: Int -> AHeader a -> ShowS Source # show :: AHeader a -> String Source # showList :: [ AHeader a] -> ShowS Source #
Generic ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Associated Types type Rep ( AHeader a) :: Type -> Type Source # Methods from :: AHeader a -> Rep ( AHeader a) x Source # to :: Rep ( AHeader a) x -> AHeader a Source #
NFData a => NFData ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods rnf :: AHeader a -> () Source #
ToJSON a => ToJSON ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods toJSON :: AHeader a -> Value Source # toEncoding :: AHeader a -> Encoding Source # toJSONList :: [ AHeader a] -> Value Source # toEncodingList :: [ AHeader a] -> Encoding Source #
Decoded ( AHeader ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Header Associated Types type BaseType ( AHeader ByteString ) Source # Methods recoverBytes :: AHeader ByteString -> ByteString Source #
Buildable ( WithEpochSlots Header ) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods build :: WithEpochSlots Header -> Builder Source #
NoThunks a => NoThunks ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods noThunks :: Context -> AHeader a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> AHeader a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( AHeader a) -> String Source #
type Rep ( AHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header type Rep ( AHeader a) = D1 (' MetaData "AHeader" "Cardano.Chain.Block.Header" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "AHeader" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "aHeaderProtocolMagicId") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Annotated ProtocolMagicId a)) :: S1 (' MetaSel (' Just "aHeaderPrevHash") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Annotated HeaderHash a))) :: ( S1 (' MetaSel (' Just "aHeaderSlot") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Annotated SlotNumber a)) :: ( S1 (' MetaSel (' Just "aHeaderDifficulty") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Annotated ChainDifficulty a)) :: S1 (' MetaSel (' Just "headerProtocolVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ProtocolVersion )))) :: (( S1 (' MetaSel (' Just "headerSoftwareVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 SoftwareVersion ) :: ( S1 (' MetaSel (' Just "aHeaderProof") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Annotated Proof a)) :: S1 (' MetaSel (' Just "headerGenesisKey") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 VerificationKey ))) :: ( S1 (' MetaSel (' Just "headerSignature") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ABlockSignature a)) :: ( S1 (' MetaSel (' Just "headerAnnotation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a) :: S1 (' MetaSel (' Just "headerExtraAnnotation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a))))))
type BaseType ( AHeader ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Header type BaseType ( AHeader ByteString ) = Header

Header Constructors

mkHeader Source #

Arguments

:: ProtocolMagicId
-> Either GenesisHash Header
-> EpochSlots	Number of slots per epoch. This is needed to convert the slot number to the legacy format used in `ToSign` , where a slot is identified by the epoch to which it belongs and the offset within that epoch (counted in number of slots).
-> SlotNumber
-> SigningKey	The `SigningKey` used for signing the block
-> Certificate	A certificate of delegation from a genesis key to the `SigningKey`
-> Body
-> ProtocolVersion
-> SoftwareVersion
-> Header

Smart constructor for Header

mkHeaderExplicit Source #

Arguments

:: ProtocolMagicId
-> HeaderHash	Parent
-> ChainDifficulty
-> EpochSlots	See `mkHeader` .
-> SlotNumber
-> SigningKey	The `SigningKey` used for signing the block
-> Certificate	A certificate of delegation from a genesis key to the `SigningKey`
-> Body
-> ProtocolVersion
-> SoftwareVersion
-> Header

Make a Header for a given slot, with a given body, parent hash, and difficulty. This takes care of some signing and consensus data.

Header Accessors

headerProtocolMagicId :: AHeader a -> ProtocolMagicId Source #

headerPrevHash :: AHeader a -> HeaderHash Source #

headerProof :: AHeader a -> Proof Source #

headerSlot :: AHeader a -> SlotNumber Source #

headerIssuer :: AHeader a -> VerificationKey Source #

headerLength :: AHeader ByteString -> Natural Source #

headerDifficulty :: AHeader a -> ChainDifficulty Source #

headerToSign :: EpochSlots -> AHeader a -> ToSign Source #

Header Binary Serialization

toCBORHeader :: EpochSlots -> Header -> Encoding Source #

Encode a header, without taking in to account deprecated epoch boundary blocks.

toCBORHeaderSize :: Proxy EpochSlots -> Proxy ( AHeader a) -> Size Source #

toCBORHeaderToHash :: EpochSlots -> Header -> Encoding Source #

Encode a Header accounting for deprecated epoch boundary blocks

This encoding is only used when hashing the header for backwards compatibility, but should not be used when serializing a header within a block

fromCBORAHeader :: EpochSlots -> Decoder s ( AHeader ByteSpan ) Source #

fromCBORHeader :: EpochSlots -> Decoder s Header Source #

fromCBORHeaderToHash :: EpochSlots -> Decoder s ( Maybe Header ) Source #

wrapHeaderBytes :: ByteString -> ByteString Source #

These bytes must be prepended when hashing raw boundary header data

In the Byron release, hashes were taken over a data type that was never directly serialized to the blockchain, so these magic bytes cannot be determined from the raw header data.

These bytes are from `encodeListLen 2 <> toCBOR (1 :: Word8)`

toCBORBlockVersions :: ProtocolVersion -> SoftwareVersion -> Encoding Source #

toCBORBlockVersionsSize :: Proxy ProtocolVersion -> Proxy SoftwareVersion -> Size Source #

Header Formatting

renderHeader :: EpochSlots -> Header -> Builder Source #

Boundary Header

data ABoundaryHeader a Source #

Constructors

UnsafeABoundaryHeader
Fields boundaryPrevHash :: !( Either GenesisHash HeaderHash ) boundaryEpoch :: ! Word64 boundaryDifficulty :: ! ChainDifficulty boundaryHeaderAnnotation :: !a

Instances

Instances details

Functor ABoundaryHeader Source #
Instance details Defined in Cardano.Chain.Block.Header Methods fmap :: (a -> b) -> ABoundaryHeader a -> ABoundaryHeader b Source # (<$) :: a -> ABoundaryHeader b -> ABoundaryHeader a Source #
Eq a => Eq ( ABoundaryHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods (==) :: ABoundaryHeader a -> ABoundaryHeader a -> Bool Source # (/=) :: ABoundaryHeader a -> ABoundaryHeader a -> Bool Source #
Show a => Show ( ABoundaryHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods showsPrec :: Int -> ABoundaryHeader a -> ShowS Source # show :: ABoundaryHeader a -> String Source # showList :: [ ABoundaryHeader a] -> ShowS Source #
Generic ( ABoundaryHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Associated Types type Rep ( ABoundaryHeader a) :: Type -> Type Source # Methods from :: ABoundaryHeader a -> Rep ( ABoundaryHeader a) x Source # to :: Rep ( ABoundaryHeader a) x -> ABoundaryHeader a Source #
ToJSON a => ToJSON ( ABoundaryHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods toJSON :: ABoundaryHeader a -> Value Source # toEncoding :: ABoundaryHeader a -> Encoding Source # toJSONList :: [ ABoundaryHeader a] -> Value Source # toEncodingList :: [ ABoundaryHeader a] -> Encoding Source #
Decoded ( ABoundaryHeader ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Header Associated Types type BaseType ( ABoundaryHeader ByteString ) Source # Methods recoverBytes :: ABoundaryHeader ByteString -> ByteString Source #
NoThunks a => NoThunks ( ABoundaryHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods noThunks :: Context -> ABoundaryHeader a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ABoundaryHeader a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ABoundaryHeader a) -> String Source #
type Rep ( ABoundaryHeader a) Source #
Instance details Defined in Cardano.Chain.Block.Header type Rep ( ABoundaryHeader a) = D1 (' MetaData "ABoundaryHeader" "Cardano.Chain.Block.Header" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "UnsafeABoundaryHeader" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "boundaryPrevHash") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Either GenesisHash HeaderHash )) :: S1 (' MetaSel (' Just "boundaryEpoch") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Word64 )) :: ( S1 (' MetaSel (' Just "boundaryDifficulty") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ChainDifficulty ) :*: S1 (' MetaSel (' Just "boundaryHeaderAnnotation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a))))
type BaseType ( ABoundaryHeader ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Header type BaseType ( ABoundaryHeader ByteString ) = ABoundaryHeader ()

mkABoundaryHeader :: Either GenesisHash HeaderHash -> Word64 -> ChainDifficulty -> a -> ABoundaryHeader a Source #

Smart constructor for ABoundaryHeader

Makes sure that the hash is forced.

toCBORABoundaryHeader :: ProtocolMagicId -> ABoundaryHeader a -> Encoding Source #

Encode from a boundary header with any annotation. This does not necessarily invert fromCBORBoundaryHeader , because that decoder drops information that this encoder replaces, such as the body proof (assumes the body is empty) and the extra header data (sets it to empty map).

toCBORABoundaryHeaderSize :: Proxy ProtocolMagicId -> Proxy ( ABoundaryHeader a) -> Size Source #

fromCBORABoundaryHeader :: Decoder s ( ABoundaryHeader ByteSpan ) Source #

boundaryHeaderHashAnnotated :: ABoundaryHeader ByteString -> HeaderHash Source #

Compute the hash of a boundary block header from its annotation. It uses wrapBoundaryBytes , for the hash must be computed on the header bytes tagged with the CBOR list length and tag discriminator, which is the encoding chosen by cardano-sl.

wrapBoundaryBytes :: ByteString -> ByteString Source #

These bytes must be prepended when hashing raw boundary header data

In the Byron release, hashes were taken over a data type that was never directly serialized to the blockchain, so these magic bytes cannot be determined from the raw header data.

HeaderHash

type HeaderHash = Hash Header Source #

Hash of block header

headerHashF :: Format r ( HeaderHash -> r) Source #

Specialized formatter for HeaderHash

hashHeader :: EpochSlots -> Header -> HeaderHash Source #

Hash the serialised representation of a Header

For backwards compatibility we have to take the hash of the header serialised with toCBORHeaderToHash

headerHashAnnotated :: AHeader ByteString -> HeaderHash Source #

genesisHeaderHash :: GenesisHash -> HeaderHash Source #

Extract the genesis hash and cast it into a header hash.

BlockSignature

type BlockSignature = ABlockSignature () Source #

data ABlockSignature a Source #

Signature of the Block

We use a heavyweight delegation scheme, so the signature has two parts:

A delegation certificate from a genesis key to the block signer
The actual signature over ToSign

Constructors

ABlockSignature
Fields delegationCertificate :: !( ACertificate a) signature :: !( Signature ToSign )

Instances

Instances details

Functor ABlockSignature Source #
Instance details Defined in Cardano.Chain.Block.Header Methods fmap :: (a -> b) -> ABlockSignature a -> ABlockSignature b Source # (<$) :: a -> ABlockSignature b -> ABlockSignature a Source #
ToCBOR BlockSignature Source #
Instance details Defined in Cardano.Chain.Block.Header Methods toCBOR :: BlockSignature -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy BlockSignature -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ BlockSignature ] -> Size Source #
FromCBOR BlockSignature Source #
Instance details Defined in Cardano.Chain.Block.Header Methods fromCBOR :: Decoder s BlockSignature Source # label :: Proxy BlockSignature -> Text Source #
Buildable BlockSignature Source #
Instance details Defined in Cardano.Chain.Block.Header Methods build :: BlockSignature -> Builder Source #
Eq a => Eq ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods (==) :: ABlockSignature a -> ABlockSignature a -> Bool Source # (/=) :: ABlockSignature a -> ABlockSignature a -> Bool Source #
Show a => Show ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods showsPrec :: Int -> ABlockSignature a -> ShowS Source # show :: ABlockSignature a -> String Source # showList :: [ ABlockSignature a] -> ShowS Source #
Generic ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header Associated Types type Rep ( ABlockSignature a) :: Type -> Type Source # Methods from :: ABlockSignature a -> Rep ( ABlockSignature a) x Source # to :: Rep ( ABlockSignature a) x -> ABlockSignature a Source #
NFData a => NFData ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods rnf :: ABlockSignature a -> () Source #
ToJSON a => ToJSON ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods toJSON :: ABlockSignature a -> Value Source # toEncoding :: ABlockSignature a -> Encoding Source # toJSONList :: [ ABlockSignature a] -> Value Source # toEncodingList :: [ ABlockSignature a] -> Encoding Source #
FromCBOR ( ABlockSignature ByteSpan ) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods fromCBOR :: Decoder s ( ABlockSignature ByteSpan ) Source # label :: Proxy ( ABlockSignature ByteSpan ) -> Text Source #
NoThunks a => NoThunks ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header Methods noThunks :: Context -> ABlockSignature a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ABlockSignature a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ABlockSignature a) -> String Source #
type Rep ( ABlockSignature a) Source #
Instance details Defined in Cardano.Chain.Block.Header type Rep ( ABlockSignature a) = D1 (' MetaData "ABlockSignature" "Cardano.Chain.Block.Header" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABlockSignature" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "delegationCertificate") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ACertificate a)) :*: S1 (' MetaSel (' Just "signature") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Signature ToSign ))))

ToSign

data ToSign Source #

Data to be signed in Block

Constructors

ToSign
Fields tsHeaderHash :: ! HeaderHash Hash of previous header in the chain tsBodyProof :: ! Proof tsSlot :: ! EpochAndSlotCount tsDifficulty :: ! ChainDifficulty tsProtocolVersion :: ! ProtocolVersion tsSoftwareVersion :: ! SoftwareVersion

Instances

Instances details

Eq ToSign Source #
Instance details Defined in Cardano.Chain.Block.Header Methods (==) :: ToSign -> ToSign -> Bool Source # (/=) :: ToSign -> ToSign -> Bool Source #
Show ToSign Source #
Instance details Defined in Cardano.Chain.Block.Header Methods showsPrec :: Int -> ToSign -> ShowS Source # show :: ToSign -> String Source # showList :: [ ToSign ] -> ShowS Source #
Generic ToSign Source #
Instance details Defined in Cardano.Chain.Block.Header Associated Types type Rep ToSign :: Type -> Type Source # Methods from :: ToSign -> Rep ToSign x Source # to :: Rep ToSign x -> ToSign Source #
ToCBOR ToSign Source #
Instance details Defined in Cardano.Chain.Block.Header Methods toCBOR :: ToSign -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ToSign -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ToSign ] -> Size Source #
FromCBOR ToSign Source #
Instance details Defined in Cardano.Chain.Block.Header Methods fromCBOR :: Decoder s ToSign Source # label :: Proxy ToSign -> Text Source #
type Rep ToSign Source #
Instance details Defined in Cardano.Chain.Block.Header type Rep ToSign = D1 (' MetaData "ToSign" "Cardano.Chain.Block.Header" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ToSign" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "tsHeaderHash") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 HeaderHash ) :: ( S1 (' MetaSel (' Just "tsBodyProof") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Proof ) :: S1 (' MetaSel (' Just "tsSlot") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 EpochAndSlotCount ))) :: ( S1 (' MetaSel (' Just "tsDifficulty") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ChainDifficulty ) :: ( S1 (' MetaSel (' Just "tsProtocolVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ProtocolVersion ) :*: S1 (' MetaSel (' Just "tsSoftwareVersion") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 SoftwareVersion )))))

recoverSignedBytes :: EpochSlots -> AHeader ByteString -> Annotated ToSign ByteString Source #

Produces the ByteString that was signed in the block

fromCBORBoundaryConsensusData :: Decoder s ( Word64 , ChainDifficulty ) Source #

dropBoundaryExtraHeaderData :: Dropper s Source #

dropBoundaryExtraHeaderDataRetainGenesisTag :: Decoder s Bool Source #

When starting a new chain in ourorobos-consensus, we often start from a non-zero epoch. This is done in order to ensure synchronisation between nodes - we assume that the chain started at some fixed point in the past (e.g. midnight) which all nodes can agree on despite different node start times. However, the standard deserialisation assumes that the genesis EBB is precisely that in epoch zero.

In order to successfully round-trip a genesis EBB in a non-zero epoch, then, we add a "magic" tag which indicates the presense of the genesis hash. The choice of 255 and the word Genesis is completely arbitrary, and only done to correspond with the matching encoder. This encoding will only ever be seen when processing blocks from a demo.

dropBoundaryBody :: Dropper s Source #

dropBoundaryExtraBodyData :: Dropper s Source #

type Body = ABody () Source #

Body consists of payloads of all block components

pattern Body :: TxPayload -> SscPayload -> Payload -> Payload -> Body Source #

Constructor for Body

data ABody a Source #

Body consists of payloads of all block components

Constructors

ABody
Fields bodyTxPayload :: !( ATxPayload a) UTxO payload bodySscPayload :: ! SscPayload Ssc payload bodyDlgPayload :: !( APayload a) Heavyweight delegation payload (no-ttl certificates) bodyUpdatePayload :: !( APayload a) Additional update information for the update system

Instances

Instances details

Functor ABody Source #
Instance details Defined in Cardano.Chain.Block.Body Methods fmap :: (a -> b) -> ABody a -> ABody b Source # (<$) :: a -> ABody b -> ABody a Source #
ToCBOR Body Source #
Instance details Defined in Cardano.Chain.Block.Body Methods toCBOR :: Body -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Body -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Body ] -> Size Source #
FromCBOR Body Source #
Instance details Defined in Cardano.Chain.Block.Body Methods fromCBOR :: Decoder s Body Source # label :: Proxy Body -> Text Source #
Eq a => Eq ( ABody a) Source #
Instance details Defined in Cardano.Chain.Block.Body Methods (==) :: ABody a -> ABody a -> Bool Source # (/=) :: ABody a -> ABody a -> Bool Source #
Show a => Show ( ABody a) Source #
Instance details Defined in Cardano.Chain.Block.Body Methods showsPrec :: Int -> ABody a -> ShowS Source # show :: ABody a -> String Source # showList :: [ ABody a] -> ShowS Source #
Generic ( ABody a) Source #
Instance details Defined in Cardano.Chain.Block.Body Associated Types type Rep ( ABody a) :: Type -> Type Source # Methods from :: ABody a -> Rep ( ABody a) x Source # to :: Rep ( ABody a) x -> ABody a Source #
NFData a => NFData ( ABody a) Source #
Instance details Defined in Cardano.Chain.Block.Body Methods rnf :: ABody a -> () Source #
ToJSON a => ToJSON ( ABody a) Source #
Instance details Defined in Cardano.Chain.Block.Body Methods toJSON :: ABody a -> Value Source # toEncoding :: ABody a -> Encoding Source # toJSONList :: [ ABody a] -> Value Source # toEncodingList :: [ ABody a] -> Encoding Source #
FromCBOR ( ABody ByteSpan ) Source #
Instance details Defined in Cardano.Chain.Block.Body Methods fromCBOR :: Decoder s ( ABody ByteSpan ) Source # label :: Proxy ( ABody ByteSpan ) -> Text Source #
type Rep ( ABody a) Source #
Instance details Defined in Cardano.Chain.Block.Body type Rep ( ABody a) = D1 (' MetaData "ABody" "Cardano.Chain.Block.Body" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABody" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "bodyTxPayload") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ATxPayload a)) :: S1 (' MetaSel (' Just "bodySscPayload") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 SscPayload )) :: ( S1 (' MetaSel (' Just "bodyDlgPayload") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( APayload a)) :*: S1 (' MetaSel (' Just "bodyUpdatePayload") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( APayload a)))))

bodyTxs :: Body -> [ Tx ] Source #

bodyWitnesses :: Body -> [ TxWitness ] Source #

Block

type Block = ABlock () Source #

data ABlock a Source #

Constructors

ABlock
Fields blockHeader :: AHeader a blockBody :: ABody a blockAnnotation :: a

Instances

Instances details

Functor ABlock Source #
Instance details Defined in Cardano.Chain.Block.Block Methods fmap :: (a -> b) -> ABlock a -> ABlock b Source # (<$) :: a -> ABlock b -> ABlock a Source #
Eq a => Eq ( ABlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods (==) :: ABlock a -> ABlock a -> Bool Source # (/=) :: ABlock a -> ABlock a -> Bool Source #
Show a => Show ( ABlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods showsPrec :: Int -> ABlock a -> ShowS Source # show :: ABlock a -> String Source # showList :: [ ABlock a] -> ShowS Source #
Generic ( ABlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type Rep ( ABlock a) :: Type -> Type Source # Methods from :: ABlock a -> Rep ( ABlock a) x Source # to :: Rep ( ABlock a) x -> ABlock a Source #
NFData a => NFData ( ABlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods rnf :: ABlock a -> () Source #
ToJSON a => ToJSON ( ABlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods toJSON :: ABlock a -> Value Source # toEncoding :: ABlock a -> Encoding Source # toJSONList :: [ ABlock a] -> Value Source # toEncodingList :: [ ABlock a] -> Encoding Source #
Buildable ( WithEpochSlots Block ) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods build :: WithEpochSlots Block -> Builder Source #
type Rep ( ABlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block type Rep ( ABlock a) = D1 (' MetaData "ABlock" "Cardano.Chain.Block.Block" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABlock" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "blockHeader") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( AHeader a)) :: ( S1 (' MetaSel (' Just "blockBody") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( ABody a)) :: S1 (' MetaSel (' Just "blockAnnotation") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 a))))

Block Constructors

mkBlock Source #

Arguments

:: ProtocolMagicId
-> ProtocolVersion
-> SoftwareVersion
-> Either GenesisHash Header
-> EpochSlots
-> SlotNumber
-> SigningKey	The `SigningKey` used for signing the block
-> Certificate	A certificate of delegation from a genesis key to the `SigningKey`
-> Body
-> Block

Smart constructor for Block

mkBlockExplicit Source #

Arguments

:: ProtocolMagicId
-> ProtocolVersion
-> SoftwareVersion
-> HeaderHash
-> ChainDifficulty
-> EpochSlots
-> SlotNumber
-> SigningKey	The `SigningKey` used for signing the block
-> Certificate	A certificate of delegation from a genesis key to the `SigningKey`
-> Body
-> Block

Smart constructor for Block , without requiring the entire previous Header . Instead, you give its hash and the difficulty of this block. These are derived from the previous header in mkBlock so if you have the previous header, consider using that one.

Block Accessors

blockHash :: EpochSlots -> Block -> HeaderHash Source #

blockHashAnnotated :: ABlock ByteString -> HeaderHash Source #

blockAProtocolMagicId :: ABlock a -> Annotated ProtocolMagicId a Source #

blockProtocolMagicId :: ABlock a -> ProtocolMagicId Source #

blockPrevHash :: ABlock a -> HeaderHash Source #

blockProof :: ABlock a -> Proof Source #

blockSlot :: ABlock a -> SlotNumber Source #

blockGenesisKey :: ABlock a -> VerificationKey Source #

blockIssuer :: ABlock a -> VerificationKey Source #

blockDifficulty :: ABlock a -> ChainDifficulty Source #

blockToSign :: EpochSlots -> ABlock a -> ToSign Source #

blockSignature :: ABlock a -> ABlockSignature a Source #

blockProtocolVersion :: ABlock a -> ProtocolVersion Source #

blockSoftwareVersion :: ABlock a -> SoftwareVersion Source #

blockTxPayload :: ABlock a -> ATxPayload a Source #

blockSscPayload :: ABlock a -> SscPayload Source #

blockDlgPayload :: ABlock a -> APayload a Source #

blockUpdatePayload :: ABlock a -> APayload a Source #

blockLength :: ABlock ByteString -> Natural Source #

Block Binary Serialization

toCBORBlock :: EpochSlots -> Block -> Encoding Source #

Encode a block, given a number of slots-per-epoch.

Unlike toCBORABOBBlock , this function does not take the deprecated epoch boundary blocks into account.

fromCBORABlock :: EpochSlots -> Decoder s ( ABlock ByteSpan ) Source #

Block Formatting

renderBlock :: EpochSlots -> Block -> Builder Source #

ABlockOrBoundary

data ABlockOrBoundary a Source #

Constructors

ABOBBlock ( ABlock a)
ABOBBoundary ( ABoundaryBlock a)

Instances

Instances details

Functor ABlockOrBoundary Source #
Instance details Defined in Cardano.Chain.Block.Block Methods fmap :: (a -> b) -> ABlockOrBoundary a -> ABlockOrBoundary b Source # (<$) :: a -> ABlockOrBoundary b -> ABlockOrBoundary a Source #
Eq a => Eq ( ABlockOrBoundary a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods (==) :: ABlockOrBoundary a -> ABlockOrBoundary a -> Bool Source # (/=) :: ABlockOrBoundary a -> ABlockOrBoundary a -> Bool Source #
Show a => Show ( ABlockOrBoundary a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods showsPrec :: Int -> ABlockOrBoundary a -> ShowS Source # show :: ABlockOrBoundary a -> String Source # showList :: [ ABlockOrBoundary a] -> ShowS Source #
Generic ( ABlockOrBoundary a) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type Rep ( ABlockOrBoundary a) :: Type -> Type Source # Methods from :: ABlockOrBoundary a -> Rep ( ABlockOrBoundary a) x Source # to :: Rep ( ABlockOrBoundary a) x -> ABlockOrBoundary a Source #
ToJSON a => ToJSON ( ABlockOrBoundary a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods toJSON :: ABlockOrBoundary a -> Value Source # toEncoding :: ABlockOrBoundary a -> Encoding Source # toJSONList :: [ ABlockOrBoundary a] -> Value Source # toEncodingList :: [ ABlockOrBoundary a] -> Encoding Source #
type Rep ( ABlockOrBoundary a) Source #
Instance details Defined in Cardano.Chain.Block.Block type Rep ( ABlockOrBoundary a) = D1 (' MetaData "ABlockOrBoundary" "Cardano.Chain.Block.Block" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABOBBlock" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( ABlock a))) :+: C1 (' MetaCons "ABOBBoundary" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( ABoundaryBlock a))))

toCBORABOBBlock :: EpochSlots -> ABlock a -> Encoding Source #

Encode a Block accounting for deprecated epoch boundary blocks

fromCBORABOBBlock :: EpochSlots -> Decoder s ( Maybe Block ) Source #

Decode a Block accounting for deprecated epoch boundary blocks

fromCBORABlockOrBoundary :: EpochSlots -> Decoder s ( ABlockOrBoundary ByteSpan ) Source #

Decode a Block accounting for deprecated epoch boundary blocks

Previous versions of Cardano had an explicit boundary block between epochs. A Block was then represented as 'Either BoundaryBlock MainBlock'. We have now deprecated these explicit boundary blocks, but we still need to decode blocks in the old format. In the case that we find a boundary block, we drop it using dropBoundaryBlock and return a Nothing .

toCBORABlockOrBoundary :: ProtocolMagicId -> EpochSlots -> ABlockOrBoundary a -> Encoding Source #

ABoundaryBlock

data ABoundaryBlock a Source #

For a boundary block, we keep the header, body, and an annotation for the whole thing (commonly the bytes from which it was decoded).

Constructors

ABoundaryBlock
Fields boundaryBlockLength :: ! Int64 Needed for validation. boundaryHeader :: !( ABoundaryHeader a) boundaryBody :: !( ABoundaryBody a) boundaryAnnotation :: !a

Instances

Instances details

Functor ABoundaryBlock Source #
Instance details Defined in Cardano.Chain.Block.Block Methods fmap :: (a -> b) -> ABoundaryBlock a -> ABoundaryBlock b Source # (<$) :: a -> ABoundaryBlock b -> ABoundaryBlock a Source #
Eq a => Eq ( ABoundaryBlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods (==) :: ABoundaryBlock a -> ABoundaryBlock a -> Bool Source # (/=) :: ABoundaryBlock a -> ABoundaryBlock a -> Bool Source #
Show a => Show ( ABoundaryBlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods showsPrec :: Int -> ABoundaryBlock a -> ShowS Source # show :: ABoundaryBlock a -> String Source # showList :: [ ABoundaryBlock a] -> ShowS Source #
Generic ( ABoundaryBlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type Rep ( ABoundaryBlock a) :: Type -> Type Source # Methods from :: ABoundaryBlock a -> Rep ( ABoundaryBlock a) x Source # to :: Rep ( ABoundaryBlock a) x -> ABoundaryBlock a Source #
ToJSON a => ToJSON ( ABoundaryBlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods toJSON :: ABoundaryBlock a -> Value Source # toEncoding :: ABoundaryBlock a -> Encoding Source # toJSONList :: [ ABoundaryBlock a] -> Value Source # toEncodingList :: [ ABoundaryBlock a] -> Encoding Source #
Decoded ( ABoundaryBlock ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type BaseType ( ABoundaryBlock ByteString ) Source # Methods recoverBytes :: ABoundaryBlock ByteString -> ByteString Source #
Buildable ( ABoundaryBlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods build :: ABoundaryBlock a -> Builder Source #
type Rep ( ABoundaryBlock a) Source #
Instance details Defined in Cardano.Chain.Block.Block type Rep ( ABoundaryBlock a) = D1 (' MetaData "ABoundaryBlock" "Cardano.Chain.Block.Block" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABoundaryBlock" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "boundaryBlockLength") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Int64 ) :: S1 (' MetaSel (' Just "boundaryHeader") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ABoundaryHeader a))) :: ( S1 (' MetaSel (' Just "boundaryBody") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ABoundaryBody a)) :*: S1 (' MetaSel (' Just "boundaryAnnotation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a))))
type BaseType ( ABoundaryBlock ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Block type BaseType ( ABoundaryBlock ByteString ) = ABoundaryBlock ()

boundaryHashAnnotated :: ABoundaryBlock ByteString -> HeaderHash Source #

Extract the hash of a boundary block from its annotation.

fromCBORABoundaryBlock :: Decoder s ( ABoundaryBlock ByteSpan ) Source #

toCBORABoundaryBlock :: ProtocolMagicId -> ABoundaryBlock a -> Encoding Source #

See note on toCBORABoundaryHeader . This as well does not necessarily invert the decoder fromCBORABoundaryBlock .

toCBORABOBBoundary :: ProtocolMagicId -> ABoundaryBlock a -> Encoding Source #

toCBORABoundaryBlock but with the list length and tag discriminator bytes.

boundaryBlockSlot Source #

Arguments

:: EpochSlots
-> Word64	Epoch number
-> SlotNumber

Compute the slot number assigned to a boundary block

data ABoundaryBody a Source #

For boundary body data, we only keep an annotation. It's the body and extra body data.

Constructors

ABoundaryBody
Fields boundaryBodyAnnotation :: !a

Instances

Instances details

Functor ABoundaryBody Source #
Instance details Defined in Cardano.Chain.Block.Block Methods fmap :: (a -> b) -> ABoundaryBody a -> ABoundaryBody b Source # (<$) :: a -> ABoundaryBody b -> ABoundaryBody a Source #
Eq a => Eq ( ABoundaryBody a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods (==) :: ABoundaryBody a -> ABoundaryBody a -> Bool Source # (/=) :: ABoundaryBody a -> ABoundaryBody a -> Bool Source #
Show a => Show ( ABoundaryBody a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods showsPrec :: Int -> ABoundaryBody a -> ShowS Source # show :: ABoundaryBody a -> String Source # showList :: [ ABoundaryBody a] -> ShowS Source #
Generic ( ABoundaryBody a) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type Rep ( ABoundaryBody a) :: Type -> Type Source # Methods from :: ABoundaryBody a -> Rep ( ABoundaryBody a) x Source # to :: Rep ( ABoundaryBody a) x -> ABoundaryBody a Source #
ToJSON a => ToJSON ( ABoundaryBody a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods toJSON :: ABoundaryBody a -> Value Source # toEncoding :: ABoundaryBody a -> Encoding Source # toJSONList :: [ ABoundaryBody a] -> Value Source # toEncodingList :: [ ABoundaryBody a] -> Encoding Source #
Decoded ( ABoundaryBody ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type BaseType ( ABoundaryBody ByteString ) Source # Methods recoverBytes :: ABoundaryBody ByteString -> ByteString Source #
type Rep ( ABoundaryBody a) Source #
Instance details Defined in Cardano.Chain.Block.Block type Rep ( ABoundaryBody a) = D1 (' MetaData "ABoundaryBody" "Cardano.Chain.Block.Block" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABoundaryBody" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "boundaryBodyAnnotation") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 a)))
type BaseType ( ABoundaryBody ByteString ) Source #
Instance details Defined in Cardano.Chain.Block.Block type BaseType ( ABoundaryBody ByteString ) = ABoundaryBody ()

ABlockOrBoundaryHdr

data ABlockOrBoundaryHdr a Source #

Constructors

ABOBBlockHdr !( AHeader a)
ABOBBoundaryHdr !( ABoundaryHeader a)

Instances

Instances details

Functor ABlockOrBoundaryHdr Source #
Instance details Defined in Cardano.Chain.Block.Block Methods fmap :: (a -> b) -> ABlockOrBoundaryHdr a -> ABlockOrBoundaryHdr b Source # (<$) :: a -> ABlockOrBoundaryHdr b -> ABlockOrBoundaryHdr a Source #
Eq a => Eq ( ABlockOrBoundaryHdr a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods (==) :: ABlockOrBoundaryHdr a -> ABlockOrBoundaryHdr a -> Bool Source # (/=) :: ABlockOrBoundaryHdr a -> ABlockOrBoundaryHdr a -> Bool Source #
Show a => Show ( ABlockOrBoundaryHdr a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods showsPrec :: Int -> ABlockOrBoundaryHdr a -> ShowS Source # show :: ABlockOrBoundaryHdr a -> String Source # showList :: [ ABlockOrBoundaryHdr a] -> ShowS Source #
Generic ( ABlockOrBoundaryHdr a) Source #
Instance details Defined in Cardano.Chain.Block.Block Associated Types type Rep ( ABlockOrBoundaryHdr a) :: Type -> Type Source # Methods from :: ABlockOrBoundaryHdr a -> Rep ( ABlockOrBoundaryHdr a) x Source # to :: Rep ( ABlockOrBoundaryHdr a) x -> ABlockOrBoundaryHdr a Source #
NoThunks a => NoThunks ( ABlockOrBoundaryHdr a) Source #
Instance details Defined in Cardano.Chain.Block.Block Methods noThunks :: Context -> ABlockOrBoundaryHdr a -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ABlockOrBoundaryHdr a -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ABlockOrBoundaryHdr a) -> String Source #
type Rep ( ABlockOrBoundaryHdr a) Source #
Instance details Defined in Cardano.Chain.Block.Block type Rep ( ABlockOrBoundaryHdr a) = D1 (' MetaData "ABlockOrBoundaryHdr" "Cardano.Chain.Block.Block" "cardano-ledger-byron-0.1.0.0-1U5kXR8zMRrE7QjCz70XVD" ' False ) ( C1 (' MetaCons "ABOBBlockHdr" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( AHeader a))) :+: C1 (' MetaCons "ABOBBoundaryHdr" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ABoundaryHeader a))))

aBlockOrBoundaryHdr :: ( AHeader a -> b) -> ( ABoundaryHeader a -> b) -> ABlockOrBoundaryHdr a -> b Source #

The analogue of either

fromCBORABlockOrBoundaryHdr :: EpochSlots -> Decoder s ( ABlockOrBoundaryHdr ByteSpan ) Source #

toCBORABlockOrBoundaryHdr :: ABlockOrBoundaryHdr ByteString -> Encoding Source #

Encoder for ABlockOrBoundaryHdr which is using the annotation. It is right inverse of fromCBORAblockOrBoundaryHdr .

TODO: add a round trip test, e.g.

fromCBORABlockOrBoundaryHdr . toCBORABlockOrBoundaryHdr = id

which does not type check, but convey the meaning.

toCBORABlockOrBoundaryHdrSize :: Proxy ( ABlockOrBoundaryHdr a) -> Size Source #

The size computation is compatible with toCBORABlockOrBoundaryHdr

abobHdrFromBlock :: ABlockOrBoundary a -> ABlockOrBoundaryHdr a Source #

abobHdrSlotNo :: EpochSlots -> ABlockOrBoundaryHdr a -> SlotNumber Source #

Slot number of the header

NOTE: Epoch slot number calculation must match the one in applyBoundary .

abobHdrChainDifficulty :: ABlockOrBoundaryHdr a -> ChainDifficulty Source #

abobHdrHash :: ABlockOrBoundaryHdr ByteString -> HeaderHash Source #

abobHdrPrevHash :: ABlockOrBoundaryHdr a -> Maybe HeaderHash Source #