| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Plutus.ChainIndex.Emulator
Synopsis
- newtype BlockId = BlockId {
- getBlockId :: ByteString
- data ChainIndexTxOutputs
- data ChainIndexTxOut = ChainIndexTxOut {
- citoAddress :: CardanoAddress
- citoValue :: Value
- citoDatum :: OutputDatum
- citoRefScript :: ReferenceScript
- data ReferenceScript
- = ReferenceScriptNone
- | ReferenceScriptInAnyLang ScriptInAnyLang
- fromReferenceScript :: ReferenceScript -> Maybe (Versioned Script)
- data ChainIndexTx = ChainIndexTx {
- _citxTxId :: TxId
- _citxInputs :: [TxOutRef]
- _citxOutputs :: ChainIndexTxOutputs
- _citxValidRange :: !SlotRange
- _citxData :: Map DatumHash Datum
- _citxRedeemers :: Redeemers
- _citxScripts :: Map ScriptHash (Versioned Script)
- _citxCardanoTx :: Maybe CardanoTx
- _InvalidTx :: Prism' ChainIndexTxOutputs (Maybe ChainIndexTxOut)
- _ValidTx :: Prism' ChainIndexTxOutputs [ChainIndexTxOut]
- chainIndexTxOutputs :: Traversal' ChainIndexTxOutputs ChainIndexTxOut
- data Tip
- = TipAtGenesis
- | Tip {
- tipSlot :: Slot
- tipBlockId :: BlockId
- tipBlockNo :: BlockNumber
- newtype BlockNumber = BlockNumber {}
- citxCardanoTx :: Lens' ChainIndexTx (Maybe CardanoTx)
- citxData :: Lens' ChainIndexTx (Map DatumHash Datum)
- citxInputs :: Lens' ChainIndexTx [TxOutRef]
- citxOutputs :: Lens' ChainIndexTx ChainIndexTxOutputs
- citxRedeemers :: Lens' ChainIndexTx Redeemers
- citxScripts :: Lens' ChainIndexTx (Map ScriptHash (Versioned Script))
- citxTxId :: Lens' ChainIndexTx TxId
- citxValidRange :: Lens' ChainIndexTx SlotRange
- blockId :: Block -> BlockId
- data Point
- = PointAtGenesis
- | Point {
- pointSlot :: Slot
- pointBlockId :: BlockId
- data TxOutBalance = TxOutBalance {
- _tobUnspentOutputs :: Set TxOutRef
- _tobSpentOutputs :: Map TxOutRef TxId
- data TxConfirmedState = TxConfirmedState {}
- data TxIdState = TxIdState {
- txnsConfirmed :: Map TxId TxConfirmedState
- txnsDeleted :: Map TxId (Sum Int)
- data TxStatusFailure
- data Diagnostics = Diagnostics {}
- data TxOutState
- type TxOutStatus = RollbackState TxOutState
- data RollbackState a
- type TxStatus = RollbackState ()
- newtype Depth = Depth {}
- data TxValidity
- _PointAtGenesis :: Prism' Point ()
- _Point :: Prism' Point (Slot, BlockId)
- tipAsPoint :: Tip -> Point
- pointsToTip :: Point -> Tip -> Bool
- txOutStatusTxOutState :: TxOutStatus -> Maybe TxOutState
- liftTxOutStatus :: TxOutStatus -> TxStatus
- data TxUtxoBalance = TxUtxoBalance {
- _tubUnspentOutputs :: Set TxOutRef
- _tubUnmatchedSpentInputs :: Set TxOutRef
- tobSpentOutputs :: Lens' TxOutBalance (Map TxOutRef TxId)
- tobUnspentOutputs :: Lens' TxOutBalance (Set TxOutRef)
- data ChainSyncBlock = Block {
- blockTip :: Tip
- blockTxs :: [(ChainIndexTx, TxProcessOption)]
- newtype TxProcessOption = TxProcessOption {
- tpoStoreTx :: Bool
- tubUnmatchedSpentInputs :: Lens' TxUtxoBalance (Set TxOutRef)
- tubUnspentOutputs :: Lens' TxUtxoBalance (Set TxOutRef)
- data RollbackFailed
- = RollbackNoTip
- | TipMismatch {
- foundTip :: Tip
- targetPoint :: Point
- | OldPointNotFound Point
- data InsertUtxoFailed
- data ChainIndexError
- = InsertionFailed InsertUtxoFailed
- | RollbackFailed RollbackFailed
- | ResumeNotSupported
- | QueryFailedNoTip
- | BeamEffectError BeamError
- | ToCardanoError ToCardanoError
- | UnsupportedQuery
- | UnsupportedControlOperation
- data CredentialMap
- data AssetClassMap
- unCredentialMap :: Iso' CredentialMap (Map Credential (Set TxOutRef))
- data DiskState
- unAssetClassMap :: Iso' AssetClassMap (Map AssetId (Set TxOutRef))
- addressMap :: Lens' DiskState CredentialMap
- assetClassMap :: Lens' DiskState AssetClassMap
- dataMap :: Lens' DiskState (Map DatumHash Datum)
- redeemerMap :: Lens' DiskState (Map RedeemerHash Redeemer)
- scriptMap :: Lens' DiskState (Map ScriptHash (Versioned Script))
- txMap :: Lens' DiskState (Map TxId ChainIndexTx)
- diagnostics :: DiskState -> Diagnostics
- data ChainIndexQueryEffect r where
- DatumFromHash :: DatumHash -> ChainIndexQueryEffect (Maybe Datum)
- ValidatorFromHash :: ValidatorHash -> ChainIndexQueryEffect (Maybe (Versioned Validator))
- MintingPolicyFromHash :: MintingPolicyHash -> ChainIndexQueryEffect (Maybe (Versioned MintingPolicy))
- RedeemerFromHash :: RedeemerHash -> ChainIndexQueryEffect (Maybe Redeemer)
- StakeValidatorFromHash :: StakeValidatorHash -> ChainIndexQueryEffect (Maybe (Versioned StakeValidator))
- UnspentTxOutFromRef :: TxOutRef -> ChainIndexQueryEffect (Maybe DecoratedTxOut)
- TxOutFromRef :: TxOutRef -> ChainIndexQueryEffect (Maybe DecoratedTxOut)
- TxFromTxId :: TxId -> ChainIndexQueryEffect (Maybe ChainIndexTx)
- UtxoSetMembership :: TxOutRef -> ChainIndexQueryEffect IsUtxoResponse
- UtxoSetAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect UtxosResponse
- UnspentTxOutSetAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect (QueryResponse [(TxOutRef, DecoratedTxOut)])
- DatumsAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect (QueryResponse [Datum])
- UtxoSetWithCurrency :: PageQuery TxOutRef -> AssetClass -> ChainIndexQueryEffect UtxosResponse
- TxsFromTxIds :: [TxId] -> ChainIndexQueryEffect [ChainIndexTx]
- TxoSetAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect TxosResponse
- GetTip :: ChainIndexQueryEffect Tip
- data ChainIndexControlEffect r where
- datumFromHash :: forall effs. Member ChainIndexQueryEffect effs => DatumHash -> Eff effs (Maybe Datum)
- validatorFromHash :: forall effs. Member ChainIndexQueryEffect effs => ValidatorHash -> Eff effs (Maybe (Versioned Validator))
- mintingPolicyFromHash :: forall effs. Member ChainIndexQueryEffect effs => MintingPolicyHash -> Eff effs (Maybe (Versioned MintingPolicy))
- redeemerFromHash :: forall effs. Member ChainIndexQueryEffect effs => RedeemerHash -> Eff effs (Maybe Redeemer)
- stakeValidatorFromHash :: forall effs. Member ChainIndexQueryEffect effs => StakeValidatorHash -> Eff effs (Maybe (Versioned StakeValidator))
- unspentTxOutFromRef :: forall effs. Member ChainIndexQueryEffect effs => TxOutRef -> Eff effs (Maybe DecoratedTxOut)
- txOutFromRef :: forall effs. Member ChainIndexQueryEffect effs => TxOutRef -> Eff effs (Maybe DecoratedTxOut)
- txFromTxId :: forall effs. Member ChainIndexQueryEffect effs => TxId -> Eff effs (Maybe ChainIndexTx)
- utxoSetMembership :: forall effs. Member ChainIndexQueryEffect effs => TxOutRef -> Eff effs IsUtxoResponse
- utxoSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs UtxosResponse
- unspentTxOutSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs (QueryResponse [(TxOutRef, DecoratedTxOut)])
- datumsAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs (QueryResponse [Datum])
- utxoSetWithCurrency :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> AssetClass -> Eff effs UtxosResponse
- txsFromTxIds :: forall effs. Member ChainIndexQueryEffect effs => [TxId] -> Eff effs [ChainIndexTx]
- txoSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs TxosResponse
- getTip :: forall effs. Member ChainIndexQueryEffect effs => Eff effs Tip
- appendBlocks :: forall effs. Member ChainIndexControlEffect effs => [ChainSyncBlock] -> Eff effs ()
- rollback :: forall effs. Member ChainIndexControlEffect effs => Point -> Eff effs ()
- resumeSync :: forall effs. Member ChainIndexControlEffect effs => Point -> Eff effs ()
- collectGarbage :: forall effs. Member ChainIndexControlEffect effs => Eff effs ()
- getDiagnostics :: forall effs. Member ChainIndexControlEffect effs => Eff effs Diagnostics
- data InsertUtxoPosition
- data ChainIndexLog
- = InsertionSuccess Tip InsertUtxoPosition
- | ConversionFailed FromCardanoError
- | RollbackSuccess Tip
- | Err ChainIndexError
- | TxNotFound TxId
- | TxOutNotFound TxOutRef
- | TipIsGenesis
- | NoDatumScriptAddr ChainIndexTxOut
- | BeamLogItem BeamLog
- data ChainIndexEmulatorState = ChainIndexEmulatorState {}
- diskState :: Lens' ChainIndexEmulatorState DiskState
- utxoIndex :: Lens' ChainIndexEmulatorState (UtxoIndex TxUtxoBalance)
- handleQuery :: forall effs. (Member (State ChainIndexEmulatorState) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexQueryEffect ~> Eff effs
- handleControl :: forall effs. (Member (State ChainIndexEmulatorState) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexControlEffect ~> Eff effs
- serveChainIndex :: forall effs. (Member (Error ServerError) effs, Member ChainIndexQueryEffect effs, Member ChainIndexControlEffect effs) => ServerT API (Eff effs)
- serveChainIndexQueryServer :: Int -> TVar ChainIndexEmulatorState -> IO ()
Documentation
Constructors
| BlockId | |
Fields
| |
Instances
| Eq BlockId | |
| Ord BlockId | |
Defined in Ledger.Blockchain | |
| Show BlockId | |
| Generic BlockId | |
| FromJSON BlockId | |
Defined in Ledger.Blockchain | |
| ToJSON BlockId | |
Defined in Ledger.Blockchain Methods toEncoding :: BlockId -> Encoding toJSONList :: [BlockId] -> Value toEncodingList :: [BlockId] -> Encoding | |
| ToSchema BlockId | |
Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy BlockId -> Declare (Definitions Schema) NamedSchema | |
| Pretty BlockId | |
Defined in Ledger.Blockchain | |
| HasDbType BlockId Source # | |
| type Rep BlockId | |
Defined in Ledger.Blockchain | |
| type DbType BlockId Source # | |
Defined in Plutus.ChainIndex.DbSchema | |
data ChainIndexTxOutputs Source #
List of outputs of a transaction. There is only an optional collateral output if the transaction is invalid.
Constructors
| InvalidTx (Maybe ChainIndexTxOut) | The transaction is invalid so there is maybe a collateral output. |
| ValidTx [ChainIndexTxOut] |
Instances
data ChainIndexTxOut Source #
Constructors
| ChainIndexTxOut | |
Fields
| |
Instances
data ReferenceScript Source #
Constructors
| ReferenceScriptNone | |
| ReferenceScriptInAnyLang ScriptInAnyLang |
Instances
fromReferenceScript :: ReferenceScript -> Maybe (Versioned Script) Source #
data ChainIndexTx Source #
Constructors
| ChainIndexTx | |
Fields
| |
Instances
_InvalidTx :: Prism' ChainIndexTxOutputs (Maybe ChainIndexTxOut) Source #
_ValidTx :: Prism' ChainIndexTxOutputs [ChainIndexTxOut] Source #
chainIndexTxOutputs :: Traversal' ChainIndexTxOutputs ChainIndexTxOut Source #
The tip of the chain index.
Constructors
| TipAtGenesis | |
| Tip | |
Fields
| |
Instances
newtype BlockNumber Source #
Constructors
| BlockNumber | |
Fields | |
Instances
citxCardanoTx :: Lens' ChainIndexTx (Maybe CardanoTx) Source #
citxData :: Lens' ChainIndexTx (Map DatumHash Datum) Source #
citxInputs :: Lens' ChainIndexTx [TxOutRef] Source #
citxOutputs :: Lens' ChainIndexTx ChainIndexTxOutputs Source #
citxRedeemers :: Lens' ChainIndexTx Redeemers Source #
citxScripts :: Lens' ChainIndexTx (Map ScriptHash (Versioned Script)) Source #
citxTxId :: Lens' ChainIndexTx TxId Source #
citxValidRange :: Lens' ChainIndexTx SlotRange Source #
When performing a rollback the chain sync protocol does not provide a block number where to resume from.
Constructors
| PointAtGenesis | |
| Point | |
Fields
| |
Instances
| Eq Point Source # | |
| Ord Point Source # | |
Defined in Plutus.ChainIndex.Types | |
| Show Point Source # | |
| Generic Point Source # | |
| Semigroup Point Source # | |
| Monoid Point Source # | |
| FromJSON Point Source # | |
Defined in Plutus.ChainIndex.Types | |
| ToJSON Point Source # | |
Defined in Plutus.ChainIndex.Types Methods toEncoding :: Point -> Encoding toJSONList :: [Point] -> Value toEncodingList :: [Point] -> Encoding | |
| Pretty Point Source # | |
Defined in Plutus.ChainIndex.Types | |
| type Rep Point Source # | |
Defined in Plutus.ChainIndex.Types type Rep Point = D1 ('MetaData "Point" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.2.0.0-KXwe88sWnh3Kg9uXBYztrS" 'False) (C1 ('MetaCons "PointAtGenesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Point" 'PrefixI 'True) (S1 ('MetaSel ('Just "pointSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Slot) :*: S1 ('MetaSel ('Just "pointBlockId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BlockId))) | |
data TxOutBalance Source #
The effect of a transaction (or a number of them) on the tx output set.
Constructors
| TxOutBalance | |
Fields
| |
Instances
data TxConfirmedState Source #
Constructors
| TxConfirmedState | |
Fields
| |
Instances
Constructors
| TxIdState | |
Fields
| |
Instances
| Eq TxIdState Source # | |
| Show TxIdState Source # | |
| Generic TxIdState Source # | |
| Semigroup TxIdState Source # | |
| Monoid TxIdState Source # | |
| type Rep TxIdState Source # | |
Defined in Plutus.ChainIndex.Types type Rep TxIdState = D1 ('MetaData "TxIdState" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.2.0.0-KXwe88sWnh3Kg9uXBYztrS" 'False) (C1 ('MetaCons "TxIdState" 'PrefixI 'True) (S1 ('MetaSel ('Just "txnsConfirmed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map TxId TxConfirmedState)) :*: S1 ('MetaSel ('Just "txnsDeleted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map TxId (Sum Int))))) | |
data TxStatusFailure Source #
Datatype returned when we couldn't get the state of a tx or a tx output.
Constructors
| TxIdStateInvalid BlockNumber TxId TxIdState | We couldn't return the status because the |
| TxOutBalanceStateInvalid BlockNumber TxOutRef TxOutBalance | We couldn't return the status because the |
| InvalidRollbackAttempt BlockNumber TxId TxIdState |
Instances
| Eq TxStatusFailure Source # | |
Defined in Plutus.ChainIndex.Types Methods (==) :: TxStatusFailure -> TxStatusFailure -> Bool Source # (/=) :: TxStatusFailure -> TxStatusFailure -> Bool Source # | |
| Show TxStatusFailure Source # | |
Defined in Plutus.ChainIndex.Types | |
data Diagnostics Source #
Constructors
| Diagnostics | |
Fields
| |
Instances
data TxOutState Source #
Instances
type TxOutStatus = RollbackState TxOutState Source #
data RollbackState a Source #
The rollback state of a Cardano transaction
Constructors
| Unknown | The transaction is not on the chain. That's all we can say. |
| TentativelyConfirmed Depth TxValidity a | The transaction is on the chain, n blocks deep. It can still be rolled back. |
| Committed TxValidity a | The transaction is on the chain. It cannot be rolled back anymore. |
Instances
type TxStatus = RollbackState () Source #
The status of a Cardano transaction
How many blocks deep the tx is on the chain
Instances
data TxValidity Source #
Validity of a transaction that has been added to the ledger
Constructors
| TxValid | |
| TxInvalid | |
| UnknownValidity |
Instances
_PointAtGenesis :: Prism' Point () Source #
tipAsPoint :: Tip -> Point Source #
txOutStatusTxOutState :: TxOutStatus -> Maybe TxOutState Source #
Maybe extract the TxOutState (Spent or Unspent) of a TxOutStatus.
liftTxOutStatus :: TxOutStatus -> TxStatus Source #
Converts a TxOutStatus to a TxStatus. Possible since a transaction
output belongs to a transaction.
Note, however, that we can't convert a TxStatus to a TxOutStatus.
data TxUtxoBalance Source #
The effect of a transaction (or a number of them) on the utxo set.
Constructors
| TxUtxoBalance | |
Fields
| |
Instances
tobSpentOutputs :: Lens' TxOutBalance (Map TxOutRef TxId) Source #
tobUnspentOutputs :: Lens' TxOutBalance (Set TxOutRef) Source #
data ChainSyncBlock Source #
A block of transactions to be synced.
Constructors
| Block | |
Fields
| |
Instances
| Show ChainSyncBlock Source # | |
Defined in Plutus.ChainIndex.Types | |
newtype TxProcessOption Source #
User-customizable options to process a transaction. See #73 for more motivations.
Constructors
| TxProcessOption | |
Fields
| |
Instances
| Show TxProcessOption Source # | |
Defined in Plutus.ChainIndex.Types | |
| Default TxProcessOption Source # | |
Defined in Plutus.ChainIndex.Types Methods | |
tubUnmatchedSpentInputs :: Lens' TxUtxoBalance (Set TxOutRef) Source #
tubUnspentOutputs :: Lens' TxUtxoBalance (Set TxOutRef) Source #
data RollbackFailed Source #
Reason why the rollback operation failed
Constructors
| RollbackNoTip | Rollback failed because the utxo index had no tip (not synchronised) |
| TipMismatch | Unable to roll back to |
Fields
| |
| OldPointNotFound Point | Unable to find the old tip |
Instances
data InsertUtxoFailed Source #
UTXO state could not be inserted into the chain index
Constructors
| DuplicateBlock Tip | Insertion failed as there was already a block with the given number |
| InsertUtxoNoTip | The |
Instances
data ChainIndexError Source #
Constructors
| InsertionFailed InsertUtxoFailed | |
| RollbackFailed RollbackFailed | |
| ResumeNotSupported | |
| QueryFailedNoTip | Query failed because the chain index does not have a tip (not synchronised with node) |
| BeamEffectError BeamError | |
| ToCardanoError ToCardanoError | |
| UnsupportedQuery | |
| UnsupportedControlOperation |
Instances
data CredentialMap Source #
Set of transaction output references for each address.
Instances
data AssetClassMap Source #
Set of transaction output references for each asset class.
Instances
unCredentialMap :: Iso' CredentialMap (Map Credential (Set TxOutRef)) Source #
Data that we keep on disk. (This type is used for testing only - we need other structures for the disk-backed storage)
Instances
unAssetClassMap :: Iso' AssetClassMap (Map AssetId (Set TxOutRef)) Source #
addressMap :: Lens' DiskState CredentialMap Source #
assetClassMap :: Lens' DiskState AssetClassMap Source #
redeemerMap :: Lens' DiskState (Map RedeemerHash Redeemer) Source #
txMap :: Lens' DiskState (Map TxId ChainIndexTx) Source #
diagnostics :: DiskState -> Diagnostics Source #
data ChainIndexQueryEffect r where Source #
Constructors
| DatumFromHash :: DatumHash -> ChainIndexQueryEffect (Maybe Datum) | Get the datum from a datum hash (if available) |
| ValidatorFromHash :: ValidatorHash -> ChainIndexQueryEffect (Maybe (Versioned Validator)) | Get the validator from a validator hash (if available) |
| MintingPolicyFromHash :: MintingPolicyHash -> ChainIndexQueryEffect (Maybe (Versioned MintingPolicy)) | Get the monetary policy from an MPS hash (if available) |
| RedeemerFromHash :: RedeemerHash -> ChainIndexQueryEffect (Maybe Redeemer) | Get the redeemer from a redeemer hash (if available) |
| StakeValidatorFromHash :: StakeValidatorHash -> ChainIndexQueryEffect (Maybe (Versioned StakeValidator)) | Get the stake validator from a stake validator hash (if available) |
| UnspentTxOutFromRef :: TxOutRef -> ChainIndexQueryEffect (Maybe DecoratedTxOut) | Get the TxOut from a TxOutRef (if available) |
| TxOutFromRef :: TxOutRef -> ChainIndexQueryEffect (Maybe DecoratedTxOut) | Get the TxOut from a TxOutRef (if available) |
| TxFromTxId :: TxId -> ChainIndexQueryEffect (Maybe ChainIndexTx) | Get the transaction for a tx ID |
| UtxoSetMembership :: TxOutRef -> ChainIndexQueryEffect IsUtxoResponse | Whether a tx output is part of the UTXO set |
| UtxoSetAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect UtxosResponse | Unspent outputs located at addresses with the given address. |
| UnspentTxOutSetAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect (QueryResponse [(TxOutRef, DecoratedTxOut)]) | Get the unspent txouts located at an address This is to avoid multiple queries from chain-index when using utxosAt |
| DatumsAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect (QueryResponse [Datum]) | get the datums located at addresses with the given address. |
| UtxoSetWithCurrency :: PageQuery TxOutRef -> AssetClass -> ChainIndexQueryEffect UtxosResponse | Unspent outputs containing a specific currency ( Note that requesting unspent outputs containing Ada should not return anything, as this request will always return all unspent outputs. |
| TxsFromTxIds :: [TxId] -> ChainIndexQueryEffect [ChainIndexTx] | Get the transactions for a list of tx IDs. |
| TxoSetAtAddress :: PageQuery TxOutRef -> CardanoAddress -> ChainIndexQueryEffect TxosResponse | Outputs located at addresses with the given address. |
| GetTip :: ChainIndexQueryEffect Tip | Get the tip of the chain index |
data ChainIndexControlEffect r where Source #
Constructors
| AppendBlocks :: [ChainSyncBlock] -> ChainIndexControlEffect () | Add new blocks to the chain index. |
| Rollback :: Point -> ChainIndexControlEffect () | Roll back to a previous state (previous tip) |
| ResumeSync :: Point -> ChainIndexControlEffect () | Resume syncing from a certain point |
| CollectGarbage :: ChainIndexControlEffect () | Delete all data that is not covered by current UTxOs. |
| GetDiagnostics :: ChainIndexControlEffect Diagnostics |
datumFromHash :: forall effs. Member ChainIndexQueryEffect effs => DatumHash -> Eff effs (Maybe Datum) Source #
validatorFromHash :: forall effs. Member ChainIndexQueryEffect effs => ValidatorHash -> Eff effs (Maybe (Versioned Validator)) Source #
mintingPolicyFromHash :: forall effs. Member ChainIndexQueryEffect effs => MintingPolicyHash -> Eff effs (Maybe (Versioned MintingPolicy)) Source #
redeemerFromHash :: forall effs. Member ChainIndexQueryEffect effs => RedeemerHash -> Eff effs (Maybe Redeemer) Source #
stakeValidatorFromHash :: forall effs. Member ChainIndexQueryEffect effs => StakeValidatorHash -> Eff effs (Maybe (Versioned StakeValidator)) Source #
unspentTxOutFromRef :: forall effs. Member ChainIndexQueryEffect effs => TxOutRef -> Eff effs (Maybe DecoratedTxOut) Source #
txOutFromRef :: forall effs. Member ChainIndexQueryEffect effs => TxOutRef -> Eff effs (Maybe DecoratedTxOut) Source #
txFromTxId :: forall effs. Member ChainIndexQueryEffect effs => TxId -> Eff effs (Maybe ChainIndexTx) Source #
utxoSetMembership :: forall effs. Member ChainIndexQueryEffect effs => TxOutRef -> Eff effs IsUtxoResponse Source #
utxoSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs UtxosResponse Source #
unspentTxOutSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs (QueryResponse [(TxOutRef, DecoratedTxOut)]) Source #
datumsAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs (QueryResponse [Datum]) Source #
utxoSetWithCurrency :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> AssetClass -> Eff effs UtxosResponse Source #
txsFromTxIds :: forall effs. Member ChainIndexQueryEffect effs => [TxId] -> Eff effs [ChainIndexTx] Source #
txoSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> CardanoAddress -> Eff effs TxosResponse Source #
getTip :: forall effs. Member ChainIndexQueryEffect effs => Eff effs Tip Source #
appendBlocks :: forall effs. Member ChainIndexControlEffect effs => [ChainSyncBlock] -> Eff effs () Source #
rollback :: forall effs. Member ChainIndexControlEffect effs => Point -> Eff effs () Source #
resumeSync :: forall effs. Member ChainIndexControlEffect effs => Point -> Eff effs () Source #
collectGarbage :: forall effs. Member ChainIndexControlEffect effs => Eff effs () Source #
getDiagnostics :: forall effs. Member ChainIndexControlEffect effs => Eff effs Diagnostics Source #
data InsertUtxoPosition Source #
Outcome of inserting a UtxoState into the utxo index
Constructors
| InsertAtEnd | The utxo state was added to the end. Returns the new index |
| InsertBeforeEnd | The utxo state was added somewhere before the end. Returns the new index and the tip |
Instances
data ChainIndexLog Source #
Constructors
| InsertionSuccess Tip InsertUtxoPosition | |
| ConversionFailed FromCardanoError | |
| RollbackSuccess Tip | |
| Err ChainIndexError | |
| TxNotFound TxId | |
| TxOutNotFound TxOutRef | |
| TipIsGenesis | |
| NoDatumScriptAddr ChainIndexTxOut | |
| BeamLogItem BeamLog |
Instances
data ChainIndexEmulatorState Source #
Constructors
| ChainIndexEmulatorState | |
Fields | |
Instances
diskState :: Lens' ChainIndexEmulatorState DiskState Source #
utxoIndex :: Lens' ChainIndexEmulatorState (UtxoIndex TxUtxoBalance) Source #
handleQuery :: forall effs. (Member (State ChainIndexEmulatorState) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexQueryEffect ~> Eff effs Source #
handleControl :: forall effs. (Member (State ChainIndexEmulatorState) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexControlEffect ~> Eff effs Source #
serveChainIndex :: forall effs. (Member (Error ServerError) effs, Member ChainIndexQueryEffect effs, Member ChainIndexControlEffect effs) => ServerT API (Eff effs) Source #
serveChainIndexQueryServer Source #
Arguments
| :: Int | Port |
| -> TVar ChainIndexEmulatorState | Chain index state (TODO: When the disk state is stored in a DB, replace this with DB connection info) |
| -> IO () |