License	Apache-2.0
Safe Haskell	None
Language	GHC2021

Singular.Registry.LedgerProvider

Description

Capabilities supply raw Conway facts and generic reconstruction material. They neither interpret registry commands nor assert verification or snapshot binding. One acquisition identifies all reads used to prepare a transaction.

Synopsis

data LedgerProvider w (m :: Type -> Type) = LedgerProvider {
- acquire :: forall a. Acquisition -> (Session w m -> m a) -> m (Either AcquireFailure a)
- submitTx :: Network -> SignedTx -> m SubmitResult
}
data Session w (m :: Type -> Type) = Session {
- sessionNetwork :: Network
- sessionId :: SessionId
- sessionBinding :: SessionBinding
- sessionTracer :: Tracer m ReadEvent
- sessionEvaluated :: Evaluation -> m ()
- outputs :: OutputQuery -> m (Either ReadFailure (Evidenced w Outputs))
- protocolParameters :: m (Either ReadFailure (Evidenced w (PParams ConwayEra)))
- tipObservation :: m (Either ReadFailure (Evidenced w TipObservation))
- networkTime :: m (Either ReadFailure (Evidenced w NetworkTime))
- scriptRegistered :: ScriptHash -> m (Either ReadFailure (Evidenced w Bool))
- mintRecord :: Asset -> m (Either ReadFailure (Evidenced w (Maybe MintRecord)))
- history :: Asset -> HistoryRange -> m (Either HistoryFailure (HistoryStream m))
}
newtype Network = Network Word32
data ChainPoint
- = Genesis
- | At SlotNo ByteString
data Acquisition
- = Latest Network
- | AtPoint Network ChainPoint
data AcquireFailure
data ReadFailure
- = ReleasedSession SessionId
- | MissingOutput TxIn
- | ConflictingOutput TxIn
- | BackendReadFailure Text
- | NetworkTimeRefusal NetworkTimeFailure
data SubmitResult
- = SubmitAccepted TxId
- | SubmitRefused Text
- | SubmitFailed Text
- | SubmitWrongNetwork Network Network
data OutputQuery
- = AtAddress Addr
- | HoldingAsset Asset
- | AtTxIn TxIn
- | CarryingReferenceScript ScriptHash
- | AnyOf (NonEmpty OutputQuery)
- | AllOf (NonEmpty OutputQuery)
data MintRecord = MintRecord {
- mintTransaction :: TxId
- mintSpentInputs :: [TxIn]
- mintSupply :: Integer
}
type Outputs = [(TxIn, TxOut ConwayEra)]
type Asset = (PolicyID, AssetName)
data TipObservation = TipObservation {
- observedSlot :: SlotNo
- observedHash :: ByteString
- observedHeight :: Word64
- observedBlockTime :: Word64
}
data HistoryRange = HistoryRange {
- fromHeight :: Maybe Word64
- throughHeight :: Maybe Word64
}
data HistoryFailure
- = HistoryReadFailure ReadFailure
- | HistoryDependencyCycle (NonEmpty TxId)
- | MissingInBlockParent TxId TxId
- | DuplicateSpend TxIn
- | HistoryMaterialMismatch TxId Text
- | HistoryOrderMismatch Word64 Word64
data HistoricalTransaction = HistoricalTransaction {
- historicalId :: TxId
- historicalCbor :: ByteString
- historicalTx :: ConwayTx
- spentOutputs :: Outputs
- referenceOutputs :: Outputs
- createdOutputs :: Outputs
- scriptValid :: Bool
}
data HistoryBlock = HistoryBlock {
- blockHeight :: Word64
- blockTransactions :: NonEmpty HistoricalTransaction
}
newtype HistoryStream (m :: Type -> Type) = HistoryStream {
- nextBlock :: m (Either HistoryFailure (Maybe (HistoryBlock, HistoryStream m)))
}

Documentation

data LedgerProvider w (m :: Type -> Type) Source #

Reading and signed submission in the caller's monad and witness domain.

Constructors

LedgerProvider
Fields acquire :: forall a. Acquisition -> (Session w m -> m a) -> m (Either AcquireFailure a) submitTx :: Network -> SignedTx -> m SubmitResult

data Session w (m :: Type -> Type) Source #

Facts consumed within one acquired scope and its named network.

Constructors

Session

Fields

