Safe Haskell	Safe-Inferred
Language	Haskell2010

Marconi.Cardano.Indexers.UtxoQuery

Contents

Indexer
Query
Result

Description

An aggregate indexer that gathers information of Utxo, Spent, Datum and BlockInfo to provide the UTxO information with resolved datum and information about the TxIn used to produce an UTxO.

Synopsis

type UtxoQueryIndexer m = WithTrace IO (SQLiteAggregateQuery m ChainPoint) UtxoQueryEvent
data UtxoQueryAggregate m = forall utxoIndexer utxo spentIndexer spent datumIndexer datum blockInfoIndexer blockInfo.(IsSourceProvider m (NonEmpty Utxo) utxoIndexer, IsSourceProvider m utxo utxoIndexer, Point utxo ~ Point (NonEmpty Utxo), IsSourceProvider m (NonEmpty SpentInfo) spentIndexer, IsSourceProvider m spent spentIndexer, Point spent ~ Point (NonEmpty SpentInfo), IsSourceProvider m (NonEmpty DatumInfo) datumIndexer, IsSourceProvider m datum datumIndexer, Point datum ~ Point (NonEmpty DatumInfo), IsSourceProvider m BlockInfo blockInfoIndexer, IsSourceProvider m blockInfo blockInfoIndexer, Point blockInfo ~ Point BlockInfo) => UtxoQueryAggregate {
- utxoIndexer :: MVar (utxoIndexer utxo)
- spentIndexer :: MVar (spentIndexer spent)
- datumIndexer :: MVar (datumIndexer datum)
- blockInfoIndexer :: MVar (blockInfoIndexer blockInfo)
}
data UtxoQueryEvent
mkUtxoSQLiteQuery :: UtxoQueryAggregate m -> IO (SQLiteAggregateQuery m ChainPoint event)
data UtxoQueryInput = UtxoQueryInput {
- _address :: AddressAny
- _lowerBound :: Maybe SlotNo
- _upperBound :: Maybe SlotNo
}
address :: Lens' UtxoQueryInput AddressAny
lowerBound :: Lens' UtxoQueryInput (Maybe SlotNo)
upperBound :: Lens' UtxoQueryInput (Maybe SlotNo)
data UtxoResult = UtxoResult Utxo !(Maybe ScriptData) !(Timed ChainPoint BlockInfo) !(Maybe (Timed ChainPoint (BlockInfo, TxId))) [TxIn]
utxo :: Lens' UtxoResult Utxo
datum :: Lens' UtxoResult (Maybe ScriptData)
blockInfo :: Lens' UtxoResult (Timed ChainPoint BlockInfo)
spentInfo :: Lens' UtxoResult (Maybe (Timed ChainPoint (BlockInfo, TxId)))
inputs :: Lens' UtxoResult [TxIn]

Indexer

type UtxoQueryIndexer m = WithTrace IO (SQLiteAggregateQuery m ChainPoint) UtxoQueryEvent #

An alias for the SQLiteAggregateQuery that handle the UtxoQueryEvent

data UtxoQueryAggregate m #

Explicit list of resources needed for the UtxoQueryAggregate

Constructors

forall utxoIndexer utxo spentIndexer spent datumIndexer datum blockInfoIndexer blockInfo.(IsSourceProvider m (NonEmpty Utxo) utxoIndexer, IsSourceProvider m utxo utxoIndexer, Point utxo ~ Point (NonEmpty Utxo), IsSourceProvider m (NonEmpty SpentInfo) spentIndexer, IsSourceProvider m spent spentIndexer, Point spent ~ Point (NonEmpty SpentInfo), IsSourceProvider m (NonEmpty DatumInfo) datumIndexer, IsSourceProvider m datum datumIndexer, Point datum ~ Point (NonEmpty DatumInfo), IsSourceProvider m BlockInfo blockInfoIndexer, IsSourceProvider m blockInfo blockInfoIndexer, Point blockInfo ~ Point BlockInfo) => UtxoQueryAggregate

Fields

utxoIndexer :: MVar (utxoIndexer utxo)
the source provider for the Utxo table, usually a UtxoIndexer
spentIndexer :: MVar (spentIndexer spent)
the source provider for the Spent table, usually a SpentIndexer
datumIndexer :: MVar (datumIndexer datum)
the source provider for the Datum table, usually a DatumIndexer
blockInfoIndexer :: MVar (blockInfoIndexer blockInfo)
the source provider for the BlockInfo table, usually a BlockInfoIndexer

data UtxoQueryEvent #

Uninhabited type for the UtxoQueryAggregate (as it's an aggregate, it doesn't index anything)

Instances

Instances details

MonadIO m => Queryable m UtxoQueryEvent UtxoQueryInput (SQLiteAggregateQuery n ChainPoint) #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods query :: Point UtxoQueryEvent -> UtxoQueryInput -> SQLiteAggregateQuery n ChainPoint UtxoQueryEvent -> m (Result UtxoQueryInput) Source # queryLatest :: UtxoQueryInput -> SQLiteAggregateQuery n ChainPoint UtxoQueryEvent -> m (Result UtxoQueryInput) Source #
type Point UtxoQueryEvent #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery type Point UtxoQueryEvent = ChainPoint

