Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.ScriptRegistry

Description

A data-type to keep track of reference Hydra scripts published on-chain, and needed to construct transactions leveraging reference inputs.

Synopsis

data ScriptRegistry = ScriptRegistry {
- initialReference :: (TxIn, TxOut CtxUTxO)
- commitReference :: (TxIn, TxOut CtxUTxO)
- headReference :: (TxIn, TxOut CtxUTxO)
}
data NewScriptRegistryException = MissingScript {
- scriptName :: Text
- scriptHash :: ScriptHash
- discoveredScripts :: Set ScriptHash
}
newScriptRegistry :: UTxO -> Either NewScriptRegistryException ScriptRegistry
registryUTxO :: ScriptRegistry -> UTxO

Documentation

data ScriptRegistry Source #

Hydra scripts published as reference scripts at these UTxO.

Constructors

ScriptRegistry
Fields initialReference :: (TxIn, TxOut CtxUTxO) commitReference :: (TxIn, TxOut CtxUTxO) headReference :: (TxIn, TxOut CtxUTxO)

Instances

Instances details

FromJSON ScriptRegistry Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods parseJSON :: Value -> Parser ScriptRegistry parseJSONList :: Value -> Parser [ScriptRegistry] omittedField :: Maybe ScriptRegistry
ToJSON ScriptRegistry Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods toJSON :: ScriptRegistry -> Value toEncoding :: ScriptRegistry -> Encoding toJSONList :: [ScriptRegistry] -> Value toEncodingList :: [ScriptRegistry] -> Encoding omitField :: ScriptRegistry -> Bool
Generic ScriptRegistry Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Associated Types type Rep ScriptRegistry :: Type -> Type Source # Methods from :: ScriptRegistry -> Rep ScriptRegistry x Source # to :: Rep ScriptRegistry x -> ScriptRegistry Source #
Show ScriptRegistry Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods showsPrec :: Int -> ScriptRegistry -> ShowS Source # show :: ScriptRegistry -> String Source # showList :: [ScriptRegistry] -> ShowS Source #
Eq ScriptRegistry Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods (==) :: ScriptRegistry -> ScriptRegistry -> Bool Source # (/=) :: ScriptRegistry -> ScriptRegistry -> Bool Source #
type Rep ScriptRegistry Source #
Instance details Defined in Hydra.Tx.ScriptRegistry type Rep ScriptRegistry = D1 ('MetaData "ScriptRegistry" "Hydra.Tx.ScriptRegistry" "hydra-tx-0.19.0-GruKCDFrYmltVsR6Cb5jZ" 'False) (C1 ('MetaCons "ScriptRegistry" 'PrefixI 'True) (S1 ('MetaSel ('Just "initialReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIn, TxOut CtxUTxO)) :: (S1 ('MetaSel ('Just "commitReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIn, TxOut CtxUTxO)) :: S1 ('MetaSel ('Just "headReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIn, TxOut CtxUTxO)))))

data NewScriptRegistryException Source #

Constructors

MissingScript
Fields scriptName :: Text scriptHash :: ScriptHash discoveredScripts :: Set ScriptHash

Instances

Instances details

Exception NewScriptRegistryException Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods toException :: NewScriptRegistryException -> SomeException Source # fromException :: SomeException -> Maybe NewScriptRegistryException Source # displayException :: NewScriptRegistryException -> String Source #
Show NewScriptRegistryException Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods showsPrec :: Int -> NewScriptRegistryException -> ShowS Source # show :: NewScriptRegistryException -> String Source # showList :: [NewScriptRegistryException] -> ShowS Source #
Eq NewScriptRegistryException Source #
Instance details Defined in Hydra.Tx.ScriptRegistry Methods (==) :: NewScriptRegistryException -> NewScriptRegistryException -> Bool Source # (/=) :: NewScriptRegistryException -> NewScriptRegistryException -> Bool Source #

newScriptRegistry :: UTxO -> Either NewScriptRegistryException ScriptRegistry Source #

Create a script registry from a UTxO containing outputs with reference scripts. This will return Nothing if one or all of the references could not be found.

registryUTxO :: ScriptRegistry -> UTxO Source #

Get the UTxO that corresponds to a script registry.

*Property**:
newScriptRegistry (registryUTxO r) === Just r