bcc-api-1.99.0
Safe HaskellNone
LanguageHaskell2010

Bcc.Api.Query

Description

Queries from local clients to the node.

Synopsis

Queries

data QueryInMode mode result where Source #

Constructors

QueryCurrentEra ∷ ConsensusModeIsMultiEra mode → QueryInMode mode AnyBccEra 
QueryInEra ∷ EraInMode era mode → QueryInEra era result → QueryInMode mode (Either EraMismatch result) 
QueryEraHistory ∷ ConsensusModeIsMultiEra mode → QueryInMode mode (EraHistory mode) 
QuerySystemStart ∷ QueryInMode mode SystemStart 

Instances

Instances details
Show (QueryInMode mode result) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

showsPrec ∷ Int → QueryInMode mode result → ShowS Source #

show ∷ QueryInMode mode result → String Source #

showList ∷ [QueryInMode mode result] → ShowS Source #

data QueryInEra era result where Source #

Constructors

QueryColeUpdateState ∷ QueryInEra ColeEra ColeUpdateState 
QueryInSophieBasedEra ∷ SophieBasedEra era → QueryInSophieBasedEra era result → QueryInEra era result 

Instances

Instances details
Show (QueryInEra era result) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

showsPrec ∷ Int → QueryInEra era result → ShowS Source #

show ∷ QueryInEra era result → String Source #

showList ∷ [QueryInEra era result] → ShowS Source #

data QueryInSophieBasedEra era result where Source #

Constructors

QueryChainPoint ∷ QueryInSophieBasedEra era ChainPoint 
QueryEpoch ∷ QueryInSophieBasedEra era EpochNo 
QueryGenesisParameters ∷ QueryInSophieBasedEra era GenesisParameters 
QueryProtocolParameters ∷ QueryInSophieBasedEra era ProtocolParameters 
QueryProtocolParametersUpdate ∷ QueryInSophieBasedEra era (Map (Hash GenesisKey) ProtocolParametersUpdate) 
QueryStakeDistribution ∷ QueryInSophieBasedEra era (Map (Hash StakePoolKey) Rational) 
QueryUTxO ∷ QueryUTxOFilter → QueryInSophieBasedEra era (UTxO era) 
QueryStakeAddresses ∷ Set StakeCredential → NetworkId → QueryInSophieBasedEra era (Map StakeAddress Entropic, Map StakeAddress PoolId) 
QueryStakePools ∷ QueryInSophieBasedEra era (Set PoolId) 
QueryStakePoolParameters ∷ Set PoolId → QueryInSophieBasedEra era (Map PoolId StakePoolParameters) 
QueryDebugLedgerState ∷ QueryInSophieBasedEra era (SerialisedDebugLedgerState era) 
QueryProtocolState ∷ QueryInSophieBasedEra era (ProtocolState era) 

Instances

Instances details
Show (QueryInSophieBasedEra era result) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

showsPrec ∷ Int → QueryInSophieBasedEra era result → ShowS Source #

show ∷ QueryInSophieBasedEra era result → String Source #

showList ∷ [QueryInSophieBasedEra era result] → ShowS Source #

data QueryUTxOFilter Source #

Getting the whole UTxO is obviously not efficient since the result can be huge. Filtering by address is also not efficient because it requires a linear search.

The QueryUTxOFilterByTxIn is efficient since it fits with the structure of the UTxO (which is indexed by TxIn).

Constructors

QueryUTxOWhole

O(n) time and space for utxo size n

QueryUTxOByAddress (Set AddressAny)

O(n) time, O(m) space for utxo size n, and address set size m

QueryUTxOByTxIn (Set TxIn)

O(m log n) time, O(m) space for utxo size n, and address set size m

Instances

Instances details
Eq QueryUTxOFilter Source # 
Instance details

Defined in Bcc.Api.Query

Methods

(==) ∷ QueryUTxOFilter → QueryUTxOFilter → Bool Source #

(/=) ∷ QueryUTxOFilter → QueryUTxOFilter → Bool Source #

Show QueryUTxOFilter Source # 
Instance details

Defined in Bcc.Api.Query

Methods

showsPrec ∷ Int → QueryUTxOFilter → ShowS Source #

show ∷ QueryUTxOFilter → String Source #

showList ∷ [QueryUTxOFilter] → ShowS Source #

newtype UTxO era Source #

Constructors

UTxO (Map TxIn (TxOut era)) 

Instances

Instances details
Eq (UTxO era) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

(==) ∷ UTxO era → UTxO era → Bool Source #

(/=) ∷ UTxO era → UTxO era → Bool Source #

