Safe Haskell	Safe-Inferred
Language	Haskell2010

Byron.Spec.Chain.STS.Block

Synopsis

data BlockHeader = BlockHeader {
- _bhPrevHash ∷ !Hash
- _bhSlot ∷ !Slot
- _bhIssuer ∷ !VKey
- _bhSig ∷ !(Sig Hash)
- _bhUtxoHash ∷ !Hash
- _bhDlgHash ∷ !Hash
- _bhUpdHash ∷ !Hash
}
bhUtxoHash ∷ Lens' BlockHeader Hash
bhUpdHash ∷ Lens' BlockHeader Hash
bhSlot ∷ Lens' BlockHeader Slot
bhSig ∷ Lens' BlockHeader (Sig Hash)
bhPrevHash ∷ Lens' BlockHeader Hash
bhIssuer ∷ Lens' BlockHeader VKey
bhDlgHash ∷ Lens' BlockHeader Hash
data BlockBody = BlockBody {
- _bDCerts ∷ ![DCert]
- _bUtxo ∷ ![Tx]
- _bUpdProp ∷ !(Maybe UProp)
- _bUpdVotes ∷ ![Vote]
- _bProtVer ∷ !ProtVer
}
bUtxo ∷ Lens' BlockBody [Tx]
bUpdVotes ∷ Lens' BlockBody [Vote]
bUpdProp ∷ Lens' BlockBody (Maybe UProp)
bProtVer ∷ Lens' BlockBody ProtVer
bDCerts ∷ Lens' BlockBody [DCert]
data Block = Block {
- _bHeader ∷ BlockHeader
- _bBody ∷ BlockBody
}
bHeader ∷ Lens' Block BlockHeader
bBody ∷ Lens' Block BlockBody
mkBlock ∷ Hash → Slot → VKey → ProtVer → [DCert] → Maybe UProp → [Vote] → [Tx] → Block
genesisHash ∷ Hash
bEndorsment ∷ Block → (ProtVer, VKey)
bSlot ∷ Block → Slot
bUpdPayload ∷ Block → (Maybe UProp, [Vote])
bSize ∷ Block → Natural
bBodySize ∷ BlockBody → Natural
bHeaderSize ∷ BlockHeader → Natural
hashHeader ∷ BlockHeader → Hash
bhToSign ∷ BlockHeader → Hash
bhHash ∷ BlockHeader → Hash
bIsEBB ∷ Block → Bool
updateBody ∷ Block → (BlockBody → BlockBody) → Block
data BlockStats = BlockStats {
- blockStatsUtxo ∷ Word
- blockStatsDCerts ∷ Word
- blockStatsUpdVotes ∷ Word
- blockStatsUpdProp ∷ Word
}
blockStats ∷ Block → BlockStats
chainBlockStats ∷ [BlockStats] → Maybe (BlockStats, BlockStats, BlockStats)

Documentation

data BlockHeader Source #

Constructors

BlockHeader

Fields

_bhPrevHash ∷ !Hash
Hash of the previous block header, or genesisHash in case of the first block in a chain.
_bhSlot ∷ !Slot
Absolute slot for which the block was generated.
_bhIssuer ∷ !VKey
Block issuer.
_bhSig ∷ !(Sig Hash)
Part of the block header which must be signed.
_bhUtxoHash ∷ !Hash
UTxO hash
_bhDlgHash ∷ !Hash
Delegation hash
_bhUpdHash ∷ !Hash
Update payload hash

Instances

Instances details

