Safe Haskell	None
Language	Haskell98

Shelley.Spec.Ledger.EpochBoundary

Description

This modules implements the necessary functions for the changes that can happen at epoch boundaries.

Synopsis

newtype Stake era = Stake {
- unStake ∷ Map (Credential 'Staking era) Coin
}
newtype BlocksMade era = BlocksMade {
- unBlocksMade ∷ Map (KeyHash 'StakePool (Crypto era)) Natural
}
data SnapShot era = SnapShot {
- _stake ∷ !(Stake era)
- _delegations ∷ !(Map (Credential 'Staking era) (KeyHash 'StakePool (Crypto era)))
- _poolParams ∷ !(Map (KeyHash 'StakePool (Crypto era)) (PoolParams era))
}
data SnapShots era = SnapShots {
- _pstakeMark ∷ !(SnapShot era)
- _pstakeSet ∷ !(SnapShot era)
- _pstakeGo ∷ !(SnapShot era)
- _feeSS ∷ !Coin
}
emptySnapShot ∷ SnapShot era
emptySnapShots ∷ SnapShots era
aggregateUtxoCoinByCredential ∷ ∀ era. ShelleyBased era ⇒ Map Ptr (Credential 'Staking era) → UTxO era → Map (Credential 'Staking era) Coin → Map (Credential 'Staking era) Coin
poolStake ∷ KeyHash 'StakePool (Crypto era) → Map (Credential 'Staking era) (KeyHash 'StakePool (Crypto era)) → Stake era → Stake era
obligation ∷ PParams era → Map (Credential 'Staking era) Coin → Map (KeyHash 'StakePool (Crypto era)) (PoolParams era) → Coin
maxPool ∷ PParams era → Coin → Rational → Rational → Coin

Documentation

newtype Stake era Source #

Type of stake as map from hash key to coins associated.

Constructors

Stake
Fields unStake ∷ Map (Credential 'Staking era) Coin

Instances

Instances details

Eq (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods (==) ∷ Stake era → Stake era → Bool # (/=) ∷ Stake era → Stake era → Bool #
Ord (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods compare ∷ Stake era → Stake era → Ordering # (<) ∷ Stake era → Stake era → Bool # (<=) ∷ Stake era → Stake era → Bool # (>) ∷ Stake era → Stake era → Bool # (>=) ∷ Stake era → Stake era → Bool # max ∷ Stake era → Stake era → Stake era # min ∷ Stake era → Stake era → Stake era #
Show (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods showsPrec ∷ Int → Stake era → ShowS # show ∷ Stake era → String # showList ∷ [Stake era] → ShowS #
NFData (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods rnf ∷ Stake era → () #
(Era era, AnnotatedData (Script era)) ⇒ ToCBOR (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods toCBOR ∷ Stake era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Stake era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Stake era] → Size Source #
(Era era, AnnotatedData (Script era)) ⇒ FromCBOR (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods fromCBOR ∷ Decoder s (Stake era) Source # label ∷ Proxy (Stake era) → Text Source #
NoThunks (Stake era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods noThunks ∷ Context → Stake era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → Stake era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (Stake era) → String

newtype BlocksMade era Source #

Blocks made

Constructors

BlocksMade
Fields unBlocksMade ∷ Map (KeyHash 'StakePool (Crypto era)) Natural

Instances

Instances details

Eq (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods (==) ∷ BlocksMade era → BlocksMade era → Bool # (/=) ∷ BlocksMade era → BlocksMade era → Bool #
Show (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods showsPrec ∷ Int → BlocksMade era → ShowS # show ∷ BlocksMade era → String # showList ∷ [BlocksMade era] → ShowS #
Generic (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Associated Types type Rep (BlocksMade era) ∷ Type → Type # Methods from ∷ BlocksMade era → Rep (BlocksMade era) x # to ∷ Rep (BlocksMade era) x → BlocksMade era #
NFData (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods rnf ∷ BlocksMade era → () #
Era era ⇒ ToCBOR (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods toCBOR ∷ BlocksMade era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (BlocksMade era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [BlocksMade era] → Size Source #
Era era ⇒ FromCBOR (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods fromCBOR ∷ Decoder s (BlocksMade era) Source # label ∷ Proxy (BlocksMade era) → Text Source #
NoThunks (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods noThunks ∷ Context → BlocksMade era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → BlocksMade era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (BlocksMade era) → String
type Rep (BlocksMade era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary type Rep (BlocksMade era) = D1 ('MetaData "BlocksMade" "Shelley.Spec.Ledger.EpochBoundary" "shelley-spec-ledger-0.1.0.0-inplace" 'True) (C1 ('MetaCons "BlocksMade" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlocksMade") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map (KeyHash 'StakePool (Crypto era)) Natural))))

data SnapShot era Source #

Snapshot of the stake distribution.

Constructors

SnapShot
Fields _stake ∷ !(Stake era) _delegations ∷ !(Map (Credential 'Staking era) (KeyHash 'StakePool (Crypto era))) _poolParams ∷ !(Map (KeyHash 'StakePool (Crypto era)) (PoolParams era))

Instances

Instances details

Eq (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods (==) ∷ SnapShot era → SnapShot era → Bool # (/=) ∷ SnapShot era → SnapShot era → Bool #
Show (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods showsPrec ∷ Int → SnapShot era → ShowS # show ∷ SnapShot era → String # showList ∷ [SnapShot era] → ShowS #
Generic (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Associated Types type Rep (SnapShot era) ∷ Type → Type # Methods from ∷ SnapShot era → Rep (SnapShot era) x # to ∷ Rep (SnapShot era) x → SnapShot era #
NFData (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods rnf ∷ SnapShot era → () #
(Era era, AnnotatedData (Script era)) ⇒ ToCBOR (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods toCBOR ∷ SnapShot era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (SnapShot era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SnapShot era] → Size Source #
(Era era, AnnotatedData (Script era)) ⇒ FromCBOR (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods fromCBOR ∷ Decoder s (SnapShot era) Source # label ∷ Proxy (SnapShot era) → Text Source #
NoThunks (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods noThunks ∷ Context → SnapShot era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → SnapShot era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (SnapShot era) → String
type Rep (SnapShot era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary type Rep (SnapShot era) = D1 ('MetaData "SnapShot" "Shelley.Spec.Ledger.EpochBoundary" "shelley-spec-ledger-0.1.0.0-inplace" 'False) (C1 ('MetaCons "SnapShot" 'PrefixI 'True) (S1 ('MetaSel ('Just "_stake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Stake era)) :: (S1 ('MetaSel ('Just "_delegations") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking era) (KeyHash 'StakePool (Crypto era)))) :: S1 ('MetaSel ('Just "_poolParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool (Crypto era)) (PoolParams era))))))

data SnapShots era Source #

Snapshots of the stake distribution.

Constructors

SnapShots
Fields _pstakeMark ∷ !(SnapShot era) _pstakeSet ∷ !(SnapShot era) _pstakeGo ∷ !(SnapShot era) _feeSS ∷ !Coin

Instances

Instances details

Eq (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods (==) ∷ SnapShots era → SnapShots era → Bool # (/=) ∷ SnapShots era → SnapShots era → Bool #
Show (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods showsPrec ∷ Int → SnapShots era → ShowS # show ∷ SnapShots era → String # showList ∷ [SnapShots era] → ShowS #
Generic (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Associated Types type Rep (SnapShots era) ∷ Type → Type # Methods from ∷ SnapShots era → Rep (SnapShots era) x # to ∷ Rep (SnapShots era) x → SnapShots era #
NFData (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods rnf ∷ SnapShots era → () #
(Era era, AnnotatedData (Script era)) ⇒ ToCBOR (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods toCBOR ∷ SnapShots era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (SnapShots era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SnapShots era] → Size Source #
(Era era, AnnotatedData (Script era)) ⇒ FromCBOR (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods fromCBOR ∷ Decoder s (SnapShots era) Source # label ∷ Proxy (SnapShots era) → Text Source #
NoThunks (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary Methods noThunks ∷ Context → SnapShots era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → SnapShots era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (SnapShots era) → String
type Rep (SnapShots era) Source #
Instance details Defined in Shelley.Spec.Ledger.EpochBoundary type Rep (SnapShots era) = D1 ('MetaData "SnapShots" "Shelley.Spec.Ledger.EpochBoundary" "shelley-spec-ledger-0.1.0.0-inplace" 'False) (C1 ('MetaCons "SnapShots" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_pstakeMark") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SnapShot era)) :: S1 ('MetaSel ('Just "_pstakeSet") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SnapShot era))) :: (S1 ('MetaSel ('Just "_pstakeGo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SnapShot era)) :*: S1 ('MetaSel ('Just "_feeSS") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin))))

emptySnapShot ∷ SnapShot era Source #

emptySnapShots ∷ SnapShots era Source #

aggregateUtxoCoinByCredential ∷ ∀ era. ShelleyBased era ⇒ Map Ptr (Credential 'Staking era) → UTxO era → Map (Credential 'Staking era) Coin → Map (Credential 'Staking era) Coin Source #

Sum up all the Coin for each staking Credential

poolStake ∷ KeyHash 'StakePool (Crypto era) → Map (Credential 'Staking era) (KeyHash 'StakePool (Crypto era)) → Stake era → Stake era Source #

Get stake of one pool

obligation ∷ PParams era → Map (Credential 'Staking era) Coin → Map (KeyHash 'StakePool (Crypto era)) (PoolParams era) → Coin Source #

Calculate total possible refunds.

maxPool ∷ PParams era → Coin → Rational → Rational → Coin Source #

Calculate maximal pool reward