sessionNetwork :: Network
sessionId :: SessionId
sessionBinding :: SessionBinding
sessionTracer :: Tracer m ReadEvent
Where the local services report what they do under this session: the tracer of the scope that acquired it
sessionEvaluated :: Evaluation -> m ()
Where the local evaluator records the outcome of each evaluation under this session, typed: the build that owns the session reads it to say whether its scripts failed. Not a tracer: nothing renders it.
outputs :: OutputQuery -> m (Either ReadFailure (Evidenced w Outputs))
protocolParameters :: m (Either ReadFailure (Evidenced w (PParams ConwayEra)))
tipObservation :: m (Either ReadFailure (Evidenced w TipObservation))
networkTime :: m (Either ReadFailure (Evidenced w NetworkTime))
scriptRegistered :: ScriptHash -> m (Either ReadFailure (Evidenced w Bool))
mintRecord :: Asset -> m (Either ReadFailure (Evidenced w (Maybe MintRecord)))
No record for an asset the provider does not know
history :: Asset -> HistoryRange -> m (Either HistoryFailure (HistoryStream m))

newtype Network Source #

Explicit network magic; no process-global network choice.

Constructors

Network Word32

Instances

Instances details

Show Network Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> Network -> ShowS Source # show :: Network -> String Source # showList :: [Network] -> ShowS Source #
Eq Network Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: Network -> Network -> Bool Source # (/=) :: Network -> Network -> Bool Source #
Ord Network Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods compare :: Network -> Network -> Ordering Source # (<) :: Network -> Network -> Bool Source # (<=) :: Network -> Network -> Bool Source # (>) :: Network -> Network -> Bool Source # (>=) :: Network -> Network -> Bool Source # max :: Network -> Network -> Network Source # min :: Network -> Network -> Network Source #

data ChainPoint Source #

A requested chain point. It does not establish a binding by observation.

Constructors

Genesis
At SlotNo ByteString

Instances

Instances details

Show ChainPoint Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> ChainPoint -> ShowS Source # show :: ChainPoint -> String Source # showList :: [ChainPoint] -> ShowS Source #
Eq ChainPoint Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: ChainPoint -> ChainPoint -> Bool Source # (/=) :: ChainPoint -> ChainPoint -> Bool Source #

data Acquisition Source #

Acquisition always names its network.

Constructors

Latest Network
AtPoint Network ChainPoint

Instances

Instances details

Show Acquisition Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> Acquisition -> ShowS Source # show :: Acquisition -> String Source # showList :: [Acquisition] -> ShowS Source #
Eq Acquisition Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: Acquisition -> Acquisition -> Bool Source # (/=) :: Acquisition -> Acquisition -> Bool Source #

data AcquireFailure Source #

Named acquisition refusal, distinct from an empty query result.

Constructors

WrongNetwork Network Network
PointNotSupported ChainPoint
AcquisitionReadFailure ReadFailure

Instances

Instances details

Exception AcquireFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods toException :: AcquireFailure -> SomeException Source # fromException :: SomeException -> Maybe AcquireFailure Source # displayException :: AcquireFailure -> String Source # backtraceDesired :: AcquireFailure -> Bool Source #
Show AcquireFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> AcquireFailure -> ShowS Source # show :: AcquireFailure -> String Source # showList :: [AcquireFailure] -> ShowS Source #
Eq AcquireFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: AcquireFailure -> AcquireFailure -> Bool Source # (/=) :: AcquireFailure -> AcquireFailure -> Bool Source #

data ReadFailure Source #

Read refusals retain the missing/conflicting identity or backend reason.

Constructors

ReleasedSession SessionId
MissingOutput TxIn
ConflictingOutput TxIn
BackendReadFailure Text
NetworkTimeRefusal NetworkTimeFailure

Instances

Instances details

Exception ReadFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods toException :: ReadFailure -> SomeException Source # fromException :: SomeException -> Maybe ReadFailure Source # displayException :: ReadFailure -> String Source # backtraceDesired :: ReadFailure -> Bool Source #
Show ReadFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> ReadFailure -> ShowS Source # show :: ReadFailure -> String Source # showList :: [ReadFailure] -> ShowS Source #
Eq ReadFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: ReadFailure -> ReadFailure -> Bool Source # (/=) :: ReadFailure -> ReadFailure -> Bool Source #

data SubmitResult Source #

Signed submission's actual backend outcome.

Constructors

SubmitAccepted TxId
SubmitRefused Text
SubmitFailed Text
SubmitWrongNetwork Network Network

Instances

Instances details

Show SubmitResult Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> SubmitResult -> ShowS Source # show :: SubmitResult -> String Source # showList :: [SubmitResult] -> ShowS Source #
Eq SubmitResult Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: SubmitResult -> SubmitResult -> Bool Source # (/=) :: SubmitResult -> SubmitResult -> Bool Source #