Show (UTxO era) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

showsPrec ∷ Int → UTxO era → ShowS Source #

show ∷ UTxO era → String Source #

showList ∷ [UTxO era] → ShowS Source #

IsBccEra era ⇒ ToJSON (UTxO era) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

toJSON ∷ UTxO era → Value #

toEncoding ∷ UTxO era → Encoding #

toJSONList ∷ [UTxO era] → Value #

toEncodingList ∷ [UTxO era] → Encoding #

data UTxOInAnyEra where Source #

Constructors

UTxOInAnyEra ∷ BccEra era → UTxO era → UTxOInAnyEra 

Instances

Instances details
Show UTxOInAnyEra Source # 
Instance details

Defined in Bcc.Api.Query

Methods

showsPrec ∷ Int → UTxOInAnyEra → ShowS Source #

show ∷ UTxOInAnyEra → String Source #

showList ∷ [UTxOInAnyEra] → ShowS Source #

Internal conversion functions

toConsensusQuery ∷ ∀ mode block result. ConsensusBlockForMode mode ~ block ⇒ QueryInMode mode result → Some (Query block) Source #

fromConsensusQueryResult ∷ ∀ mode block result result'. ConsensusBlockForMode mode ~ block ⇒ QueryInMode mode result → Query block result' → result' → result Source #

Wrapper types used in queries

newtype SerialisedDebugLedgerState era Source #

Constructors

SerialisedDebugLedgerState (Serialised (NewEpochState (SophieLedgerEra era))) 

newtype ProtocolState era Source #

Constructors

ProtocolState (Serialised (ChainDepState (Crypto (SophieLedgerEra era)))) 

data DebugLedgerState era where Source #

Constructors

DebugLedgerState ∷ SophieLedgerEra era ~ ledgerera ⇒ NewEpochState ledgerera → DebugLedgerState era 

Instances

Instances details
(IsSophieBasedEra era, SophieLedgerEra era ~ ledgerera, SophieBasedEra ledgerera, ToJSON (PParams ledgerera), ToJSON (PParamsDelta ledgerera), ToJSON (TxOut ledgerera)) ⇒ ToJSON (DebugLedgerState era) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

toJSON ∷ DebugLedgerState era → Value #

toEncoding ∷ DebugLedgerState era → Encoding #

toJSONList ∷ [DebugLedgerState era] → Value #

toEncodingList ∷ [DebugLedgerState era] → Encoding #

(Typeable era, TransLedgerState FromCBOR (SophieLedgerEra era)) ⇒ FromCBOR (DebugLedgerState era) Source # 
Instance details

Defined in Bcc.Api.Query

Methods

fromCBOR ∷ Decoder s (DebugLedgerState era) #

label ∷ Proxy (DebugLedgerState era) → Text #

data EraHistory mode where Source #

Constructors

EraHistory ∷ ConsensusBlockForMode mode ~ HardForkBlock xs ⇒ ConsensusMode mode → Interpreter xs → EraHistory mode 

newtype SystemStart #

Constructors

SystemStart 

Fields

Instances

Instances details
Eq SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Methods

(==) ∷ SystemStart → SystemStart → Bool Source #

(/=) ∷ SystemStart → SystemStart → Bool Source #

Show SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Methods

showsPrec ∷ Int → SystemStart → ShowS Source #

show ∷ SystemStart → String Source #

showList ∷ [SystemStart] → ShowS Source #

Generic SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Associated Types

type Rep SystemStart ∷ Type → Type Source #

Methods

from ∷ SystemStart → Rep SystemStart x Source #

to ∷ Rep SystemStart x → SystemStart Source #

FromJSON SystemStart Source # 
Instance details

Defined in Bcc.Api.Orphans

Methods

parseJSON ∷ Value → Parser SystemStart #

parseJSONList ∷ Value → Parser [SystemStart] #

NoThunks SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Methods

noThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo)

wNoThunks ∷ Context → SystemStart → IO (Maybe ThunkInfo)

showTypeOf ∷ Proxy SystemStart → String

ToJSON SystemStart Source # 
Instance details

Defined in Bcc.Api.Orphans

Methods

toJSON ∷ SystemStart → Value #

toEncoding ∷ SystemStart → Encoding #

toJSONList ∷ [SystemStart] → Value #

toEncodingList ∷ [SystemStart] → Encoding #

FromCBOR SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Methods

fromCBOR ∷ Decoder s SystemStart #

label ∷ Proxy SystemStart → Text #

ToCBOR SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Methods

toCBOR ∷ SystemStart → Encoding #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SystemStart → Size #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SystemStart] → Size #

