ouroboros-consensus-0.26.0.0: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Mock.Ledger.Stake

Synopsis

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

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 ∷ k) ∷ k 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
Show (Ticked ()) 
Instance details

Defined in Ouroboros.Consensus.Ticked

Methods

showsPrec ∷ Int → Ticked () → ShowS #

show ∷ Ticked () → String #

showList ∷ [Ticked ()] → ShowS #

Bridge m a ⇒ GetTip (Ticked (LedgerState (DualBlock m a))) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked (LedgerState (DualBlock m a)) mk → Point (Ticked (LedgerState (DualBlock m a))) Source #

GetTip (Ticked (LedgerState (TestBlockWith ptype))) 
Instance details

Defined in Test.Util.TestBlock

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked (LedgerState (TestBlockWith ptype)) mk → Point (Ticked (LedgerState (TestBlockWith ptype))) Source #

GetTip (Ticked (LedgerState (SimpleBlock c ext))) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked (LedgerState (SimpleBlock c ext)) mk → Point (Ticked (LedgerState (SimpleBlock c ext))) Source #

IsLedger (LedgerState blk) ⇒ GetTip (Ticked (ExtLedgerState blk)) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

Methods

getTip ∷ ∀ (mk ∷ MapKind). Ticked (ExtLedgerState blk) mk → Point (Ticked (ExtLedgerState blk)) Source #

CanStowLedgerTables (Ticked (LedgerState (SimpleBlock c ext))) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

Methods

stowLedgerTables ∷ Ticked (LedgerState (SimpleBlock c ext)) ValuesMK → Ticked (LedgerState (SimpleBlock c ext)) EmptyMK Source #

unstowLedgerTables ∷ Ticked (LedgerState (SimpleBlock c ext)) EmptyMK → Ticked (LedgerState (SimpleBlock c ext)) ValuesMK Source #

(Bridge m a, NoThunks (TxOut (LedgerState m)), NoThunks (TxIn (LedgerState m)), Show (TxOut (LedgerState m)), Show (TxIn (LedgerState m)), Eq (TxOut (LedgerState m)), Ord (TxIn (LedgerState m)), MemPack (TxIn (LedgerState m))) ⇒ HasLedgerTables (Ticked (LedgerState (DualBlock m a))) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (DualBlock m a)) mk → LedgerTables (Ticked (LedgerState (DualBlock m a))) mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (DualBlock m a)) any → LedgerTables (Ticked (LedgerState (DualBlock m a))) mk → Ticked (LedgerState (DualBlock m a)) mk Source #

HasLedgerTables (Ticked (LedgerState TestBlock)) 
Instance details

Defined in Test.Util.TestBlock

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState TestBlock) mk → LedgerTables (Ticked (LedgerState TestBlock)) mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState TestBlock) any → LedgerTables (Ticked (LedgerState TestBlock)) mk → Ticked (LedgerState TestBlock) mk Source #

HasLedgerTables (Ticked (LedgerState (SimpleBlock c ext))) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (SimpleBlock c ext)) mk → LedgerTables (Ticked (LedgerState (SimpleBlock c ext))) mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (LedgerState (SimpleBlock c ext)) any → LedgerTables (Ticked (LedgerState (SimpleBlock c ext))) mk → Ticked (LedgerState (SimpleBlock c ext)) mk Source #

(HasLedgerTables (Ticked (LedgerState blk)), NoThunks (TxOut (LedgerState blk)), NoThunks (TxIn (LedgerState blk)), Show (TxOut (LedgerState blk)), Show (TxIn (LedgerState blk)), Eq (TxOut (LedgerState blk)), Ord (TxIn (LedgerState blk)), MemPack (TxIn (LedgerState blk))) ⇒ HasLedgerTables (Ticked (ExtLedgerState blk)) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

Methods