data OutputQuery Source #

Nonempty composed queries; an absent exact reference refuses by name.

Constructors

AtAddress Addr
HoldingAsset Asset
AtTxIn TxIn
CarryingReferenceScript ScriptHash	Live outputs carrying this reference script. An empty answer means not found by this provider, never not on chain; a consumer checks each candidate's script itself.
AnyOf (NonEmpty OutputQuery)
AllOf (NonEmpty OutputQuery)

Instances

Instances details

Show OutputQuery Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> OutputQuery -> ShowS Source # show :: OutputQuery -> String Source # showList :: [OutputQuery] -> ShowS Source #
Eq OutputQuery Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: OutputQuery -> OutputQuery -> Bool Source # (/=) :: OutputQuery -> OutputQuery -> Bool Source #

data MintRecord Source #

How an asset came to be: the transaction that minted it, every input that transaction spent, and the asset's current total supply.

Constructors

MintRecord
Fields mintTransaction :: TxId mintSpentInputs :: [TxIn] mintSupply :: Integer

Instances

Instances details

Show MintRecord Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> MintRecord -> ShowS Source # show :: MintRecord -> String Source # showList :: [MintRecord] -> ShowS Source #
Eq MintRecord Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: MintRecord -> MintRecord -> Bool Source # (/=) :: MintRecord -> MintRecord -> Bool Source #

type Outputs = [(TxIn, TxOut ConwayEra)] Source #

Exact output references and full ledger outputs.

type Asset = (PolicyID, AssetName) Source #

A ledger asset, independent of registry interpretation.

data TipObservation Source #

Latest observed block facts, with raw POSIX seconds independent of slots.

Constructors

TipObservation
Fields observedSlot :: SlotNo observedHash :: ByteString observedHeight :: Word64 observedBlockTime :: Word64

Instances

Instances details

Show TipObservation Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> TipObservation -> ShowS Source # show :: TipObservation -> String Source # showList :: [TipObservation] -> ShowS Source #
Eq TipObservation Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: TipObservation -> TipObservation -> Bool Source # (/=) :: TipObservation -> TipObservation -> Bool Source #

data HistoryRange Source #

Inclusive block-height bounds; absent bounds leave that side open.

Constructors

HistoryRange
Fields fromHeight :: Maybe Word64 throughHeight :: Maybe Word64

Instances

Instances details

Show HistoryRange Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> HistoryRange -> ShowS Source # show :: HistoryRange -> String Source # showList :: [HistoryRange] -> ShowS Source #
Eq HistoryRange Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: HistoryRange -> HistoryRange -> Bool Source # (/=) :: HistoryRange -> HistoryRange -> Bool Source #

data HistoryFailure Source #

History refuses incomplete or inconsistent reconstruction material.

Constructors

HistoryReadFailure ReadFailure
HistoryDependencyCycle (NonEmpty TxId)
MissingInBlockParent TxId TxId
DuplicateSpend TxIn
HistoryMaterialMismatch TxId Text
HistoryOrderMismatch Word64 Word64

Instances

Instances details

Exception HistoryFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods toException :: HistoryFailure -> SomeException Source # fromException :: SomeException -> Maybe HistoryFailure Source # displayException :: HistoryFailure -> String Source # backtraceDesired :: HistoryFailure -> Bool Source #
Show HistoryFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods showsPrec :: Int -> HistoryFailure -> ShowS Source # show :: HistoryFailure -> String Source # showList :: [HistoryFailure] -> ShowS Source #
Eq HistoryFailure Source #
Instance details Defined in Singular.Registry.LedgerProvider Methods (==) :: HistoryFailure -> HistoryFailure -> Bool Source # (/=) :: HistoryFailure -> HistoryFailure -> Bool Source #

data HistoricalTransaction Source #

Complete CBOR plus resolved inputs, references and outputs, with validity. These are reconstruction material, without an evidence verdict.

Constructors

HistoricalTransaction
Fields historicalId :: TxId historicalCbor :: ByteString historicalTx :: ConwayTx spentOutputs :: Outputs referenceOutputs :: Outputs createdOutputs :: Outputs scriptValid :: Bool

data HistoryBlock Source #

One complete block, in creator-before-spender order within its height.

Constructors

HistoryBlock
Fields blockHeight :: Word64 blockTransactions :: NonEmpty HistoricalTransaction

newtype HistoryStream (m :: Type -> Type) Source #

Deferred complete-block consumption; never joins the entire history first.

Constructors

HistoryStream
Fields nextBlock :: m (Either HistoryFailure (Maybe (HistoryBlock, HistoryStream m)))