Safe Haskell	None
Language	Haskell2010

Plutus.ChainIndex

Synopsis

runChainIndexEffects :: RunRequirements -> Eff '[ChainIndexQueryEffect, ChainIndexControlEffect, BeamEffect Sqlite] a -> IO (Either ChainIndexError a)
handleChainIndexEffects :: (LastMember IO effs, Member (LogMsg ChainIndexLog) effs) => RunRequirements -> Eff (ChainIndexQueryEffect ': (ChainIndexControlEffect ': (BeamEffect Sqlite ': effs))) a -> Eff effs (Either ChainIndexError a)
data RunRequirements = RunRequirements {
- trace :: Trace IO (PrettyObject ChainIndexLog)
- stateTVar :: TVar ChainIndexState
- pool :: Pool Connection
- securityParam :: Int
}
newtype Value = Value {
- getValue :: Map CurrencySymbol (Map TokenName Integer)
}
pageOf :: Eq a => PageQuery a -> Set a -> Page a
data PageQuery a = PageQuery {
- pageQuerySize :: PageSize
- pageQueryLastItem :: Maybe a
}
newtype PageSize = PageSize {
- getPageSize :: Natural
}
data Page a = Page {
- currentPageQuery :: PageQuery a
- nextPageQuery :: Maybe (PageQuery a)
- pageItems :: [a]
}
newtype BlockId = BlockId {
- getBlockId :: ByteString
}
data Address = Address {
- addressCredential :: Credential
- addressStakingCredential :: Maybe StakingCredential
}
data OutputDatum
- = NoOutputDatum
- | OutputDatumHash DatumHash
- | OutputDatum Datum
data ChainIndexTxOutputs
- = InvalidTx (Maybe ChainIndexTxOut)
- | ValidTx [ChainIndexTxOut]
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 :: [TxIn]
- _citxOutputs :: ChainIndexTxOutputs
- _citxValidRange :: !SlotRange
- _citxData :: Map DatumHash Datum
- _citxRedeemers :: Redeemers
- _citxScripts :: Map ScriptHash (Versioned Script)
- _citxCardanoTx :: Maybe SomeCardanoApiTx
}
_InvalidTx :: Prism' ChainIndexTxOutputs (Maybe ChainIndexTxOut)
_ValidTx :: Prism' ChainIndexTxOutputs [ChainIndexTxOut]
data Tip
- = TipAtGenesis
- | Tip {
  - tipSlot :: Slot
  - tipBlockId :: BlockId
  - tipBlockNo :: BlockNumber
  }
newtype BlockNumber = BlockNumber {
- unBlockNumber :: Word64
}
citxCardanoTx :: Lens' ChainIndexTx (Maybe SomeCardanoApiTx)
citxData :: Lens' ChainIndexTx (Map DatumHash Datum)
citxInputs :: Lens' ChainIndexTx [TxIn]
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 {
- timesConfirmed :: Sum Int
- blockAdded :: Last BlockNumber
- validity :: Last TxValidity
}
data TxIdState = TxIdState {
- txnsConfirmed :: Map TxId TxConfirmedState
- txnsDeleted :: Map TxId (Sum Int)
}
data TxStatusFailure
- = TxIdStateInvalid BlockNumber TxId TxIdState
- | TxOutBalanceStateInvalid BlockNumber TxOutRef TxOutBalance
- | InvalidRollbackAttempt BlockNumber TxId TxIdState
data Diagnostics = Diagnostics {
- numTransactions :: Integer
- numScripts :: Integer
- numAddresses :: Integer
- numAssetClasses :: Integer
- numUnspentOutputs :: Int
- numUnmatchedInputs :: Int
- someTransactions :: [TxId]
- unspentTxOuts :: [ChainIndexTxOut]
}
data TxOutState
- = Spent TxId
- | Unspent
type TxOutStatus = RollbackState TxOutState
data RollbackState a
- = Unknown
- | TentativelyConfirmed Depth TxValidity a
- | Committed TxValidity a
type TxStatus = RollbackState ()
newtype Depth = Depth {
- unDepth :: Int
}
data TxValidity
- = TxValid
- | TxInvalid
- | UnknownValidity
_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
- = DuplicateBlock Tip
- | InsertUtxoNoTip
data ChainIndexError
- = InsertionFailed InsertUtxoFailed
- | RollbackFailed RollbackFailed
- | ResumeNotSupported
- | QueryFailedNoTip
- | BeamEffectError BeamError
txOuts :: ChainIndexTx -> [ChainIndexTxOut]
txOutRefs :: ChainIndexTx -> [TxOutRef]
txOutsWithRef :: ChainIndexTx -> [(ChainIndexTxOut, TxOutRef)]
txOutRefMap :: ChainIndexTx -> Map TxOutRef (ChainIndexTxOut, ChainIndexTx)
txOutRefMapForAddr :: CardanoAddress -> ChainIndexTx -> Map TxOutRef (ChainIndexTxOut, ChainIndexTx)
validityFromChainIndex :: ChainIndexTx -> TxValidity
fromOnChainTx :: OnChainTx -> ChainIndexTx
txRedeemersWithHash :: ChainIndexTx -> Map RedeemerHash Redeemer
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 -> Credential -> ChainIndexQueryEffect UtxosResponse
- UnspentTxOutSetAtAddress :: PageQuery TxOutRef -> Credential -> ChainIndexQueryEffect (QueryResponse [(TxOutRef, DecoratedTxOut)])
- DatumsAtAddress :: PageQuery TxOutRef -> Credential -> ChainIndexQueryEffect (QueryResponse [Datum])
- UtxoSetWithCurrency :: PageQuery TxOutRef -> AssetClass -> ChainIndexQueryEffect UtxosResponse
- TxsFromTxIds :: [TxId] -> ChainIndexQueryEffect [ChainIndexTx]
- TxoSetAtAddress :: PageQuery TxOutRef -> Credential -> ChainIndexQueryEffect TxosResponse
- GetTip :: ChainIndexQueryEffect Tip
data ChainIndexControlEffect r where
- AppendBlocks :: [ChainSyncBlock] -> ChainIndexControlEffect ()
- Rollback :: Point -> ChainIndexControlEffect ()
- ResumeSync :: Point -> ChainIndexControlEffect ()
- CollectGarbage :: ChainIndexControlEffect ()
- GetDiagnostics :: ChainIndexControlEffect Diagnostics
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 -> Credential -> Eff effs UtxosResponse
unspentTxOutSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> Credential -> Eff effs (QueryResponse [(TxOutRef, DecoratedTxOut)])
datumsAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> Credential -> 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 -> Credential -> 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
- = InsertAtEnd
- | InsertBeforeEnd
data ChainIndexLog
- = InsertionSuccess Tip InsertUtxoPosition
- | ConversionFailed FromCardanoError
- | RollbackSuccess Tip
- | Err ChainIndexError
- | TxNotFound TxId
- | TxOutNotFound TxOutRef
- | TipIsGenesis
- | NoDatumScriptAddr ChainIndexTxOut
- | BeamLogItem BeamLog
data UtxoState a = UtxoState {
- _usTxUtxoData :: a
- _usTip :: Tip
}
data ReduceBlockCountResult a
- = BlockCountNotReduced
- | ReduceBlockCountResult {
  - reducedIndex :: UtxoIndex a
  - combinedState :: UtxoState a
  }
data RollbackResult a = RollbackResult {
- newTip :: Tip
- rolledBackIndex :: UtxoIndex a
}
data InsertUtxoSuccess a = InsertUtxoSuccess {
- newIndex :: UtxoIndex a
- insertPosition :: InsertUtxoPosition
}
type UtxoIndex a = FingerTree (BlockCount, UtxoState a) (UtxoState a)
newtype BlockCount = BlockCount {
- getBlockCount :: Int
}
usTip :: forall a. Lens' (UtxoState a) Tip
usTxUtxoData :: forall a a. Lens (UtxoState a) (UtxoState a) a a
utxoState :: Monoid a => UtxoIndex a -> UtxoState a
utxoBlockCount :: Monoid a => UtxoIndex a -> Int
tip :: UtxoState a -> Tip
viewTip :: Monoid a => UtxoIndex a -> Tip
insert :: (Monoid a, Eq a) => UtxoState a -> UtxoIndex a -> Either InsertUtxoFailed (InsertUtxoSuccess a)
rollbackWith :: Monoid a => (UtxoIndex a -> UtxoIndex a -> UtxoIndex a) -> Point -> UtxoIndex a -> Either RollbackFailed (RollbackResult a)
reduceBlockCount :: Monoid a => Depth -> UtxoIndex a -> ReduceBlockCountResult a
pointLessThanTip :: Point -> Tip -> Bool
initialStatus :: OnChainTx -> TxStatus
increaseDepth :: TxStatus -> TxStatus
chainConstant :: Depth
dropOlder :: Monoid a => BlockNumber -> UtxoIndex a -> UtxoIndex a
transactionStatus :: BlockNumber -> TxIdState -> TxId -> Either TxStatusFailure TxStatus
transactionOutputStatus :: BlockNumber -> TxIdState -> TxOutBalance -> TxOutRef -> Either TxStatusFailure TxOutStatus
transactionOutputState :: TxOutBalance -> TxOutRef -> Maybe TxOutState
unspentOutputs :: UtxoState TxOutBalance -> Set TxOutRef
spentOutputs :: UtxoState TxOutBalance -> Set TxOutRef
type ChainIndexState = UtxoIndex TxUtxoBalance
getResumePoints :: Member (BeamEffect Sqlite) effs => Eff effs [ChainPoint]
handleQuery :: (Member (State ChainIndexState) effs, Member (BeamEffect Sqlite) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexQueryEffect ~> Eff effs
handleControl :: forall effs. (Member (State ChainIndexState) effs, Member (Reader Depth) effs, Member (BeamEffect Sqlite) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexControlEffect ~> Eff effs
restoreStateFromDb :: Member (BeamEffect Sqlite) effs => Eff effs ChainIndexState

Documentation

runChainIndexEffects :: RunRequirements -> Eff '[ChainIndexQueryEffect, ChainIndexControlEffect, BeamEffect Sqlite] a -> IO (Either ChainIndexError a) Source #

Run the chain index effects.

handleChainIndexEffects :: (LastMember IO effs, Member (LogMsg ChainIndexLog) effs) => RunRequirements -> Eff (ChainIndexQueryEffect ': (ChainIndexControlEffect ': (BeamEffect Sqlite ': effs))) a -> Eff effs (Either ChainIndexError a) Source #

Handle the chain index effects from the set of all effects.

data RunRequirements Source #

The required arguments to run the chain index effects.

Constructors

RunRequirements
Fields trace :: Trace IO (PrettyObject ChainIndexLog) stateTVar :: TVar ChainIndexState pool :: Pool Connection securityParam :: Int

newtype Value Source #

A cryptocurrency value. This is a map from CurrencySymbols to a quantity of that currency.

Operations on currencies are usually implemented pointwise. That is, we apply the operation to the quantities for each currency in turn. So when we add two Values the resulting Value has, for each currency, the sum of the quantities of that particular currency in the argument Value. The effect of this is that the currencies in the Value are "independent", and are operated on separately.

Whenever we need to get the quantity of a currency in a Value where there is no explicit quantity of that currency in the Value, then the quantity is taken to be zero.

See note [Currencies] for more details.

Constructors

Value
Fields getValue :: Map CurrencySymbol (Map TokenName Integer)

Instances

Instances details

Eq Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (==) :: Value -> Value -> Bool Source # (/=) :: Value -> Value -> Bool Source #
Data Value
Instance details Defined in Plutus.V1.Ledger.Value Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value Source # toConstr :: Value -> Constr Source # dataTypeOf :: Value -> DataType Source # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Value) Source # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value) Source # gmapT :: (forall b. Data b => b -> b) -> Value -> Value Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r Source # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r Source # gmapQ :: (forall d. Data d => d -> u) -> Value -> [u] Source # gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u Source # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value Source #
Show Value
Instance details Defined in Plutus.V1.Ledger.Value Methods showsPrec :: Int -> Value -> ShowS Source # show :: Value -> String Source # showList :: [Value] -> ShowS Source #
Generic Value
Instance details Defined in Plutus.V1.Ledger.Value Associated Types type Rep Value :: Type -> Type Source # Methods from :: Value -> Rep Value x Source # to :: Rep Value x -> Value Source #
Semigroup Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (<>) :: Value -> Value -> Value Source # sconcat :: NonEmpty Value -> Value Source # stimes :: Integral b => b -> Value -> Value Source #
Monoid Value
Instance details Defined in Plutus.V1.Ledger.Value Methods mempty :: Value Source # mappend :: Value -> Value -> Value Source # mconcat :: [Value] -> Value Source #
NFData Value
Instance details Defined in Plutus.V1.Ledger.Value Methods rnf :: Value -> () Source #
Pretty Value
Instance details Defined in Plutus.V1.Ledger.Value Methods pretty :: Value -> Doc ann Source # prettyList :: [Value] -> Doc ann Source #
UnsafeFromData Value
Instance details Defined in Plutus.V1.Ledger.Value Methods unsafeFromBuiltinData :: BuiltinData -> Value Source #
FromData Value
Instance details Defined in Plutus.V1.Ledger.Value Methods fromBuiltinData :: BuiltinData -> Maybe Value Source #
ToData Value
Instance details Defined in Plutus.V1.Ledger.Value Methods toBuiltinData :: Value -> BuiltinData Source #
JoinSemiLattice Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (\/) :: Value -> Value -> Value Source #
MeetSemiLattice Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (/\) :: Value -> Value -> Value Source #
AdditiveSemigroup Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (+) :: Value -> Value -> Value Source #
AdditiveMonoid Value
Instance details Defined in Plutus.V1.Ledger.Value Methods zero :: Value Source #
AdditiveGroup Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (-) :: Value -> Value -> Value Source #
Monoid Value
Instance details Defined in Plutus.V1.Ledger.Value Methods mempty :: Value Source #
Group Value
Instance details Defined in Plutus.V1.Ledger.Value Methods inv :: Value -> Value Source #
Semigroup Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (<>) :: Value -> Value -> Value Source #
Eq Value
Instance details Defined in Plutus.V1.Ledger.Value Methods (==) :: Value -> Value -> Bool Source #
Module Integer Value
Instance details Defined in Plutus.V1.Ledger.Value Methods scale :: Integer -> Value -> Value Source #
Lift DefaultUni Value
Instance details Defined in Plutus.V1.Ledger.Value Methods lift :: Value -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni Value
Instance details Defined in Plutus.V1.Ledger.Value Methods typeRep :: Proxy Value -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep Value
Instance details Defined in Plutus.V1.Ledger.Value type Rep Value = D1 ('MetaData "Value" "Plutus.V1.Ledger.Value" "plutus-ledger-api-1.0.0.1-EUjexvcAhXiGIaLon6olWb" 'True) (C1 ('MetaCons "Value" 'PrefixI 'True) (S1 ('MetaSel ('Just "getValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map CurrencySymbol (Map TokenName Integer)))))

pageOf Source #

Arguments

:: Eq a
=> PageQuery a	Pagination query parameters.
-> Set a
-> Page a

Given a Set, request the Page with the given PageQuery.

data PageQuery a Source #

Query parameters for pagination.

Constructors

PageQuery
Fields pageQuerySize :: PageSize Number of items per page. pageQueryLastItem :: Maybe a Last item of the queried page.

Instances

Instances details

Functor PageQuery
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods fmap :: (a -> b) -> PageQuery a -> PageQuery b Source # (<$) :: a -> PageQuery b -> PageQuery a Source #
Eq a => Eq (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (==) :: PageQuery a -> PageQuery a -> Bool Source # (/=) :: PageQuery a -> PageQuery a -> Bool Source #
Ord a => Ord (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods compare :: PageQuery a -> PageQuery a -> Ordering Source # (<) :: PageQuery a -> PageQuery a -> Bool Source # (<=) :: PageQuery a -> PageQuery a -> Bool Source # (>) :: PageQuery a -> PageQuery a -> Bool Source # (>=) :: PageQuery a -> PageQuery a -> Bool Source # max :: PageQuery a -> PageQuery a -> PageQuery a Source # min :: PageQuery a -> PageQuery a -> PageQuery a Source #
Show a => Show (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods showsPrec :: Int -> PageQuery a -> ShowS Source # show :: PageQuery a -> String Source # showList :: [PageQuery a] -> ShowS Source #
Generic (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Associated Types type Rep (PageQuery a) :: Type -> Type Source # Methods from :: PageQuery a -> Rep (PageQuery a) x Source # to :: Rep (PageQuery a) x -> PageQuery a Source #
ToJSON a => ToJSON (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods toJSON :: PageQuery a -> Value Source # toEncoding :: PageQuery a -> Encoding Source # toJSONList :: [PageQuery a] -> Value Source # toEncodingList :: [PageQuery a] -> Encoding Source #
FromJSON a => FromJSON (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods parseJSON :: Value -> Parser (PageQuery a) Source # parseJSONList :: Value -> Parser [PageQuery a] Source #
Default (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods def :: PageQuery a Source #
ToSchema a => ToSchema (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods declareNamedSchema :: Proxy (PageQuery a) -> Declare (Definitions Schema) NamedSchema Source #
type Rep (PageQuery a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination type Rep (PageQuery a) = D1 ('MetaData "PageQuery" "Control.Monad.Freer.Extras.Pagination" "freer-extras-1.1.0.0-EyJCycsLf6M9CsqRdBgpX0" 'False) (C1 ('MetaCons "PageQuery" 'PrefixI 'True) (S1 ('MetaSel ('Just "pageQuerySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PageSize) :*: S1 ('MetaSel ('Just "pageQueryLastItem") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))))

newtype PageSize Source #

Constructors

PageSize
Fields getPageSize :: Natural

Instances

Instances details

Eq PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (==) :: PageSize -> PageSize -> Bool Source # (/=) :: PageSize -> PageSize -> Bool Source #
Num PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (+) :: PageSize -> PageSize -> PageSize Source # (-) :: PageSize -> PageSize -> PageSize Source # (*) :: PageSize -> PageSize -> PageSize Source # negate :: PageSize -> PageSize Source # abs :: PageSize -> PageSize Source # signum :: PageSize -> PageSize Source # fromInteger :: Integer -> PageSize Source #
Ord PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods compare :: PageSize -> PageSize -> Ordering Source # (<) :: PageSize -> PageSize -> Bool Source # (<=) :: PageSize -> PageSize -> Bool Source # (>) :: PageSize -> PageSize -> Bool Source # (>=) :: PageSize -> PageSize -> Bool Source # max :: PageSize -> PageSize -> PageSize Source # min :: PageSize -> PageSize -> PageSize Source #
Show PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods showsPrec :: Int -> PageSize -> ShowS Source # show :: PageSize -> String Source # showList :: [PageSize] -> ShowS Source #
Generic PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Associated Types type Rep PageSize :: Type -> Type Source # Methods from :: PageSize -> Rep PageSize x Source # to :: Rep PageSize x -> PageSize Source #
ToJSON PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods toJSON :: PageSize -> Value Source # toEncoding :: PageSize -> Encoding Source # toJSONList :: [PageSize] -> Value Source # toEncodingList :: [PageSize] -> Encoding Source #
FromJSON PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods parseJSON :: Value -> Parser PageSize Source # parseJSONList :: Value -> Parser [PageSize] Source #
Default PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods def :: PageSize Source #
ToSchema PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods declareNamedSchema :: Proxy PageSize -> Declare (Definitions Schema) NamedSchema Source #
type Rep PageSize
Instance details Defined in Control.Monad.Freer.Extras.Pagination type Rep PageSize = D1 ('MetaData "PageSize" "Control.Monad.Freer.Extras.Pagination" "freer-extras-1.1.0.0-EyJCycsLf6M9CsqRdBgpX0" 'True) (C1 ('MetaCons "PageSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))

data Page a Source #

Part of a collection.

Constructors

Page
Fields currentPageQuery :: PageQuery a The `PageQuery` which was used to request this `Page`. nextPageQuery :: Maybe (PageQuery a) The `PageQuery` to use to request the next `Page`. Nothing if we requested the last page. pageItems :: [a] Items in the current `Page`.

Instances

Instances details

Functor Page
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods fmap :: (a -> b) -> Page a -> Page b Source # (<$) :: a -> Page b -> Page a Source #
Eq a => Eq (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods (==) :: Page a -> Page a -> Bool Source # (/=) :: Page a -> Page a -> Bool Source #
Ord a => Ord (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods compare :: Page a -> Page a -> Ordering Source # (<) :: Page a -> Page a -> Bool Source # (<=) :: Page a -> Page a -> Bool Source # (>) :: Page a -> Page a -> Bool Source # (>=) :: Page a -> Page a -> Bool Source # max :: Page a -> Page a -> Page a Source # min :: Page a -> Page a -> Page a Source #
Show a => Show (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods showsPrec :: Int -> Page a -> ShowS Source # show :: Page a -> String Source # showList :: [Page a] -> ShowS Source #
Generic (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Associated Types type Rep (Page a) :: Type -> Type Source # Methods from :: Page a -> Rep (Page a) x Source # to :: Rep (Page a) x -> Page a Source #
ToJSON a => ToJSON (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods toJSON :: Page a -> Value Source # toEncoding :: Page a -> Encoding Source # toJSONList :: [Page a] -> Value Source # toEncodingList :: [Page a] -> Encoding Source #
FromJSON a => FromJSON (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods parseJSON :: Value -> Parser (Page a) Source # parseJSONList :: Value -> Parser [Page a] Source #
ToSchema a => ToSchema (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination Methods declareNamedSchema :: Proxy (Page a) -> Declare (Definitions Schema) NamedSchema Source #
type Rep (Page a)
Instance details Defined in Control.Monad.Freer.Extras.Pagination type Rep (Page a) = D1 ('MetaData "Page" "Control.Monad.Freer.Extras.Pagination" "freer-extras-1.1.0.0-EyJCycsLf6M9CsqRdBgpX0" 'False) (C1 ('MetaCons "Page" 'PrefixI 'True) (S1 ('MetaSel ('Just "currentPageQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PageQuery a)) :: (S1 ('MetaSel ('Just "nextPageQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (PageQuery a))) :: S1 ('MetaSel ('Just "pageItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]))))

newtype BlockId Source #

Block identifier (usually a hash)

Constructors

BlockId
Fields getBlockId :: ByteString

Instances

Instances details

Eq BlockId
Instance details Defined in Ledger.Blockchain Methods (==) :: BlockId -> BlockId -> Bool Source # (/=) :: BlockId -> BlockId -> Bool Source #
Ord BlockId
Instance details Defined in Ledger.Blockchain Methods compare :: BlockId -> BlockId -> Ordering Source # (<) :: BlockId -> BlockId -> Bool Source # (<=) :: BlockId -> BlockId -> Bool Source # (>) :: BlockId -> BlockId -> Bool Source # (>=) :: BlockId -> BlockId -> Bool Source # max :: BlockId -> BlockId -> BlockId Source # min :: BlockId -> BlockId -> BlockId Source #
Show BlockId
Instance details Defined in Ledger.Blockchain Methods showsPrec :: Int -> BlockId -> ShowS Source # show :: BlockId -> String Source # showList :: [BlockId] -> ShowS Source #
Generic BlockId
Instance details Defined in Ledger.Blockchain Associated Types type Rep BlockId :: Type -> Type Source # Methods from :: BlockId -> Rep BlockId x Source # to :: Rep BlockId x -> BlockId Source #
ToJSON BlockId
Instance details Defined in Ledger.Blockchain Methods toJSON :: BlockId -> Value Source # toEncoding :: BlockId -> Encoding Source # toJSONList :: [BlockId] -> Value Source # toEncodingList :: [BlockId] -> Encoding Source #
FromJSON BlockId
Instance details Defined in Ledger.Blockchain Methods parseJSON :: Value -> Parser BlockId Source # parseJSONList :: Value -> Parser [BlockId] Source #
ToSchema BlockId
Instance details Defined in Ledger.Blockchain Methods declareNamedSchema :: Proxy BlockId -> Declare (Definitions Schema) NamedSchema Source #
Pretty BlockId
Instance details Defined in Ledger.Blockchain Methods pretty :: BlockId -> Doc ann Source # prettyList :: [BlockId] -> Doc ann Source #
HasDbType BlockId Source #
Instance details Defined in Plutus.ChainIndex.DbSchema Associated Types type DbType BlockId Source # Methods toDbValue :: BlockId -> DbType BlockId Source # fromDbValue :: DbType BlockId -> BlockId Source #
type Rep BlockId
Instance details Defined in Ledger.Blockchain type Rep BlockId = D1 ('MetaData "BlockId" "Ledger.Blockchain" "plutus-ledger-1.1.0.0-JskZbcPMCdRJVHaAZ0to82" 'True) (C1 ('MetaCons "BlockId" 'PrefixI 'True) (S1 ('MetaSel ('Just "getBlockId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))
type DbType BlockId Source #
Instance details Defined in Plutus.ChainIndex.DbSchema type DbType BlockId = DbType ByteString

data Address Source #

Address with two kinds of credentials, normal and staking.

Constructors

Address
Fields addressCredential :: Credential addressStakingCredential :: Maybe StakingCredential

Instances

Instances details

Eq Address
Instance details Defined in Plutus.V1.Ledger.Address Methods (==) :: Address -> Address -> Bool Source # (/=) :: Address -> Address -> Bool Source #
Ord Address
Instance details Defined in Plutus.V1.Ledger.Address Methods compare :: Address -> Address -> Ordering Source # (<) :: Address -> Address -> Bool Source # (<=) :: Address -> Address -> Bool Source # (>) :: Address -> Address -> Bool Source # (>=) :: Address -> Address -> Bool Source # max :: Address -> Address -> Address Source # min :: Address -> Address -> Address Source #
Show Address
Instance details Defined in Plutus.V1.Ledger.Address Methods showsPrec :: Int -> Address -> ShowS Source # show :: Address -> String Source # showList :: [Address] -> ShowS Source #
Generic Address
Instance details Defined in Plutus.V1.Ledger.Address Associated Types type Rep Address :: Type -> Type Source # Methods from :: Address -> Rep Address x Source # to :: Rep Address x -> Address Source #
NFData Address
Instance details Defined in Plutus.V1.Ledger.Address Methods rnf :: Address -> () Source #
Pretty Address
Instance details Defined in Plutus.V1.Ledger.Address Methods pretty :: Address -> Doc ann Source # prettyList :: [Address] -> Doc ann Source #
UnsafeFromData Address
Instance details Defined in Plutus.V1.Ledger.Address Methods unsafeFromBuiltinData :: BuiltinData -> Address Source #
FromData Address
Instance details Defined in Plutus.V1.Ledger.Address Methods fromBuiltinData :: BuiltinData -> Maybe Address Source #
ToData Address
Instance details Defined in Plutus.V1.Ledger.Address Methods toBuiltinData :: Address -> BuiltinData Source #
Eq Address
Instance details Defined in Plutus.V1.Ledger.Address Methods (==) :: Address -> Address -> Bool Source #
Lift DefaultUni Address
Instance details Defined in Plutus.V1.Ledger.Address Methods lift :: Address -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni Address
Instance details Defined in Plutus.V1.Ledger.Address Methods typeRep :: Proxy Address -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep Address
Instance details Defined in Plutus.V1.Ledger.Address type Rep Address = D1 ('MetaData "Address" "Plutus.V1.Ledger.Address" "plutus-ledger-api-1.0.0.1-EUjexvcAhXiGIaLon6olWb" 'False) (C1 ('MetaCons "Address" 'PrefixI 'True) (S1 ('MetaSel ('Just "addressCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Credential) :*: S1 ('MetaSel ('Just "addressStakingCredential") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe StakingCredential))))

data OutputDatum Source #

The datum attached to an output: either nothing; a datum hash; or the datum itself (an "inline datum").

Constructors

NoOutputDatum
OutputDatumHash DatumHash
OutputDatum Datum

Instances

Instances details

Eq OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods (==) :: OutputDatum -> OutputDatum -> Bool Source # (/=) :: OutputDatum -> OutputDatum -> Bool Source #
Show OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods showsPrec :: Int -> OutputDatum -> ShowS Source # show :: OutputDatum -> String Source # showList :: [OutputDatum] -> ShowS Source #
Generic OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Associated Types type Rep OutputDatum :: Type -> Type Source # Methods from :: OutputDatum -> Rep OutputDatum x Source # to :: Rep OutputDatum x -> OutputDatum Source #
NFData OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods rnf :: OutputDatum -> () Source #
Pretty OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods pretty :: OutputDatum -> Doc ann Source # prettyList :: [OutputDatum] -> Doc ann Source #
UnsafeFromData OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods unsafeFromBuiltinData :: BuiltinData -> OutputDatum Source #
FromData OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods fromBuiltinData :: BuiltinData -> Maybe OutputDatum Source #
ToData OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods toBuiltinData :: OutputDatum -> BuiltinData Source #
Eq OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods (==) :: OutputDatum -> OutputDatum -> Bool Source #
Lift DefaultUni OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods lift :: OutputDatum -> RTCompile DefaultUni fun (Term TyName Name DefaultUni fun ()) Source #
Typeable DefaultUni OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx Methods typeRep :: Proxy OutputDatum -> RTCompile DefaultUni fun (Type TyName DefaultUni ()) Source #
type Rep OutputDatum
Instance details Defined in Plutus.V2.Ledger.Tx type Rep OutputDatum = D1 ('MetaData "OutputDatum" "Plutus.V2.Ledger.Tx" "plutus-ledger-api-1.0.0.1-EUjexvcAhXiGIaLon6olWb" 'False) (C1 ('MetaCons "NoOutputDatum" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "OutputDatumHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DatumHash)) :+: C1 ('MetaCons "OutputDatum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Datum))))

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

Instances details

Eq ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: ChainIndexTxOutputs -> ChainIndexTxOutputs -> Bool Source # (/=) :: ChainIndexTxOutputs -> ChainIndexTxOutputs -> Bool Source #
Show ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> ChainIndexTxOutputs -> ShowS Source # show :: ChainIndexTxOutputs -> String Source # showList :: [ChainIndexTxOutputs] -> ShowS Source #
Generic ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep ChainIndexTxOutputs :: Type -> Type Source # Methods from :: ChainIndexTxOutputs -> Rep ChainIndexTxOutputs x Source # to :: Rep ChainIndexTxOutputs x -> ChainIndexTxOutputs Source #
ToJSON ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: ChainIndexTxOutputs -> Value Source # toEncoding :: ChainIndexTxOutputs -> Encoding Source # toJSONList :: [ChainIndexTxOutputs] -> Value Source # toEncodingList :: [ChainIndexTxOutputs] -> Encoding Source #
FromJSON ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser ChainIndexTxOutputs Source # parseJSONList :: Value -> Parser [ChainIndexTxOutputs] Source #
ToSchema ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy ChainIndexTxOutputs -> Declare (Definitions Schema) NamedSchema Source #
Serialise ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types Methods encode :: ChainIndexTxOutputs -> Encoding Source # decode :: Decoder s ChainIndexTxOutputs Source # encodeList :: [ChainIndexTxOutputs] -> Encoding Source # decodeList :: Decoder s [ChainIndexTxOutputs] Source #
type Rep ChainIndexTxOutputs Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep ChainIndexTxOutputs = D1 ('MetaData "ChainIndexTxOutputs" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "InvalidTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChainIndexTxOut))) :+: C1 ('MetaCons "ValidTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ChainIndexTxOut])))

data ChainIndexTxOut Source #

Constructors

ChainIndexTxOut
Fields citoAddress :: CardanoAddress We can't use AddressInAnyEra here because of missing FromJson instance for Byron era citoValue :: Value citoDatum :: OutputDatum citoRefScript :: ReferenceScript

Instances

Instances details

Eq ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: ChainIndexTxOut -> ChainIndexTxOut -> Bool Source # (/=) :: ChainIndexTxOut -> ChainIndexTxOut -> Bool Source #
Show ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> ChainIndexTxOut -> ShowS Source # show :: ChainIndexTxOut -> String Source # showList :: [ChainIndexTxOut] -> ShowS Source #
Generic ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep ChainIndexTxOut :: Type -> Type Source # Methods from :: ChainIndexTxOut -> Rep ChainIndexTxOut x Source # to :: Rep ChainIndexTxOut x -> ChainIndexTxOut Source #
ToJSON ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: ChainIndexTxOut -> Value Source # toEncoding :: ChainIndexTxOut -> Encoding Source # toJSONList :: [ChainIndexTxOut] -> Value Source # toEncodingList :: [ChainIndexTxOut] -> Encoding Source #
FromJSON ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser ChainIndexTxOut Source # parseJSONList :: Value -> Parser [ChainIndexTxOut] Source #
ToSchema ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy ChainIndexTxOut -> Declare (Definitions Schema) NamedSchema Source #
Pretty ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: ChainIndexTxOut -> Doc ann Source # prettyList :: [ChainIndexTxOut] -> Doc ann Source #
Serialise ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types Methods encode :: ChainIndexTxOut -> Encoding Source # decode :: Decoder s ChainIndexTxOut Source # encodeList :: [ChainIndexTxOut] -> Encoding Source # decodeList :: Decoder s [ChainIndexTxOut] Source #
HasDbType ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.DbSchema Associated Types type DbType ChainIndexTxOut Source # Methods toDbValue :: ChainIndexTxOut -> DbType ChainIndexTxOut Source # fromDbValue :: DbType ChainIndexTxOut -> ChainIndexTxOut Source #
type Rep ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep ChainIndexTxOut = D1 ('MetaData "ChainIndexTxOut" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "ChainIndexTxOut" 'PrefixI 'True) ((S1 ('MetaSel ('Just "citoAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 CardanoAddress) :: S1 ('MetaSel ('Just "citoValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Value)) :: (S1 ('MetaSel ('Just "citoDatum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 OutputDatum) :*: S1 ('MetaSel ('Just "citoRefScript") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReferenceScript))))
type DbType ChainIndexTxOut Source #
Instance details Defined in Plutus.ChainIndex.DbSchema type DbType ChainIndexTxOut = DbType (Serialisable ChainIndexTxOut)

data ReferenceScript Source #

Constructors

ReferenceScriptNone
ReferenceScriptInAnyLang ScriptInAnyLang

Instances

Instances details

Eq ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: ReferenceScript -> ReferenceScript -> Bool Source # (/=) :: ReferenceScript -> ReferenceScript -> Bool Source #
Show ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> ReferenceScript -> ShowS Source # show :: ReferenceScript -> String Source # showList :: [ReferenceScript] -> ShowS Source #
Generic ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep ReferenceScript :: Type -> Type Source # Methods from :: ReferenceScript -> Rep ReferenceScript x Source # to :: Rep ReferenceScript x -> ReferenceScript Source #
ToJSON ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: ReferenceScript -> Value Source # toEncoding :: ReferenceScript -> Encoding Source # toJSONList :: [ReferenceScript] -> Value Source # toEncodingList :: [ReferenceScript] -> Encoding Source #
FromJSON ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser ReferenceScript Source # parseJSONList :: Value -> Parser [ReferenceScript] Source #
ToSchema ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy ReferenceScript -> Declare (Definitions Schema) NamedSchema Source #
Serialise ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types Methods encode :: ReferenceScript -> Encoding Source # decode :: Decoder s ReferenceScript Source # encodeList :: [ReferenceScript] -> Encoding Source # decodeList :: Decoder s [ReferenceScript] Source #
type Rep ReferenceScript Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep ReferenceScript = D1 ('MetaData "ReferenceScript" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "ReferenceScriptNone" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ReferenceScriptInAnyLang" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScriptInAnyLang)))

fromReferenceScript :: ReferenceScript -> Maybe (Versioned Script) Source #

data ChainIndexTx Source #

Constructors

ChainIndexTx

Fields

_citxTxId :: TxId
The id of this transaction.
_citxInputs :: [TxIn]
The inputs to this transaction.
_citxOutputs :: ChainIndexTxOutputs
The outputs of this transaction, ordered so they can be referenced by index.
_citxValidRange :: !SlotRange
The SlotRange during which this transaction may be validated.
_citxData :: Map DatumHash Datum
Datum objects recorded on this transaction.
_citxRedeemers :: Redeemers
Redeemers of the minting scripts.
_citxScripts :: Map ScriptHash (Versioned Script)
The scripts (validator, stake validator or minting) part of cardano tx.
_citxCardanoTx :: Maybe SomeCardanoApiTx
The full Cardano API tx which was used to populate the rest of the ChainIndexTx fields. Useful because ChainIndexTx doesn't have all the details of the tx, so we keep it as a safety net. Might be Nothing if we are in the emulator.

Instances

Instances details

Eq ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: ChainIndexTx -> ChainIndexTx -> Bool Source # (/=) :: ChainIndexTx -> ChainIndexTx -> Bool Source #
Show ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> ChainIndexTx -> ShowS Source # show :: ChainIndexTx -> String Source # showList :: [ChainIndexTx] -> ShowS Source #
Generic ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep ChainIndexTx :: Type -> Type Source # Methods from :: ChainIndexTx -> Rep ChainIndexTx x Source # to :: Rep ChainIndexTx x -> ChainIndexTx Source #
ToJSON ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: ChainIndexTx -> Value Source # toEncoding :: ChainIndexTx -> Encoding Source # toJSONList :: [ChainIndexTx] -> Value Source # toEncodingList :: [ChainIndexTx] -> Encoding Source #
FromJSON ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser ChainIndexTx Source # parseJSONList :: Value -> Parser [ChainIndexTx] Source #
ToSchema ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy ChainIndexTx -> Declare (Definitions Schema) NamedSchema Source #
Pretty ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: ChainIndexTx -> Doc ann Source # prettyList :: [ChainIndexTx] -> Doc ann Source #
Serialise ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types Methods encode :: ChainIndexTx -> Encoding Source # decode :: Decoder s ChainIndexTx Source # encodeList :: [ChainIndexTx] -> Encoding Source # decodeList :: Decoder s [ChainIndexTx] Source #
HasDbType ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.DbSchema Associated Types type DbType ChainIndexTx Source # Methods toDbValue :: ChainIndexTx -> DbType ChainIndexTx Source # fromDbValue :: DbType ChainIndexTx -> ChainIndexTx Source #
HasDbType (TxId, ChainIndexTx) Source #
Instance details Defined in Plutus.ChainIndex.DbSchema Associated Types type DbType (TxId, ChainIndexTx) Source # Methods toDbValue :: (TxId, ChainIndexTx) -> DbType (TxId, ChainIndexTx) Source # fromDbValue :: DbType (TxId, ChainIndexTx) -> (TxId, ChainIndexTx) Source #
type Rep ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep ChainIndexTx = D1 ('MetaData "ChainIndexTx" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "ChainIndexTx" 'PrefixI 'True) (((S1 ('MetaSel ('Just "_citxTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TxId) :: S1 ('MetaSel ('Just "_citxInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TxIn])) :: (S1 ('MetaSel ('Just "_citxOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChainIndexTxOutputs) :: S1 ('MetaSel ('Just "_citxValidRange") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotRange))) :: ((S1 ('MetaSel ('Just "_citxData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map DatumHash Datum)) :: S1 ('MetaSel ('Just "_citxRedeemers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Redeemers)) :: (S1 ('MetaSel ('Just "_citxScripts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map ScriptHash (Versioned Script))) :*: S1 ('MetaSel ('Just "_citxCardanoTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SomeCardanoApiTx))))))
type DbType ChainIndexTx Source #
Instance details Defined in Plutus.ChainIndex.DbSchema type DbType ChainIndexTx = DbType (Serialisable ChainIndexTx)
type DbType (TxId, ChainIndexTx) Source #
Instance details Defined in Plutus.ChainIndex.DbSchema type DbType (TxId, ChainIndexTx) = TxRow

_InvalidTx :: Prism' ChainIndexTxOutputs (Maybe ChainIndexTxOut) Source #

_ValidTx :: Prism' ChainIndexTxOutputs [ChainIndexTxOut] Source #

data Tip Source #

The tip of the chain index.

Constructors

TipAtGenesis
Tip
Fields tipSlot :: Slot Last slot tipBlockId :: BlockId Last block ID tipBlockNo :: BlockNumber Last block number

Instances

Instances details

Eq Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: Tip -> Tip -> Bool Source # (/=) :: Tip -> Tip -> Bool Source #
Ord Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: Tip -> Tip -> Ordering Source # (<) :: Tip -> Tip -> Bool Source # (<=) :: Tip -> Tip -> Bool Source # (>) :: Tip -> Tip -> Bool Source # (>=) :: Tip -> Tip -> Bool Source # max :: Tip -> Tip -> Tip Source # min :: Tip -> Tip -> Tip Source #
Show Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> Tip -> ShowS Source # show :: Tip -> String Source # showList :: [Tip] -> ShowS Source #
Generic Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep Tip :: Type -> Type Source # Methods from :: Tip -> Rep Tip x Source # to :: Rep Tip x -> Tip Source #
Semigroup Tip Source #	This mirrors the previously defined Tip which used the Last monoid definition.
Instance details Defined in Plutus.ChainIndex.Types Methods (<>) :: Tip -> Tip -> Tip Source # sconcat :: NonEmpty Tip -> Tip Source # stimes :: Integral b => b -> Tip -> Tip Source #
Monoid Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods mempty :: Tip Source # mappend :: Tip -> Tip -> Tip Source # mconcat :: [Tip] -> Tip Source #
ToJSON Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: Tip -> Value Source # toEncoding :: Tip -> Encoding Source # toJSONList :: [Tip] -> Value Source # toEncodingList :: [Tip] -> Encoding Source #
FromJSON Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser Tip Source # parseJSONList :: Value -> Parser [Tip] Source #
ToSchema Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy Tip -> Declare (Definitions Schema) NamedSchema Source #
Pretty Tip Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: Tip -> Doc ann Source # prettyList :: [Tip] -> Doc ann Source #
HasDbType Tip Source #
Instance details Defined in Plutus.ChainIndex.DbSchema Associated Types type DbType Tip Source # Methods toDbValue :: Tip -> DbType Tip Source # fromDbValue :: DbType Tip -> Tip Source #
type Rep Tip Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep Tip = D1 ('MetaData "Tip" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "TipAtGenesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Tip" 'PrefixI 'True) (S1 ('MetaSel ('Just "tipSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Slot) :: (S1 ('MetaSel ('Just "tipBlockId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BlockId) :: S1 ('MetaSel ('Just "tipBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BlockNumber))))
type DbType Tip Source #
Instance details Defined in Plutus.ChainIndex.DbSchema type DbType Tip = Maybe TipRow

newtype BlockNumber Source #

Constructors

BlockNumber
Fields unBlockNumber :: Word64

Instances

Instances details

Enum BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods succ :: BlockNumber -> BlockNumber Source # pred :: BlockNumber -> BlockNumber Source # toEnum :: Int -> BlockNumber Source # fromEnum :: BlockNumber -> Int Source # enumFrom :: BlockNumber -> [BlockNumber] Source # enumFromThen :: BlockNumber -> BlockNumber -> [BlockNumber] Source # enumFromTo :: BlockNumber -> BlockNumber -> [BlockNumber] Source # enumFromThenTo :: BlockNumber -> BlockNumber -> BlockNumber -> [BlockNumber] Source #
Eq BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: BlockNumber -> BlockNumber -> Bool Source # (/=) :: BlockNumber -> BlockNumber -> Bool Source #
Integral BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods quot :: BlockNumber -> BlockNumber -> BlockNumber Source # rem :: BlockNumber -> BlockNumber -> BlockNumber Source # div :: BlockNumber -> BlockNumber -> BlockNumber Source # mod :: BlockNumber -> BlockNumber -> BlockNumber Source # quotRem :: BlockNumber -> BlockNumber -> (BlockNumber, BlockNumber) Source # divMod :: BlockNumber -> BlockNumber -> (BlockNumber, BlockNumber) Source # toInteger :: BlockNumber -> Integer Source #
Num BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (+) :: BlockNumber -> BlockNumber -> BlockNumber Source # (-) :: BlockNumber -> BlockNumber -> BlockNumber Source # (*) :: BlockNumber -> BlockNumber -> BlockNumber Source # negate :: BlockNumber -> BlockNumber Source # abs :: BlockNumber -> BlockNumber Source # signum :: BlockNumber -> BlockNumber Source # fromInteger :: Integer -> BlockNumber Source #
Ord BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: BlockNumber -> BlockNumber -> Ordering Source # (<) :: BlockNumber -> BlockNumber -> Bool Source # (<=) :: BlockNumber -> BlockNumber -> Bool Source # (>) :: BlockNumber -> BlockNumber -> Bool Source # (>=) :: BlockNumber -> BlockNumber -> Bool Source # max :: BlockNumber -> BlockNumber -> BlockNumber Source # min :: BlockNumber -> BlockNumber -> BlockNumber Source #
Real BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toRational :: BlockNumber -> Rational Source #
Show BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> BlockNumber -> ShowS Source # show :: BlockNumber -> String Source # showList :: [BlockNumber] -> ShowS Source #
Generic BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep BlockNumber :: Type -> Type Source # Methods from :: BlockNumber -> Rep BlockNumber x Source # to :: Rep BlockNumber x -> BlockNumber Source #
ToJSON BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: BlockNumber -> Value Source # toEncoding :: BlockNumber -> Encoding Source # toJSONList :: [BlockNumber] -> Value Source # toEncodingList :: [BlockNumber] -> Encoding Source #
FromJSON BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser BlockNumber Source # parseJSONList :: Value -> Parser [BlockNumber] Source #
ToSchema BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy BlockNumber -> Declare (Definitions Schema) NamedSchema Source #
Pretty BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: BlockNumber -> Doc ann Source # prettyList :: [BlockNumber] -> Doc ann Source #
HasDbType BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.DbSchema Associated Types type DbType BlockNumber Source # Methods toDbValue :: BlockNumber -> DbType BlockNumber Source # fromDbValue :: DbType BlockNumber -> BlockNumber Source #
type Rep BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep BlockNumber = D1 ('MetaData "BlockNumber" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'True) (C1 ('MetaCons "BlockNumber" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlockNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))
type DbType BlockNumber Source #
Instance details Defined in Plutus.ChainIndex.DbSchema type DbType BlockNumber = Word64

citxCardanoTx :: Lens' ChainIndexTx (Maybe SomeCardanoApiTx) Source #

citxData :: Lens' ChainIndexTx (Map DatumHash Datum) Source #

citxInputs :: Lens' ChainIndexTx [TxIn] 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 #

blockId :: Block -> BlockId Source #

Compute a hash of the block's contents.

data Point Source #

When performing a rollback the chain sync protocol does not provide a block number where to resume from.

Constructors

PointAtGenesis
Point
Fields pointSlot :: Slot Slot number pointBlockId :: BlockId Block number

Instances

Instances details

Eq Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: Point -> Point -> Bool Source # (/=) :: Point -> Point -> Bool Source #
Ord Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: Point -> Point -> Ordering Source # (<) :: Point -> Point -> Bool Source # (<=) :: Point -> Point -> Bool Source # (>) :: Point -> Point -> Bool Source # (>=) :: Point -> Point -> Bool Source # max :: Point -> Point -> Point Source # min :: Point -> Point -> Point Source #
Show Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> Point -> ShowS Source # show :: Point -> String Source # showList :: [Point] -> ShowS Source #
Generic Point Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep Point :: Type -> Type Source # Methods from :: Point -> Rep Point x Source # to :: Rep Point x -> Point Source #
Semigroup Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (<>) :: Point -> Point -> Point Source # sconcat :: NonEmpty Point -> Point Source # stimes :: Integral b => b -> Point -> Point Source #
Monoid Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods mempty :: Point Source # mappend :: Point -> Point -> Point Source # mconcat :: [Point] -> Point Source #
ToJSON Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: Point -> Value Source # toEncoding :: Point -> Encoding Source # toJSONList :: [Point] -> Value Source # toEncodingList :: [Point] -> Encoding Source #
FromJSON Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser Point Source # parseJSONList :: Value -> Parser [Point] Source #
Pretty Point Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: Point -> Doc ann Source # prettyList :: [Point] -> Doc ann Source #
type Rep Point Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep Point = D1 ('MetaData "Point" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" '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 _tobUnspentOutputs :: Set TxOutRef Outputs newly added by the transaction(s) _tobSpentOutputs :: Map TxOutRef TxId Outputs spent by the transaction(s) along with the tx id that spent it

Instances

Instances details

Eq TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxOutBalance -> TxOutBalance -> Bool Source # (/=) :: TxOutBalance -> TxOutBalance -> Bool Source #
Show TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxOutBalance -> ShowS Source # show :: TxOutBalance -> String Source # showList :: [TxOutBalance] -> ShowS Source #
Generic TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep TxOutBalance :: Type -> Type Source # Methods from :: TxOutBalance -> Rep TxOutBalance x Source # to :: Rep TxOutBalance x -> TxOutBalance Source #
Semigroup TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (<>) :: TxOutBalance -> TxOutBalance -> TxOutBalance Source # sconcat :: NonEmpty TxOutBalance -> TxOutBalance Source # stimes :: Integral b => b -> TxOutBalance -> TxOutBalance Source #
Monoid TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods mempty :: TxOutBalance Source # mappend :: TxOutBalance -> TxOutBalance -> TxOutBalance Source # mconcat :: [TxOutBalance] -> TxOutBalance Source #
ToJSON TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: TxOutBalance -> Value Source # toEncoding :: TxOutBalance -> Encoding Source # toJSONList :: [TxOutBalance] -> Value Source # toEncodingList :: [TxOutBalance] -> Encoding Source #
FromJSON TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser TxOutBalance Source # parseJSONList :: Value -> Parser [TxOutBalance] Source #
type Rep TxOutBalance Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep TxOutBalance = D1 ('MetaData "TxOutBalance" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "TxOutBalance" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tobUnspentOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set TxOutRef)) :*: S1 ('MetaSel ('Just "_tobSpentOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Map TxOutRef TxId))))

data TxConfirmedState Source #

Constructors

TxConfirmedState
Fields timesConfirmed :: Sum Int blockAdded :: Last BlockNumber validity :: Last TxValidity

Instances

Instances details

Eq TxConfirmedState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxConfirmedState -> TxConfirmedState -> Bool Source # (/=) :: TxConfirmedState -> TxConfirmedState -> Bool Source #
Show TxConfirmedState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxConfirmedState -> ShowS Source # show :: TxConfirmedState -> String Source # showList :: [TxConfirmedState] -> ShowS Source #
Generic TxConfirmedState Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep TxConfirmedState :: Type -> Type Source # Methods from :: TxConfirmedState -> Rep TxConfirmedState x Source # to :: Rep TxConfirmedState x -> TxConfirmedState Source #
Semigroup TxConfirmedState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (<>) :: TxConfirmedState -> TxConfirmedState -> TxConfirmedState Source # sconcat :: NonEmpty TxConfirmedState -> TxConfirmedState Source # stimes :: Integral b => b -> TxConfirmedState -> TxConfirmedState Source #
Monoid TxConfirmedState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods mempty :: TxConfirmedState Source # mappend :: TxConfirmedState -> TxConfirmedState -> TxConfirmedState Source # mconcat :: [TxConfirmedState] -> TxConfirmedState Source #
type Rep TxConfirmedState Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep TxConfirmedState = D1 ('MetaData "TxConfirmedState" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "TxConfirmedState" 'PrefixI 'True) (S1 ('MetaSel ('Just "timesConfirmed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sum Int)) :: (S1 ('MetaSel ('Just "blockAdded") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Last BlockNumber)) :: S1 ('MetaSel ('Just "validity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Last TxValidity)))))

data TxIdState Source #

Constructors

TxIdState
Fields txnsConfirmed :: Map TxId TxConfirmedState Number of times this transaction has been added as well as other necessary metadata. txnsDeleted :: Map TxId (Sum Int) Number of times this transaction has been deleted.

Instances

Instances details

Eq TxIdState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxIdState -> TxIdState -> Bool Source # (/=) :: TxIdState -> TxIdState -> Bool Source #
Show TxIdState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxIdState -> ShowS Source # show :: TxIdState -> String Source # showList :: [TxIdState] -> ShowS Source #
Generic TxIdState Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep TxIdState :: Type -> Type Source # Methods from :: TxIdState -> Rep TxIdState x Source # to :: Rep TxIdState x -> TxIdState Source #
Semigroup TxIdState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (<>) :: TxIdState -> TxIdState -> TxIdState Source # sconcat :: NonEmpty TxIdState -> TxIdState Source # stimes :: Integral b => b -> TxIdState -> TxIdState Source #
Monoid TxIdState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods mempty :: TxIdState Source # mappend :: TxIdState -> TxIdState -> TxIdState Source # mconcat :: [TxIdState] -> TxIdState Source #
type Rep TxIdState Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep TxIdState = D1 ('MetaData "TxIdState" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" '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 `TxIdState` was in a ... state ... that we didn't know how to decode in `transactionStatus`.
TxOutBalanceStateInvalid BlockNumber TxOutRef TxOutBalance	We couldn't return the status because the `TxOutBalance` does not contain the target tx output.
InvalidRollbackAttempt BlockNumber TxId TxIdState

Instances

Instances details

Eq TxStatusFailure Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxStatusFailure -> TxStatusFailure -> Bool Source # (/=) :: TxStatusFailure -> TxStatusFailure -> Bool Source #
Show TxStatusFailure Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxStatusFailure -> ShowS Source # show :: TxStatusFailure -> String Source # showList :: [TxStatusFailure] -> ShowS Source #

data Diagnostics Source #

Constructors

Diagnostics
Fields numTransactions :: Integer numScripts :: Integer numAddresses :: Integer numAssetClasses :: Integer numUnspentOutputs :: Int numUnmatchedInputs :: Int someTransactions :: [TxId] unspentTxOuts :: [ChainIndexTxOut]

Instances

Instances details

Eq Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: Diagnostics -> Diagnostics -> Bool Source # (/=) :: Diagnostics -> Diagnostics -> Bool Source #
Show Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> Diagnostics -> ShowS Source # show :: Diagnostics -> String Source # showList :: [Diagnostics] -> ShowS Source #
Generic Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep Diagnostics :: Type -> Type Source # Methods from :: Diagnostics -> Rep Diagnostics x Source # to :: Rep Diagnostics x -> Diagnostics Source #
ToJSON Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: Diagnostics -> Value Source # toEncoding :: Diagnostics -> Encoding Source # toJSONList :: [Diagnostics] -> Value Source # toEncodingList :: [Diagnostics] -> Encoding Source #
FromJSON Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser Diagnostics Source # parseJSONList :: Value -> Parser [Diagnostics] Source #
ToSchema Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types Methods declareNamedSchema :: Proxy Diagnostics -> Declare (Definitions Schema) NamedSchema Source #
type Rep Diagnostics Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep Diagnostics = D1 ('MetaData "Diagnostics" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "Diagnostics" 'PrefixI 'True) (((S1 ('MetaSel ('Just "numTransactions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: S1 ('MetaSel ('Just "numScripts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "numAddresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer) :: S1 ('MetaSel ('Just "numAssetClasses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) :: ((S1 ('MetaSel ('Just "numUnspentOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "numUnmatchedInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "someTransactions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TxId]) :*: S1 ('MetaSel ('Just "unspentTxOuts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ChainIndexTxOut])))))

data TxOutState Source #

Constructors

Spent TxId
Unspent

Instances

Instances details

Eq TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxOutState -> TxOutState -> Bool Source # (/=) :: TxOutState -> TxOutState -> Bool Source #
Ord TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: TxOutState -> TxOutState -> Ordering Source # (<) :: TxOutState -> TxOutState -> Bool Source # (<=) :: TxOutState -> TxOutState -> Bool Source # (>) :: TxOutState -> TxOutState -> Bool Source # (>=) :: TxOutState -> TxOutState -> Bool Source # max :: TxOutState -> TxOutState -> TxOutState Source # min :: TxOutState -> TxOutState -> TxOutState Source #
Show TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxOutState -> ShowS Source # show :: TxOutState -> String Source # showList :: [TxOutState] -> ShowS Source #
Generic TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep TxOutState :: Type -> Type Source # Methods from :: TxOutState -> Rep TxOutState x Source # to :: Rep TxOutState x -> TxOutState Source #
ToJSON TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: TxOutState -> Value Source # toEncoding :: TxOutState -> Encoding Source # toJSONList :: [TxOutState] -> Value Source # toEncodingList :: [TxOutState] -> Encoding Source #
FromJSON TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser TxOutState Source # parseJSONList :: Value -> Parser [TxOutState] Source #
Pretty TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: TxOutState -> Doc ann Source # prettyList :: [TxOutState] -> Doc ann Source #
type Rep TxOutState Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep TxOutState = D1 ('MetaData "TxOutState" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "Spent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TxId)) :+: C1 ('MetaCons "Unspent" 'PrefixI 'False) (U1 :: Type -> Type))

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

Instances details

Functor RollbackState Source #
Instance details Defined in Plutus.ChainIndex.Types Methods fmap :: (a -> b) -> RollbackState a -> RollbackState b Source # (<$) :: a -> RollbackState b -> RollbackState a Source #
Eq a => Eq (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: RollbackState a -> RollbackState a -> Bool Source # (/=) :: RollbackState a -> RollbackState a -> Bool Source #
Ord a => Ord (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: RollbackState a -> RollbackState a -> Ordering Source # (<) :: RollbackState a -> RollbackState a -> Bool Source # (<=) :: RollbackState a -> RollbackState a -> Bool Source # (>) :: RollbackState a -> RollbackState a -> Bool Source # (>=) :: RollbackState a -> RollbackState a -> Bool Source # max :: RollbackState a -> RollbackState a -> RollbackState a Source # min :: RollbackState a -> RollbackState a -> RollbackState a Source #
Show a => Show (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> RollbackState a -> ShowS Source # show :: RollbackState a -> String Source # showList :: [RollbackState a] -> ShowS Source #
Generic (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep (RollbackState a) :: Type -> Type Source # Methods from :: RollbackState a -> Rep (RollbackState a) x Source # to :: Rep (RollbackState a) x -> RollbackState a Source #
ToJSON a => ToJSON (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: RollbackState a -> Value Source # toEncoding :: RollbackState a -> Encoding Source # toJSONList :: [RollbackState a] -> Value Source # toEncodingList :: [RollbackState a] -> Encoding Source #
FromJSON a => FromJSON (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser (RollbackState a) Source # parseJSONList :: Value -> Parser [RollbackState a] Source #
Show a => Pretty (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: RollbackState a -> Doc ann Source # prettyList :: [RollbackState a] -> Doc ann Source #
MeetSemiLattice a => MeetSemiLattice (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (/\) :: RollbackState a -> RollbackState a -> RollbackState a Source #
type Rep (RollbackState a) Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep (RollbackState a) = D1 ('MetaData "RollbackState" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "Unknown" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TentativelyConfirmed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Depth) :: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TxValidity) :: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a))) :+: C1 ('MetaCons "Committed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TxValidity) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a))))

type TxStatus = RollbackState () Source #

The status of a Cardano transaction

newtype Depth Source #

How many blocks deep the tx is on the chain

Constructors

Depth
Fields unDepth :: Int

Instances

Instances details

Enum Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods succ :: Depth -> Depth Source # pred :: Depth -> Depth Source # toEnum :: Int -> Depth Source # fromEnum :: Depth -> Int Source # enumFrom :: Depth -> [Depth] Source # enumFromThen :: Depth -> Depth -> [Depth] Source # enumFromTo :: Depth -> Depth -> [Depth] Source # enumFromThenTo :: Depth -> Depth -> Depth -> [Depth] Source #
Eq Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: Depth -> Depth -> Bool Source # (/=) :: Depth -> Depth -> Bool Source #
Integral Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods quot :: Depth -> Depth -> Depth Source # rem :: Depth -> Depth -> Depth Source # div :: Depth -> Depth -> Depth Source # mod :: Depth -> Depth -> Depth Source # quotRem :: Depth -> Depth -> (Depth, Depth) Source # divMod :: Depth -> Depth -> (Depth, Depth) Source # toInteger :: Depth -> Integer Source #
Num Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (+) :: Depth -> Depth -> Depth Source # (-) :: Depth -> Depth -> Depth Source # (*) :: Depth -> Depth -> Depth Source # negate :: Depth -> Depth Source # abs :: Depth -> Depth Source # signum :: Depth -> Depth Source # fromInteger :: Integer -> Depth Source #
Ord Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: Depth -> Depth -> Ordering Source # (<) :: Depth -> Depth -> Bool Source # (<=) :: Depth -> Depth -> Bool Source # (>) :: Depth -> Depth -> Bool Source # (>=) :: Depth -> Depth -> Bool Source # max :: Depth -> Depth -> Depth Source # min :: Depth -> Depth -> Depth Source #
Real Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toRational :: Depth -> Rational Source #
Show Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> Depth -> ShowS Source # show :: Depth -> String Source # showList :: [Depth] -> ShowS Source #
Generic Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep Depth :: Type -> Type Source # Methods from :: Depth -> Rep Depth x Source # to :: Rep Depth x -> Depth Source #
ToJSON Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: Depth -> Value Source # toEncoding :: Depth -> Encoding Source # toJSONList :: [Depth] -> Value Source # toEncodingList :: [Depth] -> Encoding Source #
FromJSON Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser Depth Source # parseJSONList :: Value -> Parser [Depth] Source #
Pretty Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: Depth -> Doc ann Source # prettyList :: [Depth] -> Doc ann Source #
MeetSemiLattice Depth Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (/\) :: Depth -> Depth -> Depth Source #
type Rep Depth Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep Depth = D1 ('MetaData "Depth" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'True) (C1 ('MetaCons "Depth" 'PrefixI 'True) (S1 ('MetaSel ('Just "unDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data TxValidity Source #

Validity of a transaction that has been added to the ledger

Constructors

TxValid
TxInvalid
UnknownValidity

Instances

Instances details

Eq TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxValidity -> TxValidity -> Bool Source # (/=) :: TxValidity -> TxValidity -> Bool Source #
Ord TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods compare :: TxValidity -> TxValidity -> Ordering Source # (<) :: TxValidity -> TxValidity -> Bool Source # (<=) :: TxValidity -> TxValidity -> Bool Source # (>) :: TxValidity -> TxValidity -> Bool Source # (>=) :: TxValidity -> TxValidity -> Bool Source # max :: TxValidity -> TxValidity -> TxValidity Source # min :: TxValidity -> TxValidity -> TxValidity Source #
Show TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxValidity -> ShowS Source # show :: TxValidity -> String Source # showList :: [TxValidity] -> ShowS Source #
Generic TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep TxValidity :: Type -> Type Source # Methods from :: TxValidity -> Rep TxValidity x Source # to :: Rep TxValidity x -> TxValidity Source #
ToJSON TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: TxValidity -> Value Source # toEncoding :: TxValidity -> Encoding Source # toJSONList :: [TxValidity] -> Value Source # toEncodingList :: [TxValidity] -> Encoding Source #
FromJSON TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser TxValidity Source # parseJSONList :: Value -> Parser [TxValidity] Source #
Pretty TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods pretty :: TxValidity -> Doc ann Source # prettyList :: [TxValidity] -> Doc ann Source #
MeetSemiLattice TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (/\) :: TxValidity -> TxValidity -> TxValidity Source #
type Rep TxValidity Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep TxValidity = D1 ('MetaData "TxValidity" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "TxValid" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TxInvalid" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "UnknownValidity" 'PrefixI 'False) (U1 :: Type -> Type)))

_PointAtGenesis :: Prism' Point () Source #

_Point :: Prism' Point (Slot, BlockId) Source #

tipAsPoint :: Tip -> Point Source #

pointsToTip :: Point -> Tip -> Bool 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 _tubUnspentOutputs :: Set TxOutRef Outputs newly added by the transaction(s) _tubUnmatchedSpentInputs :: Set TxOutRef Outputs spent by the transaction(s) that have no matching unspent output

Instances

Instances details

Eq TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (==) :: TxUtxoBalance -> TxUtxoBalance -> Bool Source # (/=) :: TxUtxoBalance -> TxUtxoBalance -> Bool Source #
Show TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxUtxoBalance -> ShowS Source # show :: TxUtxoBalance -> String Source # showList :: [TxUtxoBalance] -> ShowS Source #
Generic TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Associated Types type Rep TxUtxoBalance :: Type -> Type Source # Methods from :: TxUtxoBalance -> Rep TxUtxoBalance x Source # to :: Rep TxUtxoBalance x -> TxUtxoBalance Source #
Semigroup TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods (<>) :: TxUtxoBalance -> TxUtxoBalance -> TxUtxoBalance Source # sconcat :: NonEmpty TxUtxoBalance -> TxUtxoBalance Source # stimes :: Integral b => b -> TxUtxoBalance -> TxUtxoBalance Source #
Monoid TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods mempty :: TxUtxoBalance Source # mappend :: TxUtxoBalance -> TxUtxoBalance -> TxUtxoBalance Source # mconcat :: [TxUtxoBalance] -> TxUtxoBalance Source #
ToJSON TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods toJSON :: TxUtxoBalance -> Value Source # toEncoding :: TxUtxoBalance -> Encoding Source # toJSONList :: [TxUtxoBalance] -> Value Source # toEncodingList :: [TxUtxoBalance] -> Encoding Source #
FromJSON TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods parseJSON :: Value -> Parser TxUtxoBalance Source # parseJSONList :: Value -> Parser [TxUtxoBalance] Source #
Serialise TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types Methods encode :: TxUtxoBalance -> Encoding Source # decode :: Decoder s TxUtxoBalance Source # encodeList :: [TxUtxoBalance] -> Encoding Source # decodeList :: Decoder s [TxUtxoBalance] Source #
type Rep TxUtxoBalance Source #
Instance details Defined in Plutus.ChainIndex.Types type Rep TxUtxoBalance = D1 ('MetaData "TxUtxoBalance" "Plutus.ChainIndex.Types" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "TxUtxoBalance" 'PrefixI 'True) (S1 ('MetaSel ('Just "_tubUnspentOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set TxOutRef)) :*: S1 ('MetaSel ('Just "_tubUnmatchedSpentInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Set TxOutRef))))

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 blockTip :: Tip blockTxs :: [(ChainIndexTx, TxProcessOption)]

Instances

Instances details

Show ChainSyncBlock Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> ChainSyncBlock -> ShowS Source # show :: ChainSyncBlock -> String Source # showList :: [ChainSyncBlock] -> ShowS Source #

newtype TxProcessOption Source #

User-customizable options to process a transaction. See #73 for more motivations.

Constructors

TxProcessOption
Fields tpoStoreTx :: Bool Should the chain index store this transaction or not. If not, only handle the UTXOs. This, for example, allows applications to skip unwanted pre-Alonzo transactions.

Instances

Instances details

Show TxProcessOption Source #
Instance details Defined in Plutus.ChainIndex.Types Methods showsPrec :: Int -> TxProcessOption -> ShowS Source # show :: TxProcessOption -> String Source # showList :: [TxProcessOption] -> ShowS Source #
Default TxProcessOption Source #
Instance details Defined in Plutus.ChainIndex.Types Methods def :: TxProcessOption Source #

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 `expectedTip` because the tip at that position was different
Fields foundTip :: Tip targetPoint :: Point
OldPointNotFound Point	Unable to find the old tip

Instances

Instances details

Eq RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods (==) :: RollbackFailed -> RollbackFailed -> Bool Source # (/=) :: RollbackFailed -> RollbackFailed -> Bool Source #
Ord RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods compare :: RollbackFailed -> RollbackFailed -> Ordering Source # (<) :: RollbackFailed -> RollbackFailed -> Bool Source # (<=) :: RollbackFailed -> RollbackFailed -> Bool Source # (>) :: RollbackFailed -> RollbackFailed -> Bool Source # (>=) :: RollbackFailed -> RollbackFailed -> Bool Source # max :: RollbackFailed -> RollbackFailed -> RollbackFailed Source # min :: RollbackFailed -> RollbackFailed -> RollbackFailed Source #
Show RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods showsPrec :: Int -> RollbackFailed -> ShowS Source # show :: RollbackFailed -> String Source # showList :: [RollbackFailed] -> ShowS Source #
Generic RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Associated Types type Rep RollbackFailed :: Type -> Type Source # Methods from :: RollbackFailed -> Rep RollbackFailed x Source # to :: Rep RollbackFailed x -> RollbackFailed Source #
ToJSON RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods toJSON :: RollbackFailed -> Value Source # toEncoding :: RollbackFailed -> Encoding Source # toJSONList :: [RollbackFailed] -> Value Source # toEncodingList :: [RollbackFailed] -> Encoding Source #
FromJSON RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods parseJSON :: Value -> Parser RollbackFailed Source # parseJSONList :: Value -> Parser [RollbackFailed] Source #
Pretty RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods pretty :: RollbackFailed -> Doc ann Source # prettyList :: [RollbackFailed] -> Doc ann Source #
type Rep RollbackFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError type Rep RollbackFailed = D1 ('MetaData "RollbackFailed" "Plutus.ChainIndex.ChainIndexError" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "RollbackNoTip" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "TipMismatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "foundTip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tip) :*: S1 ('MetaSel ('Just "targetPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Point)) :+: C1 ('MetaCons "OldPointNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Point))))

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 `_usTip` field of the argument was 'Last Nothing'

Instances

Instances details

Eq InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods (==) :: InsertUtxoFailed -> InsertUtxoFailed -> Bool Source # (/=) :: InsertUtxoFailed -> InsertUtxoFailed -> Bool Source #
Ord InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods compare :: InsertUtxoFailed -> InsertUtxoFailed -> Ordering Source # (<) :: InsertUtxoFailed -> InsertUtxoFailed -> Bool Source # (<=) :: InsertUtxoFailed -> InsertUtxoFailed -> Bool Source # (>) :: InsertUtxoFailed -> InsertUtxoFailed -> Bool Source # (>=) :: InsertUtxoFailed -> InsertUtxoFailed -> Bool Source # max :: InsertUtxoFailed -> InsertUtxoFailed -> InsertUtxoFailed Source # min :: InsertUtxoFailed -> InsertUtxoFailed -> InsertUtxoFailed Source #
Show InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods showsPrec :: Int -> InsertUtxoFailed -> ShowS Source # show :: InsertUtxoFailed -> String Source # showList :: [InsertUtxoFailed] -> ShowS Source #
Generic InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Associated Types type Rep InsertUtxoFailed :: Type -> Type Source # Methods from :: InsertUtxoFailed -> Rep InsertUtxoFailed x Source # to :: Rep InsertUtxoFailed x -> InsertUtxoFailed Source #
ToJSON InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods toJSON :: InsertUtxoFailed -> Value Source # toEncoding :: InsertUtxoFailed -> Encoding Source # toJSONList :: [InsertUtxoFailed] -> Value Source # toEncodingList :: [InsertUtxoFailed] -> Encoding Source #
FromJSON InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods parseJSON :: Value -> Parser InsertUtxoFailed Source # parseJSONList :: Value -> Parser [InsertUtxoFailed] Source #
Pretty InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods pretty :: InsertUtxoFailed -> Doc ann Source # prettyList :: [InsertUtxoFailed] -> Doc ann Source #
type Rep InsertUtxoFailed Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError type Rep InsertUtxoFailed = D1 ('MetaData "InsertUtxoFailed" "Plutus.ChainIndex.ChainIndexError" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "DuplicateBlock" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tip)) :+: C1 ('MetaCons "InsertUtxoNoTip" 'PrefixI 'False) (U1 :: Type -> Type))

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

Instances

Instances details

Eq ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods (==) :: ChainIndexError -> ChainIndexError -> Bool Source # (/=) :: ChainIndexError -> ChainIndexError -> Bool Source #
Show ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods showsPrec :: Int -> ChainIndexError -> ShowS Source # show :: ChainIndexError -> String Source # showList :: [ChainIndexError] -> ShowS Source #
Generic ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Associated Types type Rep ChainIndexError :: Type -> Type Source # Methods from :: ChainIndexError -> Rep ChainIndexError x Source # to :: Rep ChainIndexError x -> ChainIndexError Source #
ToJSON ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods toJSON :: ChainIndexError -> Value Source # toEncoding :: ChainIndexError -> Encoding Source # toJSONList :: [ChainIndexError] -> Value Source # toEncodingList :: [ChainIndexError] -> Encoding Source #
FromJSON ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods parseJSON :: Value -> Parser ChainIndexError Source # parseJSONList :: Value -> Parser [ChainIndexError] Source #
Pretty ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError Methods pretty :: ChainIndexError -> Doc ann Source # prettyList :: [ChainIndexError] -> Doc ann Source #
type Rep ChainIndexError Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexError type Rep ChainIndexError = D1 ('MetaData "ChainIndexError" "Plutus.ChainIndex.ChainIndexError" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) ((C1 ('MetaCons "InsertionFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InsertUtxoFailed)) :+: C1 ('MetaCons "RollbackFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RollbackFailed))) :+: (C1 ('MetaCons "ResumeNotSupported" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "QueryFailedNoTip" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "BeamEffectError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BeamError)))))

txOuts :: ChainIndexTx -> [ChainIndexTxOut] Source #

Get tx outputs from tx.

txOutRefs :: ChainIndexTx -> [TxOutRef] Source #

Get tx output references from tx.

txOutsWithRef :: ChainIndexTx -> [(ChainIndexTxOut, TxOutRef)] Source #

Get tx output references and tx outputs from tx.

txOutRefMap :: ChainIndexTx -> Map TxOutRef (ChainIndexTxOut, ChainIndexTx) Source #

Get Map of tx outputs references to tx.

txOutRefMapForAddr :: CardanoAddress -> ChainIndexTx -> Map TxOutRef (ChainIndexTxOut, ChainIndexTx) Source #

Get Map of tx outputs from tx for a specific address.

validityFromChainIndex :: ChainIndexTx -> TxValidity Source #

fromOnChainTx :: OnChainTx -> ChainIndexTx Source #

Convert a OnChainTx to a ChainIndexTx. An invalid OnChainTx will not produce any ChainIndexTx outputs and the collateral inputs of the OnChainTx will be the inputs of the ChainIndexTx.

txRedeemersWithHash :: ChainIndexTx -> Map RedeemerHash Redeemer 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 -> Credential -> ChainIndexQueryEffect UtxosResponse	Unspent outputs located at addresses with the given credential.
UnspentTxOutSetAtAddress :: PageQuery TxOutRef -> Credential -> 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 -> Credential -> ChainIndexQueryEffect (QueryResponse [Datum])	get the datums located at addresses with the given credential.
UtxoSetWithCurrency :: PageQuery TxOutRef -> AssetClass -> ChainIndexQueryEffect UtxosResponse	Unspent outputs containing a specific currency (`AssetClass`). 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 -> Credential -> ChainIndexQueryEffect TxosResponse	Outputs located at addresses with the given credential.
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 -> Credential -> Eff effs UtxosResponse Source #

unspentTxOutSetAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> Credential -> Eff effs (QueryResponse [(TxOutRef, DecoratedTxOut)]) Source #

datumsAtAddress :: forall effs. Member ChainIndexQueryEffect effs => PageQuery TxOutRef -> Credential -> 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 -> Credential -> 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

Instances details

Eq InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods (==) :: InsertUtxoPosition -> InsertUtxoPosition -> Bool Source # (/=) :: InsertUtxoPosition -> InsertUtxoPosition -> Bool Source #
Ord InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods compare :: InsertUtxoPosition -> InsertUtxoPosition -> Ordering Source # (<) :: InsertUtxoPosition -> InsertUtxoPosition -> Bool Source # (<=) :: InsertUtxoPosition -> InsertUtxoPosition -> Bool Source # (>) :: InsertUtxoPosition -> InsertUtxoPosition -> Bool Source # (>=) :: InsertUtxoPosition -> InsertUtxoPosition -> Bool Source # max :: InsertUtxoPosition -> InsertUtxoPosition -> InsertUtxoPosition Source # min :: InsertUtxoPosition -> InsertUtxoPosition -> InsertUtxoPosition Source #
Show InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods showsPrec :: Int -> InsertUtxoPosition -> ShowS Source # show :: InsertUtxoPosition -> String Source # showList :: [InsertUtxoPosition] -> ShowS Source #
Generic InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Associated Types type Rep InsertUtxoPosition :: Type -> Type Source # Methods from :: InsertUtxoPosition -> Rep InsertUtxoPosition x Source # to :: Rep InsertUtxoPosition x -> InsertUtxoPosition Source #
ToJSON InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods toJSON :: InsertUtxoPosition -> Value Source # toEncoding :: InsertUtxoPosition -> Encoding Source # toJSONList :: [InsertUtxoPosition] -> Value Source # toEncodingList :: [InsertUtxoPosition] -> Encoding Source #
FromJSON InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods parseJSON :: Value -> Parser InsertUtxoPosition Source # parseJSONList :: Value -> Parser [InsertUtxoPosition] Source #
Pretty InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods pretty :: InsertUtxoPosition -> Doc ann Source # prettyList :: [InsertUtxoPosition] -> Doc ann Source #
type Rep InsertUtxoPosition Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog type Rep InsertUtxoPosition = D1 ('MetaData "InsertUtxoPosition" "Plutus.ChainIndex.ChainIndexLog" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "InsertAtEnd" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InsertBeforeEnd" 'PrefixI 'False) (U1 :: Type -> Type))

data ChainIndexLog Source #

Constructors

InsertionSuccess Tip InsertUtxoPosition
ConversionFailed FromCardanoError
RollbackSuccess Tip
Err ChainIndexError
TxNotFound TxId
TxOutNotFound TxOutRef
TipIsGenesis
NoDatumScriptAddr ChainIndexTxOut
BeamLogItem BeamLog

Instances

Instances details

Eq ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods (==) :: ChainIndexLog -> ChainIndexLog -> Bool Source # (/=) :: ChainIndexLog -> ChainIndexLog -> Bool Source #
Show ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods showsPrec :: Int -> ChainIndexLog -> ShowS Source # show :: ChainIndexLog -> String Source # showList :: [ChainIndexLog] -> ShowS Source #
Generic ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Associated Types type Rep ChainIndexLog :: Type -> Type Source # Methods from :: ChainIndexLog -> Rep ChainIndexLog x Source # to :: Rep ChainIndexLog x -> ChainIndexLog Source #
ToJSON ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods toJSON :: ChainIndexLog -> Value Source # toEncoding :: ChainIndexLog -> Encoding Source # toJSONList :: [ChainIndexLog] -> Value Source # toEncodingList :: [ChainIndexLog] -> Encoding Source #
FromJSON ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods parseJSON :: Value -> Parser ChainIndexLog Source # parseJSONList :: Value -> Parser [ChainIndexLog] Source #
Pretty ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods pretty :: ChainIndexLog -> Doc ann Source # prettyList :: [ChainIndexLog] -> Doc ann Source #
ToObject ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog Methods toObject :: TracingVerbosity -> ChainIndexLog -> Object textTransformer :: ChainIndexLog -> Object -> Text
type Rep ChainIndexLog Source #
Instance details Defined in Plutus.ChainIndex.ChainIndexLog type Rep ChainIndexLog = D1 ('MetaData "ChainIndexLog" "Plutus.ChainIndex.ChainIndexLog" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (((C1 ('MetaCons "InsertionSuccess" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tip) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InsertUtxoPosition)) :+: C1 ('MetaCons "ConversionFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FromCardanoError))) :+: (C1 ('MetaCons "RollbackSuccess" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Tip)) :+: C1 ('MetaCons "Err" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChainIndexError)))) :+: ((C1 ('MetaCons "TxNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId)) :+: C1 ('MetaCons "TxOutNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxOutRef))) :+: (C1 ('MetaCons "TipIsGenesis" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NoDatumScriptAddr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChainIndexTxOut)) :+: C1 ('MetaCons "BeamLogItem" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BeamLog))))))

data UtxoState a Source #

UTXO / ledger state, kept in memory. We are only interested in the UTXO set, everything else is stored on disk. This is OK because we don't need to validate transactions when they come in.

Constructors

UtxoState
Fields _usTxUtxoData :: a _usTip :: Tip Tip of our chain sync client

Instances

Instances details

Eq a => Eq (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods (==) :: UtxoState a -> UtxoState a -> Bool Source # (/=) :: UtxoState a -> UtxoState a -> Bool Source #
Eq a => Ord (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods compare :: UtxoState a -> UtxoState a -> Ordering Source # (<) :: UtxoState a -> UtxoState a -> Bool Source # (<=) :: UtxoState a -> UtxoState a -> Bool Source # (>) :: UtxoState a -> UtxoState a -> Bool Source # (>=) :: UtxoState a -> UtxoState a -> Bool Source # max :: UtxoState a -> UtxoState a -> UtxoState a Source # min :: UtxoState a -> UtxoState a -> UtxoState a Source #
Show a => Show (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods showsPrec :: Int -> UtxoState a -> ShowS Source # show :: UtxoState a -> String Source # showList :: [UtxoState a] -> ShowS Source #
Generic (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Associated Types type Rep (UtxoState a) :: Type -> Type Source # Methods from :: UtxoState a -> Rep (UtxoState a) x Source # to :: Rep (UtxoState a) x -> UtxoState a Source #
Semigroup a => Semigroup (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods (<>) :: UtxoState a -> UtxoState a -> UtxoState a Source # sconcat :: NonEmpty (UtxoState a) -> UtxoState a Source # stimes :: Integral b => b -> UtxoState a -> UtxoState a Source #
Monoid a => Monoid (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods mempty :: UtxoState a Source # mappend :: UtxoState a -> UtxoState a -> UtxoState a Source # mconcat :: [UtxoState a] -> UtxoState a Source #
ToJSON a => ToJSON (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods toJSON :: UtxoState a -> Value Source # toEncoding :: UtxoState a -> Encoding Source # toJSONList :: [UtxoState a] -> Value Source # toEncodingList :: [UtxoState a] -> Encoding Source #
FromJSON a => FromJSON (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods parseJSON :: Value -> Parser (UtxoState a) Source # parseJSONList :: Value -> Parser [UtxoState a] Source #
Monoid a => Measured (BlockCount, UtxoState a) (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods measure :: UtxoState a -> (BlockCount, UtxoState a) Source #
type Rep (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState type Rep (UtxoState a) = D1 ('MetaData "UtxoState" "Plutus.ChainIndex.UtxoState" "plutus-chain-index-core-1.1.0.0-K7whjMLv5AnJVt0avXcbFn" 'False) (C1 ('MetaCons "UtxoState" 'PrefixI 'True) (S1 ('MetaSel ('Just "_usTxUtxoData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "_usTip") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Tip)))

data ReduceBlockCountResult a Source #

Constructors

BlockCountNotReduced
ReduceBlockCountResult
Fields reducedIndex :: UtxoIndex a combinedState :: UtxoState a

data RollbackResult a Source #

Constructors

RollbackResult
Fields newTip :: Tip rolledBackIndex :: UtxoIndex a

data InsertUtxoSuccess a Source #

Constructors

InsertUtxoSuccess
Fields newIndex :: UtxoIndex a insertPosition :: InsertUtxoPosition

Instances

Instances details

Pretty (InsertUtxoSuccess a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods pretty :: InsertUtxoSuccess a -> Doc ann Source # prettyList :: [InsertUtxoSuccess a] -> Doc ann Source #

type UtxoIndex a = FingerTree (BlockCount, UtxoState a) (UtxoState a) Source #

newtype BlockCount Source #

Constructors

BlockCount
Fields getBlockCount :: Int

Instances

Instances details

Semigroup BlockCount Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods (<>) :: BlockCount -> BlockCount -> BlockCount Source # sconcat :: NonEmpty BlockCount -> BlockCount Source # stimes :: Integral b => b -> BlockCount -> BlockCount Source #
Monoid BlockCount Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods mempty :: BlockCount Source # mappend :: BlockCount -> BlockCount -> BlockCount Source # mconcat :: [BlockCount] -> BlockCount Source #
Monoid a => Measured (BlockCount, UtxoState a) (UtxoState a) Source #
Instance details Defined in Plutus.ChainIndex.UtxoState Methods measure :: UtxoState a -> (BlockCount, UtxoState a) Source #

usTip :: forall a. Lens' (UtxoState a) Tip Source #

usTxUtxoData :: forall a a. Lens (UtxoState a) (UtxoState a) a a Source #

utxoState :: Monoid a => UtxoIndex a -> UtxoState a Source #

utxoBlockCount :: Monoid a => UtxoIndex a -> Int Source #

tip :: UtxoState a -> Tip Source #

viewTip :: Monoid a => UtxoIndex a -> Tip Source #

insert :: (Monoid a, Eq a) => UtxoState a -> UtxoIndex a -> Either InsertUtxoFailed (InsertUtxoSuccess a) Source #

Insert a UtxoState into the index

rollbackWith Source #

Arguments

:: Monoid a
=> (UtxoIndex a -> UtxoIndex a -> UtxoIndex a)	Calculate the new index given the index before and the index after the rollback point.
-> Point
-> UtxoIndex a
-> Either RollbackFailed (RollbackResult a)

Perform a rollback on the utxo index, with a callback to calculate the new index.

reduceBlockCount :: Monoid a => Depth -> UtxoIndex a -> ReduceBlockCountResult a Source #

Reduce the number of UtxoStates. The given number is the minimum, the index is reduced when it larger than twice that size. The new index is prefixed with one UtxoState that contains the combined state of the removed UtxoStates.

pointLessThanTip :: Point -> Tip -> Bool Source #

Is the given point earlier than the provided tip. Yes, if the point is the genersis point, no if the tip is the genesis point, otherwise, just compare the slots.

initialStatus :: OnChainTx -> TxStatus Source #

The TxStatus of a transaction right after it was added to the chain

increaseDepth :: TxStatus -> TxStatus Source #

Increase the depth of a tentatively confirmed transaction

chainConstant :: Depth Source #

The depth (in blocks) after which a transaction cannot be rolled back anymore

dropOlder :: Monoid a => BlockNumber -> UtxoIndex a -> UtxoIndex a Source #

Drop everything older than BlockNumber in the index.

transactionStatus :: BlockNumber -> TxIdState -> TxId -> Either TxStatusFailure TxStatus Source #

Given the current block, compute the status for the given transaction by checking to see if it has been deleted.

transactionOutputStatus Source #

Arguments

:: BlockNumber	Current block number for inspecting the state of the transaction output
-> TxIdState	Information on the state of a transaction. Needed for determining its status.
-> TxOutBalance	Balance of spent and unspent transaction outputs.
-> TxOutRef	Target transaction output for inspecting its state.
-> Either TxStatusFailure TxOutStatus

Given the current block, compute the status for the given transaction output by getting the state of the transaction that produced it and checking if the output is spent or unspent.

transactionOutputState :: TxOutBalance -> TxOutRef -> Maybe TxOutState Source #

unspentOutputs :: UtxoState TxOutBalance -> Set TxOutRef Source #

The UTXO set

spentOutputs :: UtxoState TxOutBalance -> Set TxOutRef Source #

The spent output set

type ChainIndexState = UtxoIndex TxUtxoBalance Source #

getResumePoints :: Member (BeamEffect Sqlite) effs => Eff effs [ChainPoint] Source #

handleQuery :: (Member (State ChainIndexState) effs, Member (BeamEffect Sqlite) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexQueryEffect ~> Eff effs Source #

handleControl :: forall effs. (Member (State ChainIndexState) effs, Member (Reader Depth) effs, Member (BeamEffect Sqlite) effs, Member (Error ChainIndexError) effs, Member (LogMsg ChainIndexLog) effs) => ChainIndexControlEffect ~> Eff effs Source #

restoreStateFromDb :: Member (BeamEffect Sqlite) effs => Eff effs ChainIndexState Source #