projectLedgerTables ∷ ∀ (mk ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (ExtLedgerState blk) mk → LedgerTables (Ticked (ExtLedgerState blk)) mk Source #

withLedgerTables ∷ ∀ (mk ∷ MapKind) (any ∷ MapKind). (CanMapMK mk, CanMapKeysMK mk, ZeroableMK mk) ⇒ Ticked (ExtLedgerState blk) any → LedgerTables (Ticked (ExtLedgerState blk)) mk → Ticked (ExtLedgerState blk) mk Source #

LedgerTablesAreTrivial (Ticked (LedgerState TestBlock)) 
Instance details

Defined in Test.Util.TestBlock

Methods

convertMapKind ∷ ∀ (mk ∷ MapKind) (mk' ∷ MapKind). Ticked (LedgerState TestBlock) mk → Ticked (LedgerState TestBlock) mk' Source #

LedgerTablesAreTrivial (Ticked (LedgerState blk)) ⇒ LedgerTablesAreTrivial (Ticked (ExtLedgerState blk)) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

Methods

convertMapKind ∷ ∀ (mk ∷ MapKind) (mk' ∷ MapKind). Ticked (ExtLedgerState blk) mk → Ticked (ExtLedgerState blk) mk' Source #

Generic (Ticked (LedgerState (TestBlockWith ptype)) mk) 
Instance details

Defined in Test.Util.TestBlock

Associated Types

type Rep (Ticked (LedgerState (TestBlockWith ptype)) mk) 
Instance details

Defined in Test.Util.TestBlock

type Rep (Ticked (LedgerState (TestBlockWith ptype)) mk) = D1 ('MetaData "Ticked" "Test.Util.TestBlock" "ouroboros-consensus-0.26.0.0-inplace-unstable-consensus-testlib" 'True) (C1 ('MetaCons "TickedTestLedger" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedTestLedger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (TestBlockWith ptype) mk))))

Methods

from ∷ Ticked (LedgerState (TestBlockWith ptype)) mk → Rep (Ticked (LedgerState (TestBlockWith ptype)) mk) x #

to ∷ Rep (Ticked (LedgerState (TestBlockWith ptype)) mk) x → Ticked (LedgerState (TestBlockWith ptype)) mk #

Generic (Ticked (LedgerState (SimpleBlock c ext)) mk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

Associated Types

type Rep (Ticked (LedgerState (SimpleBlock c ext)) mk) 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

type Rep (Ticked (LedgerState (SimpleBlock c ext)) mk) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.Mock.Ledger.Block" "ouroboros-consensus-0.26.0.0-inplace-unstable-mock-block" 'True) (C1 ('MetaCons "TickedSimpleLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedSimpleLedgerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (SimpleBlock c ext) mk))))

Methods

from ∷ Ticked (LedgerState (SimpleBlock c ext)) mk → Rep (Ticked (LedgerState (SimpleBlock c ext)) mk) x #

to ∷ Rep (Ticked (LedgerState (SimpleBlock c ext)) mk) x → Ticked (LedgerState (SimpleBlock c ext)) mk #

(SimpleCrypto c, Typeable ext, Show (LedgerState (SimpleBlock c ext) mk)) ⇒ Show (Ticked (LedgerState (SimpleBlock c ext)) mk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

Methods

showsPrec ∷ Int → Ticked (LedgerState (SimpleBlock c ext)) mk → ShowS #

show ∷ Ticked (LedgerState (SimpleBlock c ext)) mk → String #

showList ∷ [Ticked (LedgerState (SimpleBlock c ext)) mk] → ShowS #

NoThunks (Ticked (LedgerState (DualBlock m a)) mk) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks ∷ Context → Ticked (LedgerState (DualBlock m a)) mk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Ticked (LedgerState (DualBlock m a)) mk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Ticked (LedgerState (DualBlock m a)) mk) → String Source #

(NoThunksMK mk, NoThunks (PayloadDependentState ptype mk)) ⇒ NoThunks (Ticked (LedgerState (TestBlockWith ptype)) mk) 
Instance details

Defined in Test.Util.TestBlock

Methods

noThunks ∷ Context → Ticked (LedgerState (TestBlockWith ptype)) mk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Ticked (LedgerState (TestBlockWith ptype)) mk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Ticked (LedgerState (TestBlockWith ptype)) mk) → String Source #

(SimpleCrypto c, Typeable ext) ⇒ NoThunks (Ticked (LedgerState (SimpleBlock c ext)) TrackingMK) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

Methods

noThunks ∷ Context → Ticked (LedgerState (SimpleBlock c ext)) TrackingMK → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Ticked (LedgerState (SimpleBlock c ext)) TrackingMK → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Ticked (LedgerState (SimpleBlock c ext)) TrackingMK) → String Source #

Show (Ticked (f a)) ⇒ Show (((Ticked ∷ Type → Type) :.: f) a) 
Instance details

Defined in Ouroboros.Consensus.Ticked

Methods

showsPrec ∷ Int → ((Ticked ∷ Type → Type) :.: f) a → ShowS #

