Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.Init

Contents

Construction
Observation

Synopsis

initTx :: NetworkId -> PParams LedgerEra -> TxIn -> [OnChainId] -> HeadParameters -> Tx
mkHeadOutput :: NetworkId -> PolicyId -> [OnChainId] -> TxOutDatum ctx -> TxOut ctx
data InitObservation = InitObservation {
- headId :: HeadId
- headSeed :: HeadSeed
- headParameters :: HeadParameters
- participants :: [OnChainId]
}
data NotAnInitReason
- = NoHeadOutput
- | NotAHeadDatum
- | InvalidPartyInDatum
- | NoSTFound
- | NotAHeadPolicy
- | NoTokensMinted
observeInitTx :: Tx -> Either NotAnInitReason InitObservation

Construction

initTx Source #

Arguments

:: NetworkId
-> PParams LedgerEra	Current protocol parameters, used to compute worst-case min-UTxO.
-> TxIn	Seed input.
-> [OnChainId]	Verification key hashes of all participants.
-> HeadParameters
-> Tx

Create the init transaction from some HeadParameters and a single TxIn which will be used as unique parameter for minting NFTs.

mkHeadOutput :: NetworkId -> PolicyId -> [OnChainId] -> TxOutDatum ctx -> TxOut ctx Source #

Observation

data InitObservation Source #

Data which can be observed from an initTx.

Constructors

InitObservation
Fields headId :: HeadId headSeed :: HeadSeed headParameters :: HeadParameters participants :: [OnChainId]

Instances

Instances details

FromJSON InitObservation Source #
Instance details Defined in Hydra.Tx.Init Methods parseJSON :: Value -> Parser InitObservation parseJSONList :: Value -> Parser [InitObservation] omittedField :: Maybe InitObservation
ToJSON InitObservation Source #
Instance details Defined in Hydra.Tx.Init Methods toJSON :: InitObservation -> Value toEncoding :: InitObservation -> Encoding toJSONList :: [InitObservation] -> Value toEncodingList :: [InitObservation] -> Encoding omitField :: InitObservation -> Bool
Generic InitObservation Source #
Instance details Defined in Hydra.Tx.Init Associated Types type Rep InitObservation :: Type -> Type Source # Methods from :: InitObservation -> Rep InitObservation x Source # to :: Rep InitObservation x -> InitObservation Source #
Show InitObservation Source #
Instance details Defined in Hydra.Tx.Init Methods showsPrec :: Int -> InitObservation -> ShowS Source # show :: InitObservation -> String Source # showList :: [InitObservation] -> ShowS Source #
Eq InitObservation Source #
Instance details Defined in Hydra.Tx.Init Methods (==) :: InitObservation -> InitObservation -> Bool Source # (/=) :: InitObservation -> InitObservation -> Bool Source #
type Rep InitObservation Source #
Instance details Defined in Hydra.Tx.Init type Rep InitObservation = D1 ('MetaData "InitObservation" "Hydra.Tx.Init" "hydra-tx-2.3.0-AmphLXDqLbeiaw5uNmLIz" 'False) (C1 ('MetaCons "InitObservation" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "headSeed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadSeed)) :: (S1 ('MetaSel ('Just "headParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadParameters) :*: S1 ('MetaSel ('Just "participants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [OnChainId]))))

data NotAnInitReason Source #

Constructors

NoHeadOutput
NotAHeadDatum
InvalidPartyInDatum
NoSTFound
NotAHeadPolicy
NoTokensMinted

Instances

Instances details

Generic NotAnInitReason Source #
Instance details Defined in Hydra.Tx.Init Associated Types type Rep NotAnInitReason :: Type -> Type Source # Methods from :: NotAnInitReason -> Rep NotAnInitReason x Source # to :: Rep NotAnInitReason x -> NotAnInitReason Source #
Show NotAnInitReason Source #
Instance details Defined in Hydra.Tx.Init Methods showsPrec :: Int -> NotAnInitReason -> ShowS Source # show :: NotAnInitReason -> String Source # showList :: [NotAnInitReason] -> ShowS Source #
Eq NotAnInitReason Source #
Instance details Defined in Hydra.Tx.Init Methods (==) :: NotAnInitReason -> NotAnInitReason -> Bool Source # (/=) :: NotAnInitReason -> NotAnInitReason -> Bool Source #
type Rep NotAnInitReason Source #
Instance details Defined in Hydra.Tx.Init type Rep NotAnInitReason = D1 ('MetaData "NotAnInitReason" "Hydra.Tx.Init" "hydra-tx-2.3.0-AmphLXDqLbeiaw5uNmLIz" 'False) ((C1 ('MetaCons "NoHeadOutput" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NotAHeadDatum" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InvalidPartyInDatum" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "NoSTFound" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NotAHeadPolicy" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoTokensMinted" 'PrefixI 'False) (U1 :: Type -> Type))))

observeInitTx :: Tx -> Either NotAnInitReason InitObservation Source #

Identify a init tx by checking the output value for holding tokens that are valid head tokens (checked by seed + policy).