Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.Close

Contents

Construction
Observation

Synopsis

type PointInTime = (SlotNo, UTCTime)
data OpenThreadOutput = OpenThreadOutput {
- openThreadUTxO :: (TxIn, TxOut CtxUTxO)
- openContestationPeriod :: ContestationPeriod
- openParties :: [Party]
}
closeTx :: ScriptRegistry -> VerificationKey PaymentKey -> HeadId -> SnapshotVersion -> ConfirmedSnapshot Tx -> SlotNo -> PointInTime -> OpenThreadOutput -> IncrementalAction -> Tx
data CloseObservation = CloseObservation {
- headId :: HeadId
- snapshotNumber :: SnapshotNumber
- contestationDeadline :: UTCTime
}
observeCloseTx :: UTxO -> Tx -> Maybe CloseObservation

Construction

type PointInTime = (SlotNo, UTCTime) Source #

data OpenThreadOutput Source #

Representation of the Head output after a CollectCom transaction.

Constructors

OpenThreadOutput
Fields openThreadUTxO :: (TxIn, TxOut CtxUTxO) openContestationPeriod :: ContestationPeriod openParties :: [Party]

Instances

Instances details

Generic OpenThreadOutput Source #
Instance details Defined in Hydra.Tx.Close Associated Types type Rep OpenThreadOutput :: Type -> Type Source # Methods from :: OpenThreadOutput -> Rep OpenThreadOutput x Source # to :: Rep OpenThreadOutput x -> OpenThreadOutput Source #
Show OpenThreadOutput Source #
Instance details Defined in Hydra.Tx.Close Methods showsPrec :: Int -> OpenThreadOutput -> ShowS Source # show :: OpenThreadOutput -> String Source # showList :: [OpenThreadOutput] -> ShowS Source #
Eq OpenThreadOutput Source #
Instance details Defined in Hydra.Tx.Close Methods (==) :: OpenThreadOutput -> OpenThreadOutput -> Bool Source # (/=) :: OpenThreadOutput -> OpenThreadOutput -> Bool Source #
type Rep OpenThreadOutput Source #
Instance details Defined in Hydra.Tx.Close type Rep OpenThreadOutput = D1 ('MetaData "OpenThreadOutput" "Hydra.Tx.Close" "hydra-tx-0.22.2-9DrTHkMLTe1mD3LCOHOwb" 'False) (C1 ('MetaCons "OpenThreadOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "openThreadUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIn, TxOut CtxUTxO)) :: (S1 ('MetaSel ('Just "openContestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestationPeriod) :: S1 ('MetaSel ('Just "openParties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party]))))

closeTx Source #

Arguments

:: ScriptRegistry	Published Hydra scripts to reference.
-> VerificationKey PaymentKey	Party who's authorizing this transaction
-> HeadId	Head identifier
-> SnapshotVersion	Last known version of the open head.
-> ConfirmedSnapshot Tx	Snapshot with instructions how to close the head.
-> SlotNo	Lower validity slot number, usually a current or quite recent slot number.
-> PointInTime	Upper validity slot and UTC time to compute the contestation deadline time.
-> OpenThreadOutput	Everything needed to spend the Head state-machine output.
-> IncrementalAction
-> Tx

Create a transaction closing a head with either the initial snapshot or with a multi-signed confirmed snapshot.

Observation

data CloseObservation Source #

Constructors

CloseObservation
Fields headId :: HeadId snapshotNumber :: SnapshotNumber contestationDeadline :: UTCTime

Instances

Instances details

FromJSON CloseObservation Source #
Instance details Defined in Hydra.Tx.Close Methods parseJSON :: Value -> Parser CloseObservation parseJSONList :: Value -> Parser [CloseObservation] omittedField :: Maybe CloseObservation
ToJSON CloseObservation Source #
Instance details Defined in Hydra.Tx.Close Methods toJSON :: CloseObservation -> Value toEncoding :: CloseObservation -> Encoding toJSONList :: [CloseObservation] -> Value toEncodingList :: [CloseObservation] -> Encoding omitField :: CloseObservation -> Bool
Generic CloseObservation Source #
Instance details Defined in Hydra.Tx.Close Associated Types type Rep CloseObservation :: Type -> Type Source # Methods from :: CloseObservation -> Rep CloseObservation x Source # to :: Rep CloseObservation x -> CloseObservation Source #
Show CloseObservation Source #
Instance details Defined in Hydra.Tx.Close Methods showsPrec :: Int -> CloseObservation -> ShowS Source # show :: CloseObservation -> String Source # showList :: [CloseObservation] -> ShowS Source #
Eq CloseObservation Source #
Instance details Defined in Hydra.Tx.Close Methods (==) :: CloseObservation -> CloseObservation -> Bool Source # (/=) :: CloseObservation -> CloseObservation -> Bool Source #
type Rep CloseObservation Source #
Instance details Defined in Hydra.Tx.Close type Rep CloseObservation = D1 ('MetaData "CloseObservation" "Hydra.Tx.Close" "hydra-tx-0.22.2-9DrTHkMLTe1mD3LCOHOwb" 'False) (C1 ('MetaCons "CloseObservation" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotNumber) :: S1 ('MetaSel ('Just "contestationDeadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime))))

observeCloseTx Source #

Arguments

:: UTxO	A UTxO set to lookup tx inputs
-> Tx
-> Maybe CloseObservation

Identify a close tx by lookup up the input spending the Head output and decoding its redeemer.