show ∷ ((Ticked ∷ Type → Type) :.: f) a → String #

showList ∷ [((Ticked ∷ Type → Type) :.: f) a] → ShowS #

NoThunks (Ticked (f a)) ⇒ NoThunks (((Ticked ∷ Type → Type) :.: f) a) 
Instance details

Defined in Ouroboros.Consensus.Ticked

Methods

noThunks ∷ Context → ((Ticked ∷ Type → Type) :.: f) a → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ((Ticked ∷ Type → Type) :.: f) a → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (((Ticked ∷ Type → Type) :.: f) a) → String Source #

data Ticked () 
Instance details

Defined in Ouroboros.Consensus.Ticked

data Ticked () = TickedTrivial
data Ticked (HardForkChainDepState xs ∷ Type) 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol

data Ticked (HardForkChainDepState xs ∷ Type) = TickedHardForkChainDepState {}
data Ticked (HeaderState blk ∷ Type) 
Instance details

Defined in Ouroboros.Consensus.HeaderValidation

data Ticked (HeaderState blk ∷ Type) = TickedHeaderState {}
data Ticked (PBftState c ∷ Type) 
Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

data Ticked (PBftState c ∷ Type) = TickedPBftState {}
newtype Ticked (WrapChainDepState blk ∷ Type) 
Instance details

Defined in Ouroboros.Consensus.TypeFamilyWrappers

newtype Ticked (WrapChainDepState blk ∷ Type) = WrapTickedChainDepState {}
data Ticked (PraosChainDepState c ∷ Type) 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 ∷ Type) = TickedPraosChainDepState {}
type HeaderHash (Ticked l ∷ k) 
Instance details

Defined in Ouroboros.Consensus.Ticked

type HeaderHash (Ticked l ∷ k) = HeaderHash l
type TxIn (Ticked l) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Tables.Basics

type TxIn (Ticked l) = TxIn l
type TxOut (Ticked l) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Tables.Basics

type TxOut (Ticked l) = TxOut l
data Ticked (LedgerState (HardForkBlock xs) ∷ MapKind → Type) (mk ∷ MapKind) 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger

data Ticked (LedgerState (HardForkBlock xs) ∷ MapKind → Type) (mk ∷ MapKind) = TickedHardForkLedgerState {}
data Ticked (LedgerState (DualBlock m a) ∷ MapKind → Type) (mk ∷ MapKind) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

data Ticked (LedgerState (DualBlock m a) ∷ MapKind → Type) (mk ∷ MapKind) = TickedDualLedgerState {}
newtype Ticked (LedgerState (TestBlockWith ptype) ∷ MapKind → Type) (mk ∷ MapKind) 
Instance details

Defined in Test.Util.TestBlock

newtype Ticked (LedgerState (TestBlockWith ptype) ∷ MapKind → Type) (mk ∷ MapKind) = TickedTestLedger {}
newtype Ticked (LedgerState (SimpleBlock c ext) ∷ MapKind → Type) (mk ∷ MapKind) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

newtype Ticked (LedgerState (SimpleBlock c ext) ∷ MapKind → Type) (mk ∷ MapKind) = TickedSimpleLedgerState {}
data Ticked (ExtLedgerState blk ∷ MapKind → Type) (mk ∷ MapKind) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

data Ticked (ExtLedgerState blk ∷ MapKind → Type) (mk ∷ MapKind) = TickedExtLedgerState {}
type Rep (Ticked (LedgerState (TestBlockWith ptype)) mk) 
Instance details

Defined in Test.Util.TestBlock

type Rep (Ticked (LedgerState (TestBlockWith ptype)) mk) = D1 ('MetaData "Ticked" "Test.Util.TestBlock" "ouroboros-consensus-0.26.0.0-inplace-unstable-consensus-testlib" 'True) (C1 ('MetaCons "TickedTestLedger" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedTestLedger") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (TestBlockWith ptype) mk))))
type Rep (Ticked (LedgerState (SimpleBlock c ext)) mk) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Ledger.Block

type Rep (Ticked (LedgerState (SimpleBlock c ext)) mk) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.Mock.Ledger.Block" "ouroboros-consensus-0.26.0.0-inplace-unstable-mock-block" 'True) (C1 ('MetaCons "TickedSimpleLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "getTickedSimpleLedgerState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (LedgerState (SimpleBlock c ext) mk))))