Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.PoolRank

Synopsis

desirability ∷ NonNegativeInterval → NonZero Word16 → Coin → StakePoolParams → PerformanceEstimate → Coin → Double
newtype PerformanceEstimate = PerformanceEstimate {
- unPerformanceEstimate ∷ Double
}
data NonMyopic = NonMyopic {
- likelihoodsNM ∷ !(Map (KeyHash 'StakePool) Likelihood)
- rewardPotNM ∷ !Coin
}
getTopRankedPools ∷ EraPParams era ⇒ Coin → Coin → PParams era → Map (KeyHash 'StakePool) StakePoolParams → Map (KeyHash 'StakePool) PerformanceEstimate → Set (KeyHash 'StakePool)
getTopRankedPoolsVMap ∷ EraPParams era ⇒ Coin → Coin → PParams era → VMap VB VB (KeyHash 'StakePool) StakePoolParams → Map (KeyHash 'StakePool) PerformanceEstimate → Set (KeyHash 'StakePool)
nonMyopicStake ∷ EraPParams era ⇒ PParams era → StakeShare → StakeShare → StakeShare → KeyHash 'StakePool → Set (KeyHash 'StakePool) → StakeShare
nonMyopicMemberRew ∷ EraPParams era ⇒ PParams era → Coin → StakePoolParams → StakeShare → StakeShare → StakeShare → Set (KeyHash 'StakePool) → PerformanceEstimate → Coin
percentile' ∷ Likelihood → PerformanceEstimate
newtype Histogram = Histogram {
- unHistogram ∷ StrictSeq LogWeight
}
newtype LogWeight = LogWeight {
- unLogWeight ∷ Float
}
likelihood ∷ Natural → Double → EpochSize → Likelihood
applyDecay ∷ Float → Likelihood → Likelihood
newtype Likelihood = Likelihood {
- unLikelihood ∷ StrictSeq LogWeight
}
leaderProbability ∷ ActiveSlotCoeff → Rational → UnitInterval → Double

Documentation

desirability ∷ NonNegativeInterval → NonZero Word16 → Coin → StakePoolParams → PerformanceEstimate → Coin → Double Source #

Desirability calculation for non-myopic utility, corresponding to f^~ in section 5.6.1 of "Design Specification for Delegation and Incentives in Cardano"

newtype PerformanceEstimate Source #

This is a estimate of the proportion of allowed blocks a pool will make in the future. It is used for ranking pools in delegation.

Constructors

PerformanceEstimate
Fields unPerformanceEstimate ∷ Double

Instances

Instances details

DecCBOR PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

decCBOR ∷ Decoder s PerformanceEstimate Source #

dropCBOR ∷ Proxy PerformanceEstimate → Decoder s () Source #

label ∷ Proxy PerformanceEstimate → Text Source #

EncCBOR PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

encCBOR ∷ PerformanceEstimate → Encoding Source #

Generic PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Associated Types

type Rep PerformanceEstimate
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Rep PerformanceEstimate = D1 ('MetaData "PerformanceEstimate" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "PerformanceEstimate" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPerformanceEstimate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

Methods

from ∷ PerformanceEstimate → Rep PerformanceEstimate x #

to ∷ Rep PerformanceEstimate x → PerformanceEstimate #

Show PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

showsPrec ∷ Int → PerformanceEstimate → ShowS #

show ∷ PerformanceEstimate → String #

showList ∷ [PerformanceEstimate] → ShowS #

Eq PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

(==) ∷ PerformanceEstimate → PerformanceEstimate → Bool #

(/=) ∷ PerformanceEstimate → PerformanceEstimate → Bool #

NoThunks PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

noThunks ∷ Context → PerformanceEstimate → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PerformanceEstimate → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PerformanceEstimate → String Source #

type Rep PerformanceEstimate Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

type Rep PerformanceEstimate = D1 ('MetaData "PerformanceEstimate" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "PerformanceEstimate" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPerformanceEstimate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))

data NonMyopic Source #

Constructors

NonMyopic
Fields likelihoodsNM ∷ !(Map (KeyHash 'StakePool) Likelihood) rewardPotNM ∷ !Coin

Instances

Instances details

ToJSON NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

toJSON ∷ NonMyopic → Value Source #

toEncoding ∷ NonMyopic → Encoding Source #

toJSONList ∷ [NonMyopic] → Value Source #

toEncodingList ∷ [NonMyopic] → Encoding Source #

omitField ∷ NonMyopic → Bool Source #

DecShareCBOR NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Associated Types

type Share NonMyopic
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Share NonMyopic = Interns (KeyHash 'StakePool)

Methods

getShare ∷ NonMyopic → Share NonMyopic Source #

decShareCBOR ∷ Share NonMyopic → Decoder s NonMyopic Source #

decSharePlusCBOR ∷ StateT (Share NonMyopic) (Decoder s) NonMyopic Source #

EncCBOR NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

encCBOR ∷ NonMyopic → Encoding Source #

ToKeyValuePairs NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

toKeyValuePairs ∷ KeyValue e kv ⇒ NonMyopic → [kv] Source #

Default NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

def ∷ NonMyopic Source #

NFData NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

rnf ∷ NonMyopic → () #

Generic NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Associated Types

type Rep NonMyopic

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

type Rep NonMyopic = D1 ('MetaData "NonMyopic" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'False) (C1 ('MetaCons "NonMyopic" 'PrefixI 'True) (S1 ('MetaSel ('Just "likelihoodsNM") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) Likelihood)) :*: S1 ('MetaSel ('Just "rewardPotNM") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))

Methods

from ∷ NonMyopic → Rep NonMyopic x #

to ∷ Rep NonMyopic x → NonMyopic #

Show NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

showsPrec ∷ Int → NonMyopic → ShowS #

show ∷ NonMyopic → String #

showList ∷ [NonMyopic] → ShowS #

Eq NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

(==) ∷ NonMyopic → NonMyopic → Bool #

(/=) ∷ NonMyopic → NonMyopic → Bool #

NoThunks NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

noThunks ∷ Context → NonMyopic → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → NonMyopic → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy NonMyopic → String Source #

type Share NonMyopic Source #

type Rep NonMyopic Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

type Rep NonMyopic = D1 ('MetaData "NonMyopic" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'False) (C1 ('MetaCons "NonMyopic" 'PrefixI 'True) (S1 ('MetaSel ('Just "likelihoodsNM") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'StakePool) Likelihood)) :*: S1 ('MetaSel ('Just "rewardPotNM") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))

getTopRankedPools ∷ EraPParams era ⇒ Coin → Coin → PParams era → Map (KeyHash 'StakePool) StakePoolParams → Map (KeyHash 'StakePool) PerformanceEstimate → Set (KeyHash 'StakePool) Source #

Computes the top ranked stake pools corresponding to section 5.6.1 of "Design Specification for Delegation and Incentives in Cardano"

getTopRankedPoolsVMap ∷ EraPParams era ⇒ Coin → Coin → PParams era → VMap VB VB (KeyHash 'StakePool) StakePoolParams → Map (KeyHash 'StakePool) PerformanceEstimate → Set (KeyHash 'StakePool) Source #

nonMyopicStake ∷ EraPParams era ⇒ PParams era → StakeShare → StakeShare → StakeShare → KeyHash 'StakePool → Set (KeyHash 'StakePool) → StakeShare Source #

Compute the Non-Myopic Pool Stake

This function implements non-myopic stake calculation in section 5.6.2 of "Design Specification for Delegation and Incentives in Cardano". Note that the protocol parameters are implicit in the design document. Additionally, instead of passing a rank r to compare with k, we pass the top k desirable pools and check for membership.

nonMyopicMemberRew ∷ EraPParams era ⇒ PParams era → Coin → StakePoolParams → StakeShare → StakeShare → StakeShare → Set (KeyHash 'StakePool) → PerformanceEstimate → Coin Source #

Compute the Non-Myopic Pool Member Reward

This function implements equation (3) in section 5.6.4 of "Design Specification for Delegation and Incentives in Cardano". Note that the protocol parameters and the reward pot are implicit in the design document. Additionally, instead of passing a rank r to compare with k, we pass the top k desirable pools and check for membership.

percentile' ∷ Likelihood → PerformanceEstimate Source #

newtype Histogram Source #

Constructors

Histogram
Fields unHistogram ∷ StrictSeq LogWeight

Instances

Instances details

Generic Histogram Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Associated Types

type Rep Histogram
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Rep Histogram = D1 ('MetaData "Histogram" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "Histogram" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHistogram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StrictSeq LogWeight))))

Methods

from ∷ Histogram → Rep Histogram x #

to ∷ Rep Histogram x → Histogram #

Show Histogram Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

showsPrec ∷ Int → Histogram → ShowS #

show ∷ Histogram → String #

showList ∷ [Histogram] → ShowS #

Eq Histogram Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

(==) ∷ Histogram → Histogram → Bool #

(/=) ∷ Histogram → Histogram → Bool #

type Rep Histogram Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

type Rep Histogram = D1 ('MetaData "Histogram" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "Histogram" 'PrefixI 'True) (S1 ('MetaSel ('Just "unHistogram") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StrictSeq LogWeight))))

newtype LogWeight Source #

Constructors

LogWeight
Fields unLogWeight ∷ Float

Instances

Instances details

FromJSON LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

parseJSON ∷ Value → Parser LogWeight Source #

parseJSONList ∷ Value → Parser [LogWeight] Source #

omittedField ∷ Maybe LogWeight Source #

ToJSON LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

toJSON ∷ LogWeight → Value Source #

toEncoding ∷ LogWeight → Encoding Source #

toJSONList ∷ [LogWeight] → Value Source #

toEncodingList ∷ [LogWeight] → Encoding Source #

omitField ∷ LogWeight → Bool Source #

DecCBOR LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

decCBOR ∷ Decoder s LogWeight Source #

dropCBOR ∷ Proxy LogWeight → Decoder s () Source #

label ∷ Proxy LogWeight → Text Source #

EncCBOR LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

encCBOR ∷ LogWeight → Encoding Source #

NFData LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

rnf ∷ LogWeight → () #

Generic LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Associated Types

type Rep LogWeight
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Rep LogWeight = D1 ('MetaData "LogWeight" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "LogWeight" 'PrefixI 'True) (S1 ('MetaSel ('Just "unLogWeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float)))

Methods

from ∷ LogWeight → Rep LogWeight x #

to ∷ Rep LogWeight x → LogWeight #

Num LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

(+) ∷ LogWeight → LogWeight → LogWeight #

(-) ∷ LogWeight → LogWeight → LogWeight #

(*) ∷ LogWeight → LogWeight → LogWeight #

negate ∷ LogWeight → LogWeight #

abs ∷ LogWeight → LogWeight #

signum ∷ LogWeight → LogWeight #

fromInteger ∷ Integer → LogWeight #

Show LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

showsPrec ∷ Int → LogWeight → ShowS #

show ∷ LogWeight → String #

showList ∷ [LogWeight] → ShowS #

Eq LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

(==) ∷ LogWeight → LogWeight → Bool #

(/=) ∷ LogWeight → LogWeight → Bool #

Ord LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

compare ∷ LogWeight → LogWeight → Ordering #

(<) ∷ LogWeight → LogWeight → Bool #

(<=) ∷ LogWeight → LogWeight → Bool #

(>) ∷ LogWeight → LogWeight → Bool #

(>=) ∷ LogWeight → LogWeight → Bool #

max ∷ LogWeight → LogWeight → LogWeight #

min ∷ LogWeight → LogWeight → LogWeight #

NoThunks LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

noThunks ∷ Context → LogWeight → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → LogWeight → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy LogWeight → String Source #

type Rep LogWeight Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

type Rep LogWeight = D1 ('MetaData "LogWeight" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "LogWeight" 'PrefixI 'True) (S1 ('MetaSel ('Just "unLogWeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float)))

likelihood ∷ Natural → Double → EpochSize → Likelihood Source #

applyDecay ∷ Float → Likelihood → Likelihood Source #

Decay previous likelihood

newtype Likelihood Source #

Constructors

Likelihood
Fields unLikelihood ∷ StrictSeq LogWeight

Instances

Instances details

ToJSON Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

toJSON ∷ Likelihood → Value Source #

toEncoding ∷ Likelihood → Encoding Source #

toJSONList ∷ [Likelihood] → Value Source #

toEncodingList ∷ [Likelihood] → Encoding Source #

omitField ∷ Likelihood → Bool Source #

DecCBOR Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

decCBOR ∷ Decoder s Likelihood Source #

dropCBOR ∷ Proxy Likelihood → Decoder s () Source #

label ∷ Proxy Likelihood → Text Source #

EncCBOR Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

encCBOR ∷ Likelihood → Encoding Source #

NFData Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

rnf ∷ Likelihood → () #

Monoid Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

mempty ∷ Likelihood #

mappend ∷ Likelihood → Likelihood → Likelihood #

mconcat ∷ [Likelihood] → Likelihood #

Semigroup Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Methods

(<>) ∷ Likelihood → Likelihood → Likelihood #

sconcat ∷ NonEmpty Likelihood → Likelihood #

stimes ∷ Integral b ⇒ b → Likelihood → Likelihood #

Generic Likelihood Source #

Instance details

Defined in Cardano.Ledger.Shelley.PoolRank

Associated Types

type Rep Likelihood
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Rep Likelihood = D1 ('MetaData "Likelihood" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "Likelihood" 'PrefixI 'True) (S1 ('MetaSel ('Just "unLikelihood") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (StrictSeq LogWeight))))