Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.ByronDual.Ledger

Contents

Shorthand
Bridge
Block forging
Orphan instances

Synopsis

type DualByronBlock = DualBlock ByronBlock ByronSpecBlock
type DualByronBridge = BridgeLedger ByronBlock ByronSpecBlock
data ByronSpecBridge = ByronSpecBridge {
- toSpecKeys :: Map (PBftVerKeyHash PBftByronCrypto) VKey
- toImplIds :: SpecToImplIds
}
newtype SpecToImplIds = SpecToImplIds {
- getSpecToImplIds :: AbstractToConcreteIdMaps
}
bridgeToSpecKey :: DualByronBridge -> PBftVerKeyHash PBftByronCrypto -> VKey
bridgeTransactionIds :: DualByronBridge -> Map TxId TxId
initByronSpecBridge :: ByronSpecGenesis -> Map TxId TxId -> ByronSpecBridge
specToImplTx :: Tx -> ATxAux ByteString -> SpecToImplIds
forgeDualByronBlock :: HasCallStack => TopLevelConfig DualByronBlock -> BlockNo -> SlotNo -> TickedLedgerState DualByronBlock -> [Validated (GenTx DualByronBlock)] -> PBftIsLeader PBftByronCrypto -> DualByronBlock

Shorthand

type DualByronBlock = DualBlock ByronBlock ByronSpecBlock Source #

type DualByronBridge = BridgeLedger ByronBlock ByronSpecBlock Source #

Bridge

data ByronSpecBridge Source #

Bridge the gap between the Byron implementation and specification

The relation between the Byron implementation and specification for the linear case is tested in the Byron implementation itself, specifically in ts_prop_generatedChainsAreValidated. The main goal of the consensus DualByron tests is to lift these tests to the general consensus setting, where time is not linear but branching.

In the linear case, the tests maintain some state linking the spec and the implementation. In the consensus case, this state cannot be maintained like this, and so it has to become part of transactions, blocks, and the ledger state itself.

Constructors

ByronSpecBridge

Fields

toSpecKeys :: Map (PBftVerKeyHash PBftByronCrypto) VKey
Map between keys
Some observations:
- The abstract chain environment contains a set of allowed delegators (of type Set VKeyGenesis), which gets translated to gdGenesisKeyHashes (of type Set Common.KeyHash) in the concrete genesis config.
- During the translation from abstract blocks to concrete blocks, the VKey of the block is translated to a concrete SigningKey (as well as a VerificationKey) in elaborateKeyPair.
- Although this translation is deterministic, it doesn't have an easily definable inverse. For this reason, we maintain an opposite mapping as part of the ledger state.
toImplIds :: SpecToImplIds
Mapping between abstract and concrete Ids
We need to maintain this mapping so that we can use the abstract state generators and then elaborate to concrete values.

Instances

Instances details

