Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.PoolRank

Synopsis

desirability :: ( NonNegativeInterval , Natural ) -> Coin -> PoolParams c -> PerformanceEstimate -> Coin -> Double
newtype PerformanceEstimate = PerformanceEstimate {
- unPerformanceEstimate :: Double
}
data NonMyopic crypto = NonMyopic {
- likelihoodsNM :: !( Map ( KeyHash ' StakePool crypto) Likelihood )
- rewardPotNM :: ! Coin
}
getTopRankedPools :: ( HasField "_a0" pp NonNegativeInterval , HasField "_nOpt" pp Natural ) => Coin -> Coin -> pp -> Map ( KeyHash ' StakePool crypto) ( PoolParams crypto) -> Map ( KeyHash ' StakePool crypto) PerformanceEstimate -> Set ( KeyHash ' StakePool crypto)
getTopRankedPoolsVMap :: ( HasField "_a0" pp NonNegativeInterval , HasField "_nOpt" pp Natural ) => Coin -> Coin -> pp -> VMap VB VB ( KeyHash ' StakePool crypto) ( PoolParams crypto) -> Map ( KeyHash ' StakePool crypto) PerformanceEstimate -> Set ( KeyHash ' StakePool crypto)
nonMyopicStake :: HasField "_nOpt" pp Natural => pp -> StakeShare -> StakeShare -> StakeShare -> KeyHash ' StakePool c -> Set ( KeyHash ' StakePool c) -> StakeShare
nonMyopicMemberRew :: ( HasField "_a0" pp NonNegativeInterval , HasField "_nOpt" pp Natural ) => pp -> Coin -> PoolParams c -> StakeShare -> StakeShare -> StakeShare -> Set ( KeyHash ' StakePool c) -> 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 , Natural ) -> Coin -> PoolParams c -> 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

Eq PerformanceEstimate Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (==) :: PerformanceEstimate -> PerformanceEstimate -> Bool Source # (/=) :: PerformanceEstimate -> PerformanceEstimate -> Bool Source #
Show PerformanceEstimate Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods showsPrec :: Int -> PerformanceEstimate -> ShowS Source # show :: PerformanceEstimate -> String Source # showList :: [ PerformanceEstimate ] -> ShowS Source #
Generic PerformanceEstimate Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Associated Types type Rep PerformanceEstimate :: Type -> Type Source # Methods from :: PerformanceEstimate -> Rep PerformanceEstimate x Source # to :: Rep PerformanceEstimate x -> PerformanceEstimate Source #
ToCBOR PerformanceEstimate Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods toCBOR :: PerformanceEstimate -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy PerformanceEstimate -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ PerformanceEstimate ] -> Size Source #
FromCBOR PerformanceEstimate Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods fromCBOR :: Decoder s PerformanceEstimate Source # label :: Proxy PerformanceEstimate -> Text Source #
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-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' True ) ( C1 (' MetaCons "PerformanceEstimate" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unPerformanceEstimate") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Double )))

data NonMyopic crypto Source #

Constructors

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

Instances

Instances details

Eq ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (==) :: NonMyopic crypto -> NonMyopic crypto -> Bool Source # (/=) :: NonMyopic crypto -> NonMyopic crypto -> Bool Source #
Show ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods showsPrec :: Int -> NonMyopic crypto -> ShowS Source # show :: NonMyopic crypto -> String Source # showList :: [ NonMyopic crypto] -> ShowS Source #
Generic ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Associated Types type Rep ( NonMyopic crypto) :: Type -> Type Source # Methods from :: NonMyopic crypto -> Rep ( NonMyopic crypto) x Source # to :: Rep ( NonMyopic crypto) x -> NonMyopic crypto Source #
NFData ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods rnf :: NonMyopic crypto -> () Source #
Crypto crypto => ToCBOR ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods toCBOR :: NonMyopic crypto -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( NonMyopic crypto) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ NonMyopic crypto] -> Size Source #
Crypto crypto => FromSharedCBOR ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Associated Types type Share ( NonMyopic crypto) Source # Methods getShare :: NonMyopic crypto -> Share ( NonMyopic crypto) Source # fromSharedCBOR :: Share ( NonMyopic crypto) -> Decoder s ( NonMyopic crypto) Source # fromSharedPlusCBOR :: StateT ( Share ( NonMyopic crypto)) ( Decoder s) ( NonMyopic crypto) Source #
Default ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods def :: NonMyopic crypto Source #
NoThunks ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods noThunks :: Context -> NonMyopic crypto -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> NonMyopic crypto -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( NonMyopic crypto) -> String Source #
type Rep ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Rep ( NonMyopic crypto) = D1 (' MetaData "NonMyopic" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' False ) ( C1 (' MetaCons "NonMyopic" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "likelihoodsNM") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( KeyHash ' StakePool crypto) Likelihood )) :*: S1 (' MetaSel (' Just "rewardPotNM") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Coin )))
type Share ( NonMyopic crypto) Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Share ( NonMyopic crypto) = Interns ( KeyHash ' StakePool crypto)

getTopRankedPools :: ( HasField "_a0" pp NonNegativeInterval , HasField "_nOpt" pp Natural ) => Coin -> Coin -> pp -> Map ( KeyHash ' StakePool crypto) ( PoolParams crypto) -> Map ( KeyHash ' StakePool crypto) PerformanceEstimate -> Set ( KeyHash ' StakePool crypto) Source #

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

getTopRankedPoolsVMap :: ( HasField "_a0" pp NonNegativeInterval , HasField "_nOpt" pp Natural ) => Coin -> Coin -> pp -> VMap VB VB ( KeyHash ' StakePool crypto) ( PoolParams crypto) -> Map ( KeyHash ' StakePool crypto) PerformanceEstimate -> Set ( KeyHash ' StakePool crypto) Source #

nonMyopicStake :: HasField "_nOpt" pp Natural => pp -> StakeShare -> StakeShare -> StakeShare -> KeyHash ' StakePool c -> Set ( KeyHash ' StakePool c) -> 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 :: ( HasField "_a0" pp NonNegativeInterval , HasField "_nOpt" pp Natural ) => pp -> Coin -> PoolParams c -> StakeShare -> StakeShare -> StakeShare -> Set ( KeyHash ' StakePool c) -> 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

Eq Histogram Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (==) :: Histogram -> Histogram -> Bool Source # (/=) :: Histogram -> Histogram -> Bool Source #
Show Histogram Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods showsPrec :: Int -> Histogram -> ShowS Source # show :: Histogram -> String Source # showList :: [ Histogram ] -> ShowS Source #
Generic Histogram Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Associated Types type Rep Histogram :: Type -> Type Source # Methods from :: Histogram -> Rep Histogram x Source # to :: Rep Histogram x -> Histogram Source #
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-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' 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

Eq LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (==) :: LogWeight -> LogWeight -> Bool Source # (/=) :: LogWeight -> LogWeight -> Bool Source #
Num LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (+) :: LogWeight -> LogWeight -> LogWeight Source # (-) :: LogWeight -> LogWeight -> LogWeight Source # (*) :: LogWeight -> LogWeight -> LogWeight Source # negate :: LogWeight -> LogWeight Source # abs :: LogWeight -> LogWeight Source # signum :: LogWeight -> LogWeight Source # fromInteger :: Integer -> LogWeight Source #
Ord LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods compare :: LogWeight -> LogWeight -> Ordering Source # (<) :: LogWeight -> LogWeight -> Bool Source # (<=) :: LogWeight -> LogWeight -> Bool Source # (>) :: LogWeight -> LogWeight -> Bool Source # (>=) :: LogWeight -> LogWeight -> Bool Source # max :: LogWeight -> LogWeight -> LogWeight Source # min :: LogWeight -> LogWeight -> LogWeight Source #
Show LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods showsPrec :: Int -> LogWeight -> ShowS Source # show :: LogWeight -> String Source # showList :: [ LogWeight ] -> ShowS Source #
Generic LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Associated Types type Rep LogWeight :: Type -> Type Source # Methods from :: LogWeight -> Rep LogWeight x Source # to :: Rep LogWeight x -> LogWeight Source #
NFData LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods rnf :: LogWeight -> () Source #
ToCBOR LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods toCBOR :: LogWeight -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy LogWeight -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ LogWeight ] -> Size Source #
FromCBOR LogWeight Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods fromCBOR :: Decoder s LogWeight Source # label :: Proxy LogWeight -> Text Source #
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-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' 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

Eq Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (==) :: Likelihood -> Likelihood -> Bool Source # (/=) :: Likelihood -> Likelihood -> Bool Source #
Ord Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods compare :: Likelihood -> Likelihood -> Ordering Source # (<) :: Likelihood -> Likelihood -> Bool Source # (<=) :: Likelihood -> Likelihood -> Bool Source # (>) :: Likelihood -> Likelihood -> Bool Source # (>=) :: Likelihood -> Likelihood -> Bool Source # max :: Likelihood -> Likelihood -> Likelihood Source # min :: Likelihood -> Likelihood -> Likelihood Source #
Show Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods showsPrec :: Int -> Likelihood -> ShowS Source # show :: Likelihood -> String Source # showList :: [ Likelihood ] -> ShowS Source #
Generic Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Associated Types type Rep Likelihood :: Type -> Type Source # Methods from :: Likelihood -> Rep Likelihood x Source # to :: Rep Likelihood x -> Likelihood Source #
Semigroup Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods (<>) :: Likelihood -> Likelihood -> Likelihood Source # sconcat :: NonEmpty Likelihood -> Likelihood Source # stimes :: Integral b => b -> Likelihood -> Likelihood Source #
Monoid Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods mempty :: Likelihood Source # mappend :: Likelihood -> Likelihood -> Likelihood Source # mconcat :: [ Likelihood ] -> Likelihood Source #
NFData Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods rnf :: Likelihood -> () Source #
ToCBOR Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods toCBOR :: Likelihood -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Likelihood -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Likelihood ] -> Size Source #
FromCBOR Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods fromCBOR :: Decoder s Likelihood Source # label :: Proxy Likelihood -> Text Source #
NoThunks Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank Methods noThunks :: Context -> Likelihood -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Likelihood -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Likelihood -> String Source #
type Rep Likelihood Source #
Instance details Defined in Cardano.Ledger.Shelley.PoolRank type Rep Likelihood = D1 (' MetaData "Likelihood" "Cardano.Ledger.Shelley.PoolRank" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' True ) ( C1 (' MetaCons "Likelihood" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "unLikelihood") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( StrictSeq LogWeight ))))

leaderProbability :: ActiveSlotCoeff -> Rational -> UnitInterval -> Double Source #