cardano-api:internal
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Query.Expr

Synopsis

Documentation

queryAccountState :: ConwayEraOnwards era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch AccountState)) Source #

queryChainBlockNo :: LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (WithOrigin BlockNo)) Source #

queryChainPoint :: LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError ChainPoint) Source #

queryConstitution :: ConwayEraOnwards era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Constitution (ShelleyLedgerEra era)))) Source #

queryCurrentEpochState :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (SerialisedCurrentEpochState era))) Source #

queryCurrentEra :: LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError AnyCardanoEra) Source #

queryDebugLedgerState :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (SerialisedDebugLedgerState era))) Source #

queryEpoch :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch EpochNo)) Source #

queryConstitutionHash :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (SafeHash (EraCrypto (ShelleyLedgerEra era)) AnchorData))) Source #

queryEraHistory :: LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError EraHistory) Source #

queryGenesisParameters :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (GenesisParameters ShelleyEra))) Source #

queryPoolDistribution :: BabbageEraOnwards era -> Maybe (Set PoolId) -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (SerialisedPoolDistribution era))) Source #

queryPoolState :: BabbageEraOnwards era -> Maybe (Set PoolId) -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (SerialisedPoolState era))) Source #

queryProtocolParameters :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (PParams (ShelleyLedgerEra era)))) Source #

queryProtocolParametersUpdate :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map (Hash GenesisKey) ProtocolParametersUpdate))) Source #

queryProtocolState :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (ProtocolState era))) Source #

queryStakeAddresses :: ShelleyBasedEra era -> Set StakeCredential -> NetworkId -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map StakeAddress Coin, Map StakeAddress PoolId))) Source #

queryStakeDelegDeposits :: BabbageEraOnwards era -> Set StakeCredential -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map StakeCredential Coin))) Source #

queryStakeDistribution :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map (Hash StakePoolKey) Rational))) Source #

queryStakePoolParameters :: ShelleyBasedEra era -> Set PoolId -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map PoolId StakePoolParameters))) Source #

queryStakePools :: ShelleyBasedEra era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Set PoolId))) Source #

queryStakeSnapshot :: BabbageEraOnwards era -> Maybe (Set PoolId) -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (SerialisedStakeSnapshots era))) Source #

querySystemStart :: LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError SystemStart) Source #

queryUtxo :: ShelleyBasedEra era -> QueryUTxOFilter -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (UTxO era))) Source #

data MemberStatus Source #

Constructors

Active 
Expired 
Unrecognized

This can happen when a hot credential for an unknown cold credential exists. Such Committee member will be either removed from the state at the next epoch boundary or enacted as a new member.

Instances

Instances details
ToJSON MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

toJSON :: MemberStatus -> Value #

toEncoding :: MemberStatus -> Encoding #

toJSONList :: [MemberStatus] -> Value #

toEncodingList :: [MemberStatus] -> Encoding #

omitField :: MemberStatus -> Bool #

Bounded MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

minBound :: MemberStatus Source #

maxBound :: MemberStatus Source #

Enum MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

succ :: MemberStatus -> MemberStatus Source #

pred :: MemberStatus -> MemberStatus Source #

toEnum :: Int -> MemberStatus Source #

fromEnum :: MemberStatus -> Int Source #

enumFrom :: MemberStatus -> [MemberStatus] Source #

enumFromThen :: MemberStatus -> MemberStatus -> [MemberStatus] Source #

enumFromTo :: MemberStatus -> MemberStatus -> [MemberStatus] Source #

enumFromThenTo :: MemberStatus -> MemberStatus -> MemberStatus -> [MemberStatus] Source #

Generic MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Associated Types

type Rep MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