Eq ByronSpecBridge Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods (==) :: ByronSpecBridge -> ByronSpecBridge -> Bool Source # (/=) :: ByronSpecBridge -> ByronSpecBridge -> Bool Source #
Show ByronSpecBridge Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods showsPrec :: Int -> ByronSpecBridge -> ShowS Source # show :: ByronSpecBridge -> String Source # showList :: [ByronSpecBridge] -> ShowS Source #
Generic ByronSpecBridge Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Associated Types type Rep ByronSpecBridge :: Type -> Type Source # Methods from :: ByronSpecBridge -> Rep ByronSpecBridge x Source # to :: Rep ByronSpecBridge x -> ByronSpecBridge Source #
Serialise ByronSpecBridge Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods encode :: ByronSpecBridge -> Encoding decode :: Decoder s ByronSpecBridge encodeList :: [ByronSpecBridge] -> Encoding decodeList :: Decoder s [ByronSpecBridge]
type Rep ByronSpecBridge Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger type Rep ByronSpecBridge = D1 ('MetaData "ByronSpecBridge" "Ouroboros.Consensus.ByronDual.Ledger" "ouroboros-consensus-cardano-0.12.1.0-3K5xAUhoXzXHlw2xbNhg7E-unstable-byron-testlib" 'False) (C1 ('MetaCons "ByronSpecBridge" 'PrefixI 'True) (S1 ('MetaSel ('Just "toSpecKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (PBftVerKeyHash PBftByronCrypto) VKey)) :*: S1 ('MetaSel ('Just "toImplIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecToImplIds)))

newtype SpecToImplIds Source #

Constructors

SpecToImplIds
Fields getSpecToImplIds :: AbstractToConcreteIdMaps

Instances

Instances details

Eq SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods (==) :: SpecToImplIds -> SpecToImplIds -> Bool Source # (/=) :: SpecToImplIds -> SpecToImplIds -> Bool Source #
Show SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods showsPrec :: Int -> SpecToImplIds -> ShowS Source # show :: SpecToImplIds -> String Source # showList :: [SpecToImplIds] -> ShowS Source #
Generic SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Associated Types type Rep SpecToImplIds :: Type -> Type Source # Methods from :: SpecToImplIds -> Rep SpecToImplIds x Source # to :: Rep SpecToImplIds x -> SpecToImplIds Source #
Semigroup SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods (<>) :: SpecToImplIds -> SpecToImplIds -> SpecToImplIds Source # sconcat :: NonEmpty SpecToImplIds -> SpecToImplIds Source # stimes :: Integral b => b -> SpecToImplIds -> SpecToImplIds Source #
Monoid SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods mempty :: SpecToImplIds Source # mappend :: SpecToImplIds -> SpecToImplIds -> SpecToImplIds Source # mconcat :: [SpecToImplIds] -> SpecToImplIds Source #
Serialise SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger Methods encode :: SpecToImplIds -> Encoding decode :: Decoder s SpecToImplIds encodeList :: [SpecToImplIds] -> Encoding decodeList :: Decoder s [SpecToImplIds]
type Rep SpecToImplIds Source #
Instance details Defined in Ouroboros.Consensus.ByronDual.Ledger type Rep SpecToImplIds = D1 ('MetaData "SpecToImplIds" "Ouroboros.Consensus.ByronDual.Ledger" "ouroboros-consensus-cardano-0.12.1.0-3K5xAUhoXzXHlw2xbNhg7E-unstable-byron-testlib" 'True) (C1 ('MetaCons "SpecToImplIds" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSpecToImplIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AbstractToConcreteIdMaps)))

bridgeToSpecKey :: DualByronBridge -> PBftVerKeyHash PBftByronCrypto -> VKey Source #

Translate issuer key

We get a proof from PBFT that we are the leader, including a signing key (of type SigningKey). In order to produce the corresponding abstract block, we need a VKey.

bridgeTransactionIds :: DualByronBridge -> Map TxId TxId Source #

initByronSpecBridge Source #

Arguments

:: ByronSpecGenesis
-> Map TxId TxId	Mapping for the transaction in the initial UTxO
-> ByronSpecBridge

specToImplTx :: Tx -> ATxAux ByteString -> SpecToImplIds Source #

Construct singleton SpecToImplIds for a transaction

Block forging

forgeDualByronBlock Source #

Arguments

:: HasCallStack
=> TopLevelConfig DualByronBlock
-> BlockNo	Current block number
-> SlotNo	Current slot number
-> TickedLedgerState DualByronBlock	Ledger
-> [Validated (GenTx DualByronBlock)]	Txs to add in the block
-> PBftIsLeader PBftByronCrypto	Leader proof (`IsLeader`)
-> DualByronBlock

Orphan instances

Bridge ByronBlock ByronSpecBlock Source #

Instance details

Associated Types

type BridgeLedger ByronBlock ByronSpecBlock

type BridgeBlock ByronBlock ByronSpecBlock

type BridgeTx ByronBlock ByronSpecBlock

Methods

updateBridgeWithBlock :: DualBlock ByronBlock ByronSpecBlock -> BridgeLedger ByronBlock ByronSpecBlock -> BridgeLedger ByronBlock ByronSpecBlock

updateBridgeWithTx :: Validated (GenTx (DualBlock ByronBlock ByronSpecBlock)) -> BridgeLedger ByronBlock ByronSpecBlock -> BridgeLedger ByronBlock ByronSpecBlock