ouroboros-consensus-byron-test-0.1.0.0: Test infrastructure for Byron
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.ByronDual.Ledger

Synopsis

Shorthand

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

  • toSpecKeysMap (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.
  • toImplIdsSpecToImplIds

    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

Show ByronSpecBridge Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Generic ByronSpecBridge Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Associated Types

type Rep ByronSpecBridgeTypeType Source #

Serialise ByronSpecBridge Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Methods

encodeByronSpecBridge → 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-byron-test-0.1.0.0-inplace" '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

Instances

Instances details
Eq SpecToImplIds Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Show SpecToImplIds Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Generic SpecToImplIds Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Associated Types

type Rep SpecToImplIdsTypeType Source #

Semigroup SpecToImplIds Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Monoid SpecToImplIds Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Serialise SpecToImplIds Source # 
Instance details

Defined in Ouroboros.Consensus.ByronDual.Ledger

Methods

encodeSpecToImplIds → 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-byron-test-0.1.0.0-inplace" 'True) (C1 ('MetaCons "SpecToImplIds" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSpecToImplIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AbstractToConcreteIdMaps)))

bridgeToSpecKeyDualByronBridgePBftVerKeyHash 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.

initByronSpecBridge Source #

Arguments

ByronSpecGenesis 
Map TxId TxId

Mapping for the transaction in the initial UTxO

ByronSpecBridge 

specToImplTx ∷ Tx → ATxAux ByteStringSpecToImplIds 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