cardano-ledger-core-1.19.0.0: Core components of Cardano ledgers from the Shelley release on.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Ledger.PoolParams

Description

Deprecated: Use State instead.

This module is deprecated and will be removed in a future version. Please import these types from Cardano.Ledger.State instead.

The contents of this module have been moved to Cardano.Ledger.State.StakePool to provide better separation between pool registration parameters and pool state management. All types are now re-exported through Cardano.Ledger.State for convenient access.

Synopsis

Documentation

data StakePoolParams Source #

A stake pool.

Constructors

StakePoolParams 

Fields

Bundled Patterns

pattern PoolParams ∷ KeyHash 'StakePool → VRFVerKeyHash 'StakePoolVRF → Coin → Coin → UnitInterval → RewardAccount → Set (KeyHash 'Staking) → StrictSeq StakePoolRelay → StrictMaybe PoolMetadata → PoolParams

Deprecated: In favor of StakePoolParams

Instances

Instances details
FromJSON StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

parseJSON ∷ Value → Parser StakePoolParams Source #

parseJSONList ∷ Value → Parser [StakePoolParams] Source #

omittedField ∷ Maybe StakePoolParams Source #

ToJSON StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

toJSON ∷ StakePoolParams → Value Source #

toEncoding ∷ StakePoolParams → Encoding Source #

toJSONList ∷ [StakePoolParams] → Value Source #

toEncodingList ∷ [StakePoolParams] → Encoding Source #

omitField ∷ StakePoolParams → Bool Source #

Generic StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Associated Types

type Rep StakePoolParams ∷ Type → Type #

Methods

from ∷ StakePoolParams → Rep StakePoolParams x #

to ∷ Rep StakePoolParams x → StakePoolParams #

Show StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

showsPrec ∷ Int → StakePoolParams → ShowS #

show ∷ StakePoolParams → String #

showList ∷ [StakePoolParams] → ShowS #

DecCBOR StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

decCBOR ∷ Decoder s StakePoolParams Source #

dropCBOR ∷ Proxy StakePoolParams → Decoder s () Source #

label ∷ Proxy StakePoolParams → Text Source #

EncCBOR StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

encCBOR ∷ StakePoolParams → Encoding Source #

DecCBORGroup StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

decCBORGroup ∷ Decoder s StakePoolParams Source #

EncCBORGroup StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

encCBORGroup ∷ StakePoolParams → Encoding Source #

listLen ∷ StakePoolParams → Word Source #

listLenBound ∷ Proxy StakePoolParams → Word Source #

Default StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

def ∷ StakePoolParams Source #

NFData StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

rnf ∷ StakePoolParams → () #

Eq StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

(==) ∷ StakePoolParams → StakePoolParams → Bool #

(/=) ∷ StakePoolParams → StakePoolParams → Bool #

Ord StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

compare ∷ StakePoolParams → StakePoolParams → Ordering #

(<) ∷ StakePoolParams → StakePoolParams → Bool #

(<=) ∷ StakePoolParams → StakePoolParams → Bool #

(>) ∷ StakePoolParams → StakePoolParams → Bool #

(>=) ∷ StakePoolParams → StakePoolParams → Bool #

max ∷ StakePoolParams → StakePoolParams → StakePoolParams #

min ∷ StakePoolParams → StakePoolParams → StakePoolParams #

NoThunks StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

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

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

showTypeOf ∷ Proxy StakePoolParams → String Source #

type Rep StakePoolParams Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

type Rep StakePoolParams = D1 ('MetaData "StakePoolParams" "Cardano.Ledger.State.StakePool" "cardano-ledger-core-1.19.0.0-inplace" 'False) (C1 ('MetaCons "StakePoolParams" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sppId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool)) :*: S1 ('MetaSel ('Just "sppVrf") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VRFVerKeyHash 'StakePoolVRF))) :*: (S1 ('MetaSel ('Just "sppPledge") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin) :*: S1 ('MetaSel ('Just "sppCost") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin))) :*: ((S1 ('MetaSel ('Just "sppMargin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UnitInterval) :*: S1 ('MetaSel ('Just "sppRewardAccount") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RewardAccount)) :*: (S1 ('MetaSel ('Just "sppOwners") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set (KeyHash 'Staking))) :*: (S1 ('MetaSel ('Just "sppRelays") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictSeq StakePoolRelay)) :*: S1 ('MetaSel ('Just "sppMetadata") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe PoolMetadata)))))))

data PoolMetadata Source #

Constructors

PoolMetadata 

Fields

Instances

Instances details
FromJSON PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

parseJSON ∷ Value → Parser PoolMetadata Source #

parseJSONList ∷ Value → Parser [PoolMetadata] Source #

omittedField ∷ Maybe PoolMetadata Source #

ToJSON PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

toJSON ∷ PoolMetadata → Value Source #

toEncoding ∷ PoolMetadata → Encoding Source #

toJSONList ∷ [PoolMetadata] → Value Source #

toEncodingList ∷ [PoolMetadata] → Encoding Source #

omitField ∷ PoolMetadata → Bool Source #

Generic PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Associated Types

type Rep PoolMetadata ∷ Type → Type #

Methods

from ∷ PoolMetadata → Rep PoolMetadata x #

to ∷ Rep PoolMetadata x → PoolMetadata #

Show PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

showsPrec ∷ Int → PoolMetadata → ShowS #

show ∷ PoolMetadata → String #

showList ∷ [PoolMetadata] → ShowS #

DecCBOR PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

decCBOR ∷ Decoder s PoolMetadata Source #

dropCBOR ∷ Proxy PoolMetadata → Decoder s () Source #

label ∷ Proxy PoolMetadata → Text Source #

EncCBOR PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

encCBOR ∷ PoolMetadata → Encoding Source #

NFData PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

rnf ∷ PoolMetadata → () #

Eq PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

(==) ∷ PoolMetadata → PoolMetadata → Bool #

(/=) ∷ PoolMetadata → PoolMetadata → Bool #

Ord PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

compare ∷ PoolMetadata → PoolMetadata → Ordering #

(<) ∷ PoolMetadata → PoolMetadata → Bool #

(<=) ∷ PoolMetadata → PoolMetadata → Bool #

(>) ∷ PoolMetadata → PoolMetadata → Bool #

(>=) ∷ PoolMetadata → PoolMetadata → Bool #

max ∷ PoolMetadata → PoolMetadata → PoolMetadata #

min ∷ PoolMetadata → PoolMetadata → PoolMetadata #

NoThunks PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

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

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

showTypeOf ∷ Proxy PoolMetadata → String Source #

type Rep PoolMetadata Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

type Rep PoolMetadata = D1 ('MetaData "PoolMetadata" "Cardano.Ledger.State.StakePool" "cardano-ledger-core-1.19.0.0-inplace" 'False) (C1 ('MetaCons "PoolMetadata" 'PrefixI 'True) (S1 ('MetaSel ('Just "pmUrl") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Url) :*: S1 ('MetaSel ('Just "pmHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByteString)))

data StakePoolRelay Source #

Constructors

SingleHostAddr !(StrictMaybe Port) !(StrictMaybe IPv4) !(StrictMaybe IPv6)

One or both of IPv4 & IPv6

SingleHostName !(StrictMaybe Port) !DnsName

An A or AAAA DNS record

MultiHostName !DnsName

A SRV DNS record

Instances

Instances details
FromJSON StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

parseJSON ∷ Value → Parser StakePoolRelay Source #

parseJSONList ∷ Value → Parser [StakePoolRelay] Source #

omittedField ∷ Maybe StakePoolRelay Source #

ToJSON StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

toJSON ∷ StakePoolRelay → Value Source #

toEncoding ∷ StakePoolRelay → Encoding Source #

toJSONList ∷ [StakePoolRelay] → Value Source #

toEncodingList ∷ [StakePoolRelay] → Encoding Source #

omitField ∷ StakePoolRelay → Bool Source #

Generic StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Associated Types

type Rep StakePoolRelay ∷ Type → Type #

Methods

from ∷ StakePoolRelay → Rep StakePoolRelay x #

to ∷ Rep StakePoolRelay x → StakePoolRelay #

Show StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

showsPrec ∷ Int → StakePoolRelay → ShowS #

show ∷ StakePoolRelay → String #

showList ∷ [StakePoolRelay] → ShowS #

DecCBOR StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

decCBOR ∷ Decoder s StakePoolRelay Source #

dropCBOR ∷ Proxy StakePoolRelay → Decoder s () Source #

label ∷ Proxy StakePoolRelay → Text Source #

EncCBOR StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

encCBOR ∷ StakePoolRelay → Encoding Source #

NFData StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

rnf ∷ StakePoolRelay → () #

Eq StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

(==) ∷ StakePoolRelay → StakePoolRelay → Bool #

(/=) ∷ StakePoolRelay → StakePoolRelay → Bool #

Ord StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

compare ∷ StakePoolRelay → StakePoolRelay → Ordering #

(<) ∷ StakePoolRelay → StakePoolRelay → Bool #

(<=) ∷ StakePoolRelay → StakePoolRelay → Bool #

(>) ∷ StakePoolRelay → StakePoolRelay → Bool #

(>=) ∷ StakePoolRelay → StakePoolRelay → Bool #

max ∷ StakePoolRelay → StakePoolRelay → StakePoolRelay #

min ∷ StakePoolRelay → StakePoolRelay → StakePoolRelay #

NoThunks StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

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

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

showTypeOf ∷ Proxy StakePoolRelay → String Source #

type Rep StakePoolRelay Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

type Rep StakePoolRelay = D1 ('MetaData "StakePoolRelay" "Cardano.Ledger.State.StakePool" "cardano-ledger-core-1.19.0.0-inplace" 'False) (C1 ('MetaCons "SingleHostAddr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe Port)) :*: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe IPv4)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe IPv6)))) :+: (C1 ('MetaCons "SingleHostName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe Port)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DnsName)) :+: C1 ('MetaCons "MultiHostName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 DnsName))))

data SizeOfPoolRelays Source #

The size of the sppRelays Set. Only used to compute size of encoded StakePoolParams.

Constructors

SizeOfPoolRelays 

Instances

Instances details
EncCBOR SizeOfPoolRelays Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

encCBOR ∷ SizeOfPoolRelays → Encoding Source #

data SizeOfPoolOwners Source #

The size of the sppOwners Set. Only used to compute size of encoded StakePoolParams.

Constructors

SizeOfPoolOwners 

Instances

Instances details
EncCBOR SizeOfPoolOwners Source # 
Instance details

Defined in Cardano.Ledger.State.StakePool

Methods

encCBOR ∷ SizeOfPoolOwners → Encoding Source #