Safe Haskell	None
Language	Haskell2010

Plutus.ChainIndex.Types

Contents

Lenses
Orphan instances

Description

Misc. types used in this package

Synopsis

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
}
data ChainIndexTxOutputs
- = InvalidTx (Maybe ChainIndexTxOut)
- | ValidTx [ChainIndexTxOut]
data ChainIndexTxOut = ChainIndexTxOut {
- citoAddress :: CardanoAddress
- citoValue :: Value
- citoDatum :: OutputDatum
- citoRefScript :: ReferenceScript
}
data ReferenceScript
- = ReferenceScriptNone
- | ReferenceScriptInAnyLang ScriptInAnyLang
newtype BlockId = BlockId {
- getBlockId :: ByteString
}
blockId :: Block -> BlockId
data Tip
- = TipAtGenesis
- | Tip {
  - tipSlot :: Slot
  - tipBlockId :: BlockId
  - tipBlockNo :: BlockNumber
  }
data Point
- = PointAtGenesis
- | Point {
  - pointSlot :: Slot
  - pointBlockId :: BlockId
  }
pointsToTip :: Point -> Tip -> Bool
tipAsPoint :: Tip -> Point
_PointAtGenesis :: Prism' Point ()
_Point :: Prism' Point (Slot, BlockId)
data TxValidity
- = TxValid
- | TxInvalid
- | UnknownValidity
type TxStatus = RollbackState ()
type TxOutStatus = RollbackState TxOutState
data RollbackState a
- = Unknown
- | TentativelyConfirmed Depth TxValidity a
- | Committed TxValidity a
data TxOutState
- = Spent TxId
- | Unspent
liftTxOutStatus :: TxOutStatus -> TxStatus
txOutStatusTxOutState :: TxOutStatus -> Maybe TxOutState
newtype BlockNumber = BlockNumber {
- unBlockNumber :: Word64
}
newtype Depth = Depth {
- unDepth :: Int
}
data Diagnostics = Diagnostics {
- numTransactions :: Integer
- numScripts :: Integer
- numAddresses :: Integer
- numAssetClasses :: Integer
- numUnspentOutputs :: Int
- numUnmatchedInputs :: Int
- someTransactions :: [TxId]
- unspentTxOuts :: [ChainIndexTxOut]
}
data TxConfirmedState = TxConfirmedState {
- timesConfirmed :: Sum Int
- blockAdded :: Last BlockNumber
- validity :: Last TxValidity
}
data TxStatusFailure
- = TxIdStateInvalid BlockNumber TxId TxIdState
- | TxOutBalanceStateInvalid BlockNumber TxOutRef TxOutBalance
- | InvalidRollbackAttempt BlockNumber TxId TxIdState
data TxIdState = TxIdState {
- txnsConfirmed :: Map TxId TxConfirmedState
- txnsDeleted :: Map TxId (Sum Int)
}
data TxUtxoBalance = TxUtxoBalance {
- _tubUnspentOutputs :: Set TxOutRef
- _tubUnmatchedSpentInputs :: Set TxOutRef
}
tubUnspentOutputs :: Lens' TxUtxoBalance (Set TxOutRef)
tubUnmatchedSpentInputs :: Lens' TxUtxoBalance (Set TxOutRef)
data TxOutBalance = TxOutBalance {
- _tobUnspentOutputs :: Set TxOutRef
- _tobSpentOutputs :: Map TxOutRef TxId
}
tobUnspentOutputs :: Lens' TxOutBalance (Set TxOutRef)
tobSpentOutputs :: Lens' TxOutBalance (Map TxOutRef TxId)
data ChainSyncBlock = Block {
- blockTip :: Tip
- blockTxs :: [(ChainIndexTx, TxProcessOption)]
}
newtype TxProcessOption = TxProcessOption {
- tpoStoreTx :: Bool
}
citxTxId :: Lens' ChainIndexTx TxId
citxInputs :: Lens' ChainIndexTx [TxIn]
citxOutputs :: Lens' ChainIndexTx ChainIndexTxOutputs
citxValidRange :: Lens' ChainIndexTx SlotRange
citxData :: Lens' ChainIndexTx (Map DatumHash Datum)
citxRedeemers :: Lens' ChainIndexTx Redeemers
citxScripts :: Lens' ChainIndexTx (Map ScriptHash (Versioned Script))
citxCardanoTx :: Lens' ChainIndexTx (Maybe SomeCardanoApiTx)
_InvalidTx :: Prism' ChainIndexTxOutputs (Maybe ChainIndexTxOut)
_ValidTx :: Prism' ChainIndexTxOutputs [ChainIndexTxOut]
fromReferenceScript :: ReferenceScript -> Maybe (Versioned Script)

Documentation

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

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)))

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

blockId :: Block -> BlockId Source #

Compute a hash of the block's contents.

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

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)))

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

tipAsPoint :: Tip -> Point Source #

_PointAtGenesis :: Prism' Point () Source #

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

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)))

type TxStatus = RollbackState () Source #

The status of a Cardano transaction

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))))

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))

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.

txOutStatusTxOutState :: TxOutStatus -> Maybe TxOutState Source #

Maybe extract the TxOutState (Spent or Unspent) of a TxOutStatus.

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

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 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 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 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 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 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))))

tubUnspentOutputs :: Lens' TxUtxoBalance (Set TxOutRef) Source #

tubUnmatchedSpentInputs :: Lens' TxUtxoBalance (Set TxOutRef) Source #

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))))

tobUnspentOutputs :: Lens' TxOutBalance (Set TxOutRef) Source #

tobSpentOutputs :: Lens' TxOutBalance (Map TxOutRef TxId) 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 #

Lenses

citxTxId :: Lens' ChainIndexTx TxId Source #

citxInputs :: Lens' ChainIndexTx [TxIn] Source #

citxOutputs :: Lens' ChainIndexTx ChainIndexTxOutputs Source #

citxValidRange :: Lens' ChainIndexTx SlotRange Source #

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

citxRedeemers :: Lens' ChainIndexTx Redeemers Source #

citxScripts :: Lens' ChainIndexTx (Map ScriptHash (Versioned Script)) Source #

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

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

_ValidTx :: Prism' ChainIndexTxOutputs [ChainIndexTxOut] Source #

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

Orphan instances

ToSchema ScriptInAnyLang Source #
Instance details Methods declareNamedSchema :: Proxy ScriptInAnyLang -> Declare (Definitions Schema) NamedSchema Source #
Serialise ScriptInAnyLang Source #
Instance details Methods encode :: ScriptInAnyLang -> Encoding Source # decode :: Decoder s ScriptInAnyLang Source # encodeList :: [ScriptInAnyLang] -> Encoding Source # decodeList :: Decoder s [ScriptInAnyLang] Source #