Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.Init

Contents

Construction
Observation

Synopsis

initTx :: NetworkId -> TxIn -> [OnChainId] -> HeadParameters -> Tx
mkHeadOutput :: NetworkId -> PolicyId -> TxOutDatum ctx -> TxOut ctx
mkHeadOutputInitial :: NetworkId -> TxIn -> HeadParameters -> TxOut CtxTx
mkInitialOutput :: NetworkId -> TxIn -> OnChainId -> TxOut CtxTx
data InitObservation = InitObservation {
- initialThreadUTxO :: (TxIn, TxOut CtxUTxO)
- initials :: [(TxIn, TxOut CtxUTxO)]
- headId :: HeadId
- seedTxIn :: TxIn
- contestationPeriod :: ContestationPeriod
- parties :: [Party]
- participants :: [OnChainId]
}
data NotAnInitReason
- = NoHeadOutput
- | NotAHeadDatum
- | InvalidPartyInDatum
- | NoSTFound
- | NotAHeadPolicy
observeInitTx :: Tx -> Either NotAnInitReason InitObservation

Construction

initTx Source #

Arguments

:: NetworkId
-> 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 -> TxOutDatum ctx -> TxOut ctx Source #

mkHeadOutputInitial :: NetworkId -> TxIn -> HeadParameters -> TxOut CtxTx Source #

mkInitialOutput :: NetworkId -> TxIn -> OnChainId -> TxOut CtxTx Source #

Observation

data InitObservation Source #

Data which can be observed from an initTx.

Constructors

InitObservation
Fields initialThreadUTxO :: (TxIn, TxOut CtxUTxO) initials :: [(TxIn, TxOut CtxUTxO)] headId :: HeadId seedTxIn :: TxIn contestationPeriod :: ContestationPeriod parties :: [Party] participants :: [OnChainId]

Instances

Instances details

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-0.21.0-4kuGJf6saqmB4c4Nry9ECE" 'False) (C1 ('MetaCons "InitObservation" 'PrefixI 'True) ((S1 ('MetaSel ('Just "initialThreadUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIn, TxOut CtxUTxO)) :: (S1 ('MetaSel ('Just "initials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [(TxIn, TxOut CtxUTxO)]) :: S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId))) :: ((S1 ('MetaSel ('Just "seedTxIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxIn) :: S1 ('MetaSel ('Just "contestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestationPeriod)) :: (S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party]) :: S1 ('MetaSel ('Just "participants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [OnChainId])))))

data NotAnInitReason Source #

Constructors

NoHeadOutput
NotAHeadDatum
InvalidPartyInDatum
NoSTFound
NotAHeadPolicy

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-0.21.0-4kuGJf6saqmB4c4Nry9ECE" '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))))

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