Data BlockHeader Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → BlockHeader → c BlockHeader # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c BlockHeader # toConstr ∷ BlockHeader → Constr # dataTypeOf ∷ BlockHeader → DataType # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c BlockHeader) # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c BlockHeader) # gmapT ∷ (∀ b. Data b ⇒ b → b) → BlockHeader → BlockHeader # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → BlockHeader → r # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → BlockHeader → r # gmapQ ∷ (∀ d. Data d ⇒ d → u) → BlockHeader → [u] # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → BlockHeader → u # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → BlockHeader → m BlockHeader # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → BlockHeader → m BlockHeader # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → BlockHeader → m BlockHeader #
Generic BlockHeader Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Associated Types type Rep BlockHeader ∷ Type → Type # Methods from ∷ BlockHeader → Rep BlockHeader x # to ∷ Rep BlockHeader x → BlockHeader #
Show BlockHeader Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods showsPrec ∷ Int → BlockHeader → ShowS # show ∷ BlockHeader → String # showList ∷ [BlockHeader] → ShowS #
HasTypeReps BlockHeader Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods typeReps ∷ BlockHeader → Seq TypeRep Source #
Eq BlockHeader Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods (==) ∷ BlockHeader → BlockHeader → Bool # (/=) ∷ BlockHeader → BlockHeader → Bool #
type Rep BlockHeader Source #
Instance details Defined in Byron.Spec.Chain.STS.Block type Rep BlockHeader = D1 ('MetaData "BlockHeader" "Byron.Spec.Chain.STS.Block" "byron-spec-chain-1.0.1.0-inplace" 'False) (C1 ('MetaCons "BlockHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_bhPrevHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash) :: (S1 ('MetaSel ('Just "_bhSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Slot) :: S1 ('MetaSel ('Just "_bhIssuer") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VKey))) :: ((S1 ('MetaSel ('Just "_bhSig") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Sig Hash)) :: S1 ('MetaSel ('Just "_bhUtxoHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash)) :: (S1 ('MetaSel ('Just "_bhDlgHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash) :: S1 ('MetaSel ('Just "_bhUpdHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Hash)))))

bhUtxoHash ∷ Lens' BlockHeader Hash Source #

bhUpdHash ∷ Lens' BlockHeader Hash Source #

bhSlot ∷ Lens' BlockHeader Slot Source #

bhSig ∷ Lens' BlockHeader (Sig Hash) Source #

bhPrevHash ∷ Lens' BlockHeader Hash Source #

bhIssuer ∷ Lens' BlockHeader VKey Source #

bhDlgHash ∷ Lens' BlockHeader Hash Source #

data BlockBody Source #

Constructors

BlockBody
Fields _bDCerts ∷ ![DCert] Delegation certificates _bUtxo ∷ ![Tx] UTxO payload _bUpdProp ∷ !(Maybe UProp) Update proposal payload _bUpdVotes ∷ ![Vote] Update votes payload _bProtVer ∷ !ProtVer Protocol version

Instances

Instances details

Data BlockBody Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → BlockBody → c BlockBody # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c BlockBody # toConstr ∷ BlockBody → Constr # dataTypeOf ∷ BlockBody → DataType # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c BlockBody) # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c BlockBody) # gmapT ∷ (∀ b. Data b ⇒ b → b) → BlockBody → BlockBody # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → BlockBody → r # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → BlockBody → r # gmapQ ∷ (∀ d. Data d ⇒ d → u) → BlockBody → [u] # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → BlockBody → u # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → BlockBody → m BlockBody # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → BlockBody → m BlockBody # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → BlockBody → m BlockBody #
Generic BlockBody Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Associated Types type Rep BlockBody ∷ Type → Type # Methods from ∷ BlockBody → Rep BlockBody x # to ∷ Rep BlockBody x → BlockBody #
Show BlockBody Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods showsPrec ∷ Int → BlockBody → ShowS # show ∷ BlockBody → String # showList ∷ [BlockBody] → ShowS #
HasTypeReps BlockBody Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods typeReps ∷ BlockBody → Seq TypeRep Source #
type Rep BlockBody Source #
Instance details Defined in Byron.Spec.Chain.STS.Block type Rep BlockBody = D1 ('MetaData "BlockBody" "Byron.Spec.Chain.STS.Block" "byron-spec-chain-1.0.1.0-inplace" 'False) (C1 ('MetaCons "BlockBody" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_bDCerts") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [DCert]) :: S1 ('MetaSel ('Just "_bUtxo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Tx])) :: (S1 ('MetaSel ('Just "_bUpdProp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UProp)) :: (S1 ('MetaSel ('Just "_bUpdVotes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Vote]) :: S1 ('MetaSel ('Just "_bProtVer") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtVer)))))

bUtxo ∷ Lens' BlockBody [Tx] Source #

bUpdVotes ∷ Lens' BlockBody [Vote] Source #

bUpdProp ∷ Lens' BlockBody (Maybe UProp) Source #

bProtVer ∷ Lens' BlockBody ProtVer Source #

bDCerts ∷ Lens' BlockBody [DCert] Source #

data Block Source #

A block in the chain. The specification only models regular blocks since epoch boundary blocks will be largely ignored in the Byron-Shelley bridge.

Constructors

Block
Fields _bHeader ∷ BlockHeader _bBody ∷ BlockBody

Instances

Instances details

Data Block Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods gfoldl ∷ (∀ d b. Data d ⇒ c (d → b) → d → c b) → (∀ g. g → c g) → Block → c Block # gunfold ∷ (∀ b r. Data b ⇒ c (b → r) → c r) → (∀ r. r → c r) → Constr → c Block # toConstr ∷ Block → Constr # dataTypeOf ∷ Block → DataType # dataCast1 ∷ Typeable t ⇒ (∀ d. Data d ⇒ c (t d)) → Maybe (c Block) # dataCast2 ∷ Typeable t ⇒ (∀ d e. (Data d, Data e) ⇒ c (t d e)) → Maybe (c Block) # gmapT ∷ (∀ b. Data b ⇒ b → b) → Block → Block # gmapQl ∷ (r → r' → r) → r → (∀ d. Data d ⇒ d → r') → Block → r # gmapQr ∷ ∀ r r'. (r' → r → r) → r → (∀ d. Data d ⇒ d → r') → Block → r # gmapQ ∷ (∀ d. Data d ⇒ d → u) → Block → [u] # gmapQi ∷ Int → (∀ d. Data d ⇒ d → u) → Block → u # gmapM ∷ Monad m ⇒ (∀ d. Data d ⇒ d → m d) → Block → m Block # gmapMp ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → Block → m Block # gmapMo ∷ MonadPlus m ⇒ (∀ d. Data d ⇒ d → m d) → Block → m Block #
Generic Block Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Associated Types type Rep Block ∷ Type → Type # Methods from ∷ Block → Rep Block x # to ∷ Rep Block x → Block #
Show Block Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods showsPrec ∷ Int → Block → ShowS # show ∷ Block → String # showList ∷ [Block] → ShowS #
HasTypeReps Block Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods typeReps ∷ Block → Seq TypeRep Source #
HasSizeInfo Block Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods isTrivial ∷ Block → Bool Source #
type Rep Block Source #
Instance details Defined in Byron.Spec.Chain.STS.Block type Rep Block = D1 ('MetaData "Block" "Byron.Spec.Chain.STS.Block" "byron-spec-chain-1.0.1.0-inplace" 'False) (C1 ('MetaCons "Block" 'PrefixI 'True) (S1 ('MetaSel ('Just "_bHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockHeader) :*: S1 ('MetaSel ('Just "_bBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockBody)))

bHeader ∷ Lens' Block BlockHeader Source #

bBody ∷ Lens' Block BlockBody Source #

mkBlock Source #

Arguments

∷ Hash	Hash of the previous block
→ Slot	Current slot
→ VKey	Issuer
→ ProtVer	Protocol version
→ [DCert]	Delegation certificates
→ Maybe UProp	Update proposal
→ [Vote]	Votes on update proposals
→ [Tx]	UTxO payload
→ Block

genesisHash ∷ Hash Source #

Dummy genesis hash.

bEndorsment ∷ Block → (ProtVer, VKey) Source #

Protocol version endorsment

bSlot ∷ Block → Slot Source #

Slot the block is published in

bUpdPayload ∷ Block → (Maybe UProp, [Vote]) Source #

Block update payload

bSize ∷ Block → Natural Source #

Compute the abstract size (in words) that a block takes.

bBodySize ∷ BlockBody → Natural Source #

Compute the abstract size (in words) that a block body occupies.

bHeaderSize ∷ BlockHeader → Natural Source #

Compute the abstract size (in words) that a block header occupies.

hashHeader ∷ BlockHeader → Hash Source #

Computes the hash of a header.

bhToSign ∷ BlockHeader → Hash Source #

Computes the hash of the header.

bhHash ∷ BlockHeader → Hash Source #

bIsEBB ∷ Block → Bool Source #

Checks if a block is an epoch boundary block.

The function always returns False because tests will be performed only against chains without EBBs.

updateBody ∷ Block → (BlockBody → BlockBody) → Block Source #

Update a field of the block body, recomputing the hashes to get a valid block.

data BlockStats Source #

Constructors

BlockStats
Fields blockStatsUtxo ∷ Word Number of regular transactions blockStatsDCerts ∷ Word Number of delegation certificates blockStatsUpdVotes ∷ Word Number of update votes blockStatsUpdProp ∷ Word Number of update proposals For a single block this will be 0 or 1.

Instances

Instances details

Show BlockStats Source #
Instance details Defined in Byron.Spec.Chain.STS.Block Methods showsPrec ∷ Int → BlockStats → ShowS # show ∷ BlockStats → String # showList ∷ [BlockStats] → ShowS #

blockStats ∷ Block → BlockStats Source #

Count number of transactions in the block

Returns the number of

Regular transactions
Delegation certificates
Update votes
Update proposals (0 or 1)

chainBlockStats ∷ [BlockStats] → Maybe (BlockStats, BlockStats, BlockStats) Source #

Block stats for an entire chain

Computes minimum, maximum, and average values.

Returns Nothing for the empty chain.