type Rep MemberStatus = D1 ('MetaData "MemberStatus" "Cardano.Ledger.Api.State.Query.CommitteeMembersState" "cardano-ledger-api-1.9.3.0-2dcd161fdc7ab11e05f4e7b4164c4284b1179914224227289319c125175d88ac" 'False) (C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unrecognized" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: MemberStatus -> Rep MemberStatus x Source #

to :: Rep MemberStatus x -> MemberStatus Source #

Show MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

showsPrec :: Int -> MemberStatus -> ShowS Source #

show :: MemberStatus -> String Source #

showList :: [MemberStatus] -> ShowS Source #

DecCBOR MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

decCBOR :: Decoder s MemberStatus Source #

dropCBOR :: Proxy MemberStatus -> Decoder s () Source #

label :: Proxy MemberStatus -> Text Source #

EncCBOR MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

encCBOR :: MemberStatus -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy MemberStatus -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [MemberStatus] -> Size Source #

Eq MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

(==) :: MemberStatus -> MemberStatus -> Bool Source #

(/=) :: MemberStatus -> MemberStatus -> Bool Source #

Ord MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

compare :: MemberStatus -> MemberStatus -> Ordering Source #

(<) :: MemberStatus -> MemberStatus -> Bool Source #

(<=) :: MemberStatus -> MemberStatus -> Bool Source #

(>) :: MemberStatus -> MemberStatus -> Bool Source #

(>=) :: MemberStatus -> MemberStatus -> Bool Source #

max :: MemberStatus -> MemberStatus -> MemberStatus Source #

min :: MemberStatus -> MemberStatus -> MemberStatus Source #

type Rep MemberStatus 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

type Rep MemberStatus = D1 ('MetaData "MemberStatus" "Cardano.Ledger.Api.State.Query.CommitteeMembersState" "cardano-ledger-api-1.9.3.0-2dcd161fdc7ab11e05f4e7b4164c4284b1179914224227289319c125175d88ac" 'False) (C1 ('MetaCons "Active" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Expired" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Unrecognized" 'PrefixI 'False) (U1 :: Type -> Type)))

data CommitteeMembersState c Source #

Constructors

CommitteeMembersState 

Fields

Instances

Instances details
Crypto c => ToJSON (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

toJSON :: CommitteeMembersState c -> Value #

toEncoding :: CommitteeMembersState c -> Encoding #

toJSONList :: [CommitteeMembersState c] -> Value #

toEncodingList :: [CommitteeMembersState c] -> Encoding #

omitField :: CommitteeMembersState c -> Bool #

Generic (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Associated Types

type Rep (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

type Rep (CommitteeMembersState c) = D1 ('MetaData "CommitteeMembersState" "Cardano.Ledger.Api.State.Query.CommitteeMembersState" "cardano-ledger-api-1.9.3.0-2dcd161fdc7ab11e05f4e7b4164c4284b1179914224227289319c125175d88ac" 'False) (C1 ('MetaCons "CommitteeMembersState" 'PrefixI 'True) (S1 ('MetaSel ('Just "csCommittee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'ColdCommitteeRole c) (CommitteeMemberState c))) :*: (S1 ('MetaSel ('Just "csThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UnitInterval)) :*: S1 ('MetaSel ('Just "csEpochNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 EpochNo))))

Methods

from :: CommitteeMembersState c -> Rep (CommitteeMembersState c) x Source #

to :: Rep (CommitteeMembersState c) x -> CommitteeMembersState c Source #

Show (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

showsPrec :: Int -> CommitteeMembersState c -> ShowS Source #

show :: CommitteeMembersState c -> String Source #

showList :: [CommitteeMembersState c] -> ShowS Source #

Crypto c => DecCBOR (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

decCBOR :: Decoder s (CommitteeMembersState c) Source #

dropCBOR :: Proxy (CommitteeMembersState c) -> Decoder s () Source #

label :: Proxy (CommitteeMembersState c) -> Text Source #

Crypto c => EncCBOR (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

encCBOR :: CommitteeMembersState c -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy (CommitteeMembersState c) -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [CommitteeMembersState c] -> Size Source #

Eq (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

(==) :: CommitteeMembersState c -> CommitteeMembersState c -> Bool Source #

(/=) :: CommitteeMembersState c -> CommitteeMembersState c -> Bool Source #

Ord (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

Methods

compare :: CommitteeMembersState c -> CommitteeMembersState c -> Ordering Source #

(<) :: CommitteeMembersState c -> CommitteeMembersState c -> Bool Source #

(<=) :: CommitteeMembersState c -> CommitteeMembersState c -> Bool Source #

(>) :: CommitteeMembersState c -> CommitteeMembersState c -> Bool Source #

(>=) :: CommitteeMembersState c -> CommitteeMembersState c -> Bool Source #

max :: CommitteeMembersState c -> CommitteeMembersState c -> CommitteeMembersState c Source #

min :: CommitteeMembersState c -> CommitteeMembersState c -> CommitteeMembersState c Source #

type Rep (CommitteeMembersState c) 
Instance details

Defined in Cardano.Ledger.Api.State.Query.CommitteeMembersState

type Rep (CommitteeMembersState c) = D1 ('MetaData "CommitteeMembersState" "Cardano.Ledger.Api.State.Query.CommitteeMembersState" "cardano-ledger-api-1.9.3.0-2dcd161fdc7ab11e05f4e7b4164c4284b1179914224227289319c125175d88ac" 'False) (C1 ('MetaCons "CommitteeMembersState" 'PrefixI 'True) (S1 ('MetaSel ('Just "csCommittee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'ColdCommitteeRole c) (CommitteeMemberState c))) :*: (S1 ('MetaSel ('Just "csThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe UnitInterval)) :*: S1 ('MetaSel ('Just "csEpochNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 EpochNo))))

queryCommitteeMembersState :: ConwayEraOnwards era -> Set (Credential 'ColdCommitteeRole StandardCrypto) -> Set (Credential 'HotCommitteeRole StandardCrypto) -> Set MemberStatus -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (CommitteeMembersState StandardCrypto))) Source #

Returns info about committee members filtered by: cold credentials, hot credentials and statuses. If empty sets are passed as filters, then no filtering is done.

queryDRepStakeDistribution Source #

Arguments

:: ConwayEraOnwards era 
-> Set (DRep StandardCrypto)

An empty DRep set means that distributions for all DReps will be returned

-> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map (DRep StandardCrypto) Coin))) 

querySPOStakeDistribution Source #

Arguments

:: ConwayEraOnwards era 
-> Set (KeyHash 'StakePool StandardCrypto)

An empty SPO key hash set means that distributions for all SPOs will be returned

-> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map (KeyHash 'StakePool StandardCrypto) Coin))) 

queryDRepState Source #

Arguments

:: ConwayEraOnwards era 
-> Set (Credential 'DRepRole StandardCrypto)

An empty credentials set means that states for all DReps will be returned

-> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map (Credential 'DRepRole StandardCrypto) (DRepState StandardCrypto)))) 

queryGovState :: ConwayEraOnwards era -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (GovState (ShelleyLedgerEra era)))) Source #

queryStakeVoteDelegatees :: ConwayEraOnwards era -> Set StakeCredential -> LocalStateQueryExpr block point QueryInMode r IO (Either UnsupportedNtcVersionError (Either EraMismatch (Map StakeCredential (DRep StandardCrypto)))) Source #