mkUtxoSQLiteQuery :: UtxoQueryAggregate m -> IO (SQLiteAggregateQuery m ChainPoint event) #

Generate a UtxoQueryIndexer from the given source

Query

data UtxoQueryInput #

Constructors

UtxoQueryInput
Fields _address :: AddressAny _lowerBound :: Maybe SlotNo Inclusive lowerBound _upperBound :: Maybe SlotNo Inclusive upperBound (utxo spent after this point displaed with their spent information)

Instances

Instances details

FromJSON UtxoQueryInput #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods parseJSON :: Value -> Parser UtxoQueryInput parseJSONList :: Value -> Parser [UtxoQueryInput]
ToJSON UtxoQueryInput #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods toJSON :: UtxoQueryInput -> Value toEncoding :: UtxoQueryInput -> Encoding toJSONList :: [UtxoQueryInput] -> Value toEncodingList :: [UtxoQueryInput] -> Encoding
Generic UtxoQueryInput #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Associated Types type Rep UtxoQueryInput :: Type -> Type Source # Methods from :: UtxoQueryInput -> Rep UtxoQueryInput x Source # to :: Rep UtxoQueryInput x -> UtxoQueryInput Source #
MonadIO m => Queryable m UtxoQueryEvent UtxoQueryInput (SQLiteAggregateQuery n ChainPoint) #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods query :: Point UtxoQueryEvent -> UtxoQueryInput -> SQLiteAggregateQuery n ChainPoint UtxoQueryEvent -> m (Result UtxoQueryInput) Source # queryLatest :: UtxoQueryInput -> SQLiteAggregateQuery n ChainPoint UtxoQueryEvent -> m (Result UtxoQueryInput) Source #
type Rep UtxoQueryInput #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery type Rep UtxoQueryInput = D1 ('MetaData "UtxoQueryInput" "Marconi.Cardano.Indexers.UtxoQuery" "marconi-cardano-indexers-1.2.0.0-inplace" 'False) (C1 ('MetaCons "UtxoQueryInput" 'PrefixI 'True) (S1 ('MetaSel ('Just "_address") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AddressAny) :: (S1 ('MetaSel ('Just "_lowerBound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SlotNo)) :: S1 ('MetaSel ('Just "_upperBound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SlotNo)))))
type Result UtxoQueryInput #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery type Result UtxoQueryInput = [UtxoResult]

address :: Lens' UtxoQueryInput AddressAny #

lowerBound :: Lens' UtxoQueryInput (Maybe SlotNo) #

upperBound :: Lens' UtxoQueryInput (Maybe SlotNo) #

Result

data UtxoResult #

Constructors

UtxoResult Utxo !(Maybe ScriptData) !(Timed ChainPoint BlockInfo) !(Maybe (Timed ChainPoint (BlockInfo, TxId))) [TxIn]

Instances

Instances details

FromJSON UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods parseJSON :: Value -> Parser UtxoResult parseJSONList :: Value -> Parser [UtxoResult]
ToJSON UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods toJSON :: UtxoResult -> Value toEncoding :: UtxoResult -> Encoding toJSONList :: [UtxoResult] -> Value toEncodingList :: [UtxoResult] -> Encoding
Generic UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Associated Types type Rep UtxoResult :: Type -> Type Source # Methods from :: UtxoResult -> Rep UtxoResult x Source # to :: Rep UtxoResult x -> UtxoResult Source #
Show UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods showsPrec :: Int -> UtxoResult -> ShowS Source # show :: UtxoResult -> String Source # showList :: [UtxoResult] -> ShowS Source #
Eq UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods (==) :: UtxoResult -> UtxoResult -> Bool Source # (/=) :: UtxoResult -> UtxoResult -> Bool Source #
FromRow UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery Methods fromRow :: RowParser UtxoResult
type Rep UtxoResult #
Instance details Defined in Marconi.Cardano.Indexers.UtxoQuery type Rep UtxoResult = D1 ('MetaData "UtxoResult" "Marconi.Cardano.Indexers.UtxoQuery" "marconi-cardano-indexers-1.2.0.0-inplace" 'False) (C1 ('MetaCons "UtxoResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Utxo) :: S1 ('MetaSel ('Just "_datum") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe ScriptData))) :: (S1 ('MetaSel ('Just "_blockInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Timed ChainPoint BlockInfo)) :: (S1 ('MetaSel ('Just "_spentInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe (Timed ChainPoint (BlockInfo, TxId)))) :: S1 ('MetaSel ('Just "_inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [TxIn])))))

utxo :: Lens' UtxoResult Utxo #

datum :: Lens' UtxoResult (Maybe ScriptData) #

blockInfo :: Lens' UtxoResult (Timed ChainPoint BlockInfo) #

spentInfo :: Lens' UtxoResult (Maybe (Timed ChainPoint (BlockInfo, TxId))) #

inputs :: Lens' UtxoResult [TxIn] #