Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Mock.Ledger.Stake

Contents

Stakeholders
Address distribution
Stake distribution
Type family instances

Synopsis

data StakeHolder
- = StakeCore CoreNodeId
- | StakeEverybodyElse
type AddrDist = Map Addr NodeId
newtype StakeDist = StakeDist {
- stakeDistToMap ∷ Map CoreNodeId Rational
}
equalStakeDist ∷ AddrDist → StakeDist
genesisStakeDist ∷ AddrDist → StakeDist
relativeStakes ∷ Map StakeHolder Amount → StakeDist
stakeWithDefault ∷ Rational → CoreNodeId → StakeDist → Rational
totalStakes ∷ Map Addr NodeId → Utxo → Map StakeHolder Amount
data family Ticked st

Stakeholders

data StakeHolder Source #

Constructors

StakeCore CoreNodeId	Stake of a core node
StakeEverybodyElse	Stake for everybody else (we don't need to distinguish)

Instances

Instances details

Show StakeHolder Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods showsPrec ∷ Int → StakeHolder → ShowS # show ∷ StakeHolder → String # showList ∷ [StakeHolder] → ShowS #
Eq StakeHolder Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods (==) ∷ StakeHolder → StakeHolder → Bool # (/=) ∷ StakeHolder → StakeHolder → Bool #
Ord StakeHolder Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods compare ∷ StakeHolder → StakeHolder → Ordering # (<) ∷ StakeHolder → StakeHolder → Bool # (<=) ∷ StakeHolder → StakeHolder → Bool # (>) ∷ StakeHolder → StakeHolder → Bool # (>=) ∷ StakeHolder → StakeHolder → Bool # max ∷ StakeHolder → StakeHolder → StakeHolder # min ∷ StakeHolder → StakeHolder → StakeHolder #

Address distribution

type AddrDist = Map Addr NodeId Source #

Mapping from addresses to node IDs

This is needed in order to assign stake to nodes.

Stake distribution

newtype StakeDist Source #

In the mock setup, only core nodes have stake

INVARIANT: The rationals should sum to 1.

Constructors

StakeDist
Fields stakeDistToMap ∷ Map CoreNodeId Rational

Instances

Instances details

Show StakeDist Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods showsPrec ∷ Int → StakeDist → ShowS # show ∷ StakeDist → String # showList ∷ [StakeDist] → ShowS #
Eq StakeDist Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods (==) ∷ StakeDist → StakeDist → Bool # (/=) ∷ StakeDist → StakeDist → Bool #
NoThunks StakeDist Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods noThunks ∷ Context → StakeDist → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → StakeDist → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy StakeDist → String Source #
Serialise StakeDist Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Stake Methods encode ∷ StakeDist → Encoding Source # decode ∷ Decoder s StakeDist Source # encodeList ∷ [StakeDist] → Encoding Source # decodeList ∷ Decoder s [StakeDist] Source #

equalStakeDist ∷ AddrDist → StakeDist Source #

Stake distribution where every address has equal state

genesisStakeDist ∷ AddrDist → StakeDist Source #

Genesis stake distribution

relativeStakes ∷ Map StakeHolder Amount → StakeDist Source #

stakeWithDefault ∷ Rational → CoreNodeId → StakeDist → Rational Source #

totalStakes ∷ Map Addr NodeId → Utxo → Map StakeHolder Amount Source #

Compute stakes of all nodes

The Nothing value holds the total stake of all addresses that don't get mapped to a NodeId.

Type family instances

data family Ticked st Source #

" Ticked " piece of state, either LedgerState or ChainDepState

Ticking refers to the passage of time (the ticking of the clock). When a piece of state is marked as ticked, it means that time-related changes have been applied to the state. There are exactly two methods in the interface that do that: tickChainDepState and applyChainTickLedgerResult.

Also note that a successful forecast forecastFor (ledgerViewForecastAt cfg st) slot must equal protocolLedgerView cfg (applyChainTick cfg slot st). Thus a LedgerView can only be projected from a Ticked state, but cannot itself be ticked.

Some examples of time related changes:

Scheduled delegations might have been applied in Byron
New leader schedule computed for Shelley
Transition from Byron to Shelley activated in the hard fork combinator.
Nonces switched out at the start of a new epoch.

Instances

Instances details

Generic (Ticked (LedgerState (SimpleBlock c ext))) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Associated Types type Rep (Ticked (LedgerState (SimpleBlock c ext))) ∷ Type → Type # Methods from ∷ Ticked (LedgerState (SimpleBlock c ext)) → Rep (Ticked (LedgerState (SimpleBlock c ext))) x # to ∷ Rep (Ticked (LedgerState (SimpleBlock c ext))) x → Ticked (LedgerState (SimpleBlock c ext)) #
(SimpleCrypto c, Typeable ext) ⇒ Show (Ticked (LedgerState (SimpleBlock c ext))) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods showsPrec ∷ Int → Ticked (LedgerState (SimpleBlock c ext)) → ShowS # show ∷ Ticked (LedgerState (SimpleBlock c ext)) → String # showList ∷ [Ticked (LedgerState (SimpleBlock c ext))] → ShowS #
Show (Ticked ())
Instance details Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → Ticked () → ShowS # show ∷ Ticked () → String # showList ∷ [Ticked ()] → ShowS #
(SimpleCrypto c, Typeable ext) ⇒ Eq (Ticked (LedgerState (SimpleBlock c ext))) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods (==) ∷ Ticked (LedgerState (SimpleBlock c ext)) → Ticked (LedgerState (SimpleBlock c ext)) → Bool # (/=) ∷ Ticked (LedgerState (SimpleBlock c ext)) → Ticked (LedgerState (SimpleBlock c ext)) → Bool #
(SimpleCrypto c, Typeable ext) ⇒ NoThunks (Ticked (LedgerState (SimpleBlock c ext))) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods noThunks ∷ Context → Ticked (LedgerState (SimpleBlock c ext)) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Ticked (LedgerState (SimpleBlock c ext)) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Ticked (LedgerState (SimpleBlock c ext))) → String Source #
GetTip (Ticked (LedgerState (SimpleBlock c ext))) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block Methods getTip ∷ Ticked (LedgerState (SimpleBlock c ext)) → Point (Ticked (LedgerState (SimpleBlock c ext))) Source #
IsLedger (LedgerState blk) ⇒ GetTip (Ticked (ExtLedgerState blk))
Instance details Defined in Ouroboros.Consensus.Ledger.Extended Methods getTip ∷ Ticked (ExtLedgerState blk) → Point (Ticked (ExtLedgerState blk)) Source #
Show (Ticked (f a)) ⇒ Show ((Ticked :.: f) a)
Instance details Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → (Ticked :.: f) a → ShowS # show ∷ (Ticked :.: f) a → String # showList ∷ [(Ticked :.: f) a] → ShowS #
NoThunks (Ticked (f a)) ⇒ NoThunks ((Ticked :.: f) a)
Instance details Defined in Ouroboros.Consensus.Ticked Methods noThunks ∷ Context → (Ticked :.: f) a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → (Ticked :.: f) a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ((Ticked :.: f) a) → String Source #
data Ticked ()
Instance details Defined in Ouroboros.Consensus.Ticked data Ticked () = TickedTrivial
type HeaderHash (Ticked l ∷ Type)
Instance details Defined in Ouroboros.Consensus.Ticked type HeaderHash (Ticked l ∷ Type) = HeaderHash l
type Rep (Ticked (LedgerState (SimpleBlock c ext))) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block type Rep (Ticked (LedgerState (SimpleBlock c ext))) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.Mock.Ledger.Block" "ouroboros-consensus-0.18.0.0-inplace-unstable-mock-block" 'True) (C1 ('MetaCons "TickedSimpleLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedSimpleLedgerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (SimpleBlock c ext)))))
data Ticked (HeaderState blk)
Instance details Defined in Ouroboros.Consensus.HeaderValidation data Ticked (HeaderState blk) = TickedHeaderState { untickedHeaderStateTip ∷ WithOrigin (AnnTip blk) tickedHeaderStateChainDep ∷ Ticked (ChainDepState (BlockProtocol blk)) }
newtype Ticked (LedgerState (SimpleBlock c ext)) Source #
Instance details Defined in Ouroboros.Consensus.Mock.Ledger.Block newtype Ticked (LedgerState (SimpleBlock c ext)) = TickedSimpleLedgerState { getTickedSimpleLedgerState ∷ LedgerState (SimpleBlock c ext) }
data Ticked (ExtLedgerState blk)
Instance details Defined in Ouroboros.Consensus.Ledger.Extended data Ticked (ExtLedgerState blk) = TickedExtLedgerState { tickedLedgerState ∷ Ticked (LedgerState blk) ledgerView ∷ LedgerView (BlockProtocol blk) tickedHeaderState ∷ Ticked (HeaderState blk) }
data Ticked (PBftState c)
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT data Ticked (PBftState c) = TickedPBftState { getPBftLedgerView ∷ LedgerView (PBft c) getTickedPBftState ∷ PBftState c }
newtype Ticked (WrapChainDepState blk)
Instance details Defined in Ouroboros.Consensus.TypeFamilyWrappers newtype Ticked (WrapChainDepState blk) = WrapTickedChainDepState { unwrapTickedChainDepState ∷ Ticked (ChainDepState (BlockProtocol blk)) }
data Ticked (PraosChainDepState c) Source #	Ticking the Praos chain dep state has no effect For the real Praos implementation, ticking is crucial, as it determines the point where the "nonce under construction" is swapped out for the "active" nonce. However, for the mock implementation, we keep the full history, and choose the right nonce from that; this means that ticking has no effect. We do however need access to the ticked stake distribution.
Instance details Defined in Ouroboros.Consensus.Mock.Protocol.Praos data Ticked (PraosChainDepState c) = TickedPraosChainDepState { praosLedgerView ∷ LedgerView (Praos c) untickedPraosChainDepState ∷ PraosChainDepState c }