Serialise SystemStart 
Instance details

Defined in Bcc.Slotting.Time

Methods

encode ∷ SystemStart → Encoding

decode ∷ Decoder s SystemStart

encodeList ∷ [SystemStart] → Encoding

decodeList ∷ Decoder s [SystemStart]

type Rep SystemStart 
Instance details

Defined in Bcc.Slotting.Time

type Rep SystemStart = D1 ('MetaData "SystemStart" "Bcc.Slotting.Time" "bcc-slotting-0.1.0.0-31796ee1b38506581e134229951d26120392aac1ce6c978fbf7438ab37ed4173" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

newtype SlotsInEpoch Source #

Constructors

SlotsInEpoch Word64 

newtype SlotsToEpochEnd Source #

Constructors

SlotsToEpochEnd Word64 

slotToEpoch ∷ SlotNo → EraHistory mode → Either PastHorizonException (EpochNo, SlotsInEpoch, SlotsToEpochEnd) Source #

data family LedgerState blk #

Instances

Instances details
Isomorphic LedgerState 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ LedgerState (HardForkBlock '[blk]) → LedgerState blk

inject ∷ NoHardForks blk ⇒ LedgerState blk → LedgerState (HardForkBlock '[blk])

CanHardFork xs ⇒ Eq (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Basics

Methods

(==) ∷ LedgerState (HardForkBlock xs) → LedgerState (HardForkBlock xs) → Bool Source #

(/=) ∷ LedgerState (HardForkBlock xs) → LedgerState (HardForkBlock xs) → Bool Source #

CanHardFork xs ⇒ Show (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Basics

Methods

showsPrec ∷ Int → LedgerState (HardForkBlock xs) → ShowS Source #

show ∷ LedgerState (HardForkBlock xs) → String Source #

showList ∷ [LedgerState (HardForkBlock xs)] → ShowS Source #

CanHardFork xs ⇒ NoThunks (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Basics

Methods

noThunks ∷ Context → LedgerState (HardForkBlock xs) → IO (Maybe ThunkInfo)

wNoThunks ∷ Context → LedgerState (HardForkBlock xs) → IO (Maybe ThunkInfo)

showTypeOf ∷ Proxy (LedgerState (HardForkBlock xs)) → String

Isomorphic (Ticked :.: LedgerState) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ (Ticked :.: LedgerState) (HardForkBlock '[blk]) → (Ticked :.: LedgerState) blk

inject ∷ NoHardForks blk ⇒ (Ticked :.: LedgerState) blk → (Ticked :.: LedgerState) (HardForkBlock '[blk])

data LedgerState ColeBlock 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

data LedgerState ColeBlock = ColeLedgerState {}
type TranslationError era (LedgerState :.: SophieBlock) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.SophieHFC

type TranslationError era (LedgerState :.: SophieBlock) = Void
type Rep (LedgerState ColeBlock) 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

type Rep (LedgerState ColeBlock) = D1 ('MetaData "LedgerState" "Shardagnostic.Consensus.Cole.Ledger.Ledger" "shardagnostic-consensus-cole-0.1.0.0-57763277a1dd4886d3500cfbed814a9e504ca4cde3b422e2c25ec9b5f4284c42" 'False) (C1 ('MetaCons "ColeLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "coleLedgerTipBlockNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin BlockNo)) :*: (S1 ('MetaSel ('Just "coleLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainValidationState) :*: S1 ('MetaSel ('Just "coleLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ColeTransition))))
type Rep (LedgerState (SophieBlock era)) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

type Rep (LedgerState (SophieBlock era)) = D1 ('MetaData "LedgerState" "Shardagnostic.Consensus.Sophie.Ledger.Ledger" "shardagnostic-consensus-sophie-0.1.0.0-78dae6cdce618e392ec705722a54aafcdfaf8e601dcc8aefa7ad8f77cf55bc12" 'False) (C1 ('MetaCons "SophieLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "sophieLedgerTip") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin (SophieTip era))) :*: (S1 ('MetaSel ('Just "sophieLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NewEpochState era)) :*: S1 ('MetaSel ('Just "sophieLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 SophieTransition))))
type Rep (Ticked (LedgerState ColeBlock)) 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

type Rep (Ticked (LedgerState ColeBlock)) = D1 ('MetaData "Ticked" "Shardagnostic.Consensus.Cole.Ledger.Ledger" "shardagnostic-consensus-cole-0.1.0.0-57763277a1dd4886d3500cfbed814a9e504ca4cde3b422e2c25ec9b5f4284c42" 'False) (C1 ('MetaCons "TickedColeLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "tickedColeLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChainValidationState) :*: S1 ('MetaSel ('Just "untickedColeLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 ColeTransition)))
type Rep (Ticked (LedgerState (HardForkBlock xs))) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Ledger

type Rep (Ticked (LedgerState (HardForkBlock xs))) = D1 ('MetaData "Ticked" "Shardagnostic.Consensus.HardFork.Combinator.Ledger" "shardagnostic-consensus-0.1.0.0-2aa8c817087060cd06754d8c0d3120b1c34fe53aa604e25131dc3c88e2ebf8ad" 'False) (C1 ('MetaCons "TickedHardForkLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "tickedHardForkLedgerStateTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TransitionInfo) :*: S1 ('MetaSel ('Just "tickedHardForkLedgerStatePerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HardForkState (Ticked :.: LedgerState) xs))))
type Rep (Ticked (LedgerState (SophieBlock era))) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

type Rep (Ticked (LedgerState (SophieBlock era))) = D1 ('MetaData "Ticked" "Shardagnostic.Consensus.Sophie.Ledger.Ledger" "shardagnostic-consensus-sophie-0.1.0.0-78dae6cdce618e392ec705722a54aafcdfaf8e601dcc8aefa7ad8f77cf55bc12" 'False) (C1 ('MetaCons "TickedSophieLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "untickedSophieLedgerTip") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin (SophieTip era))) :*: (S1 ('MetaSel ('Just "tickedSophieLedgerTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 SophieTransition) :*: S1 ('MetaSel ('Just "tickedSophieLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NewEpochState era)))))
type HeaderHash (LedgerState blk) 
Instance details

Defined in Shardagnostic.Consensus.Ledger.Basics

type HeaderHash (LedgerState blk) = HeaderHash blk
type AuxLedgerEvent (LedgerState ColeBlock) 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

type AuxLedgerEvent (LedgerState ColeBlock) = VoidLedgerEvent (LedgerState ColeBlock)
type AuxLedgerEvent (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Ledger

type AuxLedgerEvent (LedgerState (HardForkBlock xs)) = OneEraLedgerEvent xs
type AuxLedgerEvent (LedgerState (SophieBlock era)) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

type AuxLedgerEvent (LedgerState (SophieBlock era)) = SophieLedgerEvent era
type LedgerErr (LedgerState ColeBlock) 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

type LedgerErr (LedgerState ColeBlock) = ChainValidationError
type LedgerErr (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Ledger

type LedgerErr (LedgerState (HardForkBlock xs)) = HardForkLedgerError xs
type LedgerErr (LedgerState (SophieBlock era)) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

type LedgerErr (LedgerState (SophieBlock era)) = SophieLedgerError era
type LedgerCfg (LedgerState ColeBlock) 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

type LedgerCfg (LedgerState ColeBlock) = Config
type LedgerCfg (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Basics

type LedgerCfg (LedgerState (HardForkBlock xs)) = HardForkLedgerConfig xs
type LedgerCfg (LedgerState (SophieBlock era)) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

type LedgerCfg (LedgerState (SophieBlock era)) = SophieLedgerConfig era
newtype LedgerState (HardForkBlock xs) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Basics

newtype LedgerState (HardForkBlock xs) = HardForkLedgerState {}
data LedgerState (SophieBlock era) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

data LedgerState (SophieBlock era) = SophieLedgerState {}
data Ticked (LedgerState ColeBlock) 
Instance details

Defined in Shardagnostic.Consensus.Cole.Ledger.Ledger

data Ticked (LedgerState ColeBlock) = TickedColeLedgerState {}
data Ticked (LedgerState (HardForkBlock xs)) 
Instance details

Defined in Shardagnostic.Consensus.HardFork.Combinator.Ledger

data Ticked (LedgerState (HardForkBlock xs)) = TickedHardForkLedgerState {}
data Ticked (LedgerState (SophieBlock era)) 
Instance details

Defined in Shardagnostic.Consensus.Sophie.Ledger.Ledger

data Ticked (LedgerState (SophieBlock era)) = TickedSophieLedgerState {}

getProgress ∷ SlotNo → EraHistory mode → Either PastHorizonException (RelativeTime, SlotLength) Source #

Internal conversion functions

toLedgerUTxO ∷ SophieLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ SophieBasedEra era → UTxO era → UTxO ledgerera Source #

fromLedgerUTxO ∷ SophieLedgerEra era ~ ledgerera ⇒ Crypto ledgerera ~ StandardCrypto ⇒ SophieBasedEra era → UTxO ledgerera → UTxO era Source #