hydra-tx-0.20.0: Hydra transaction library
Safe HaskellSafe-Inferred
LanguageGHC2021

Hydra.Tx.CollectCom

Synopsis

Construction

collectComTx Source #

Arguments

:: NetworkId 
-> ScriptRegistry

Published Hydra scripts to reference.

-> VerificationKey PaymentKey

Party who's authorizing this transaction

-> HeadId

Head identifier

-> HeadParameters

Parameters of the head to collect .

-> (TxIn, TxOut CtxUTxO)

Everything needed to spend the Head state-machine output.

-> Map TxIn (TxOut CtxUTxO)

Data needed to spend the commit output produced by each party. Should contain the PT and is locked by ν_commit script.

-> UTxO

UTxO to be used to collect. Should match whatever is recorded in the commit inputs.

-> Tx 

Create a transaction collecting all "committed" utxo and opening a Head, i.e. driving the Head script state.

Observation

data OpenThreadOutput Source #

Representation of the Head output after a CollectCom transaction.

Constructors

OpenThreadOutput 

Fields

Instances

Instances details
Generic OpenThreadOutput Source # 
Instance details

Defined in Hydra.Tx.CollectCom

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

Methods

showsPrec :: Int -> OpenThreadOutput -> ShowS Source #

show :: OpenThreadOutput -> String Source #

showList :: [OpenThreadOutput] -> ShowS Source #

Eq OpenThreadOutput Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Methods

(==) :: OpenThreadOutput -> OpenThreadOutput -> Bool Source #

(/=) :: OpenThreadOutput -> OpenThreadOutput -> Bool Source #

type Rep OpenThreadOutput Source # 
Instance details

Defined in Hydra.Tx.CollectCom

type Rep OpenThreadOutput = D1 ('MetaData "OpenThreadOutput" "Hydra.Tx.CollectCom" "hydra-tx-0.20.0-b01Sd51Fpn1r0Mfj7XdB1" '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]))))

newtype UTxOHash Source #

Constructors

UTxOHash ByteString 

Instances

Instances details
Arbitrary UTxOHash Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Methods

arbitrary :: Gen UTxOHash

shrink :: UTxOHash -> [UTxOHash]

Generic UTxOHash Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Associated Types

type Rep UTxOHash :: Type -> Type Source #

Methods

from :: UTxOHash -> Rep UTxOHash x Source #

to :: Rep UTxOHash x -> UTxOHash Source #

Show UTxOHash Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Methods

showsPrec :: Int -> UTxOHash -> ShowS Source #

show :: UTxOHash -> String Source #

showList :: [UTxOHash] -> ShowS Source #

Eq UTxOHash Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Methods

(==) :: UTxOHash -> UTxOHash -> Bool Source #

(/=) :: UTxOHash -> UTxOHash -> Bool Source #

type Rep UTxOHash Source # 
Instance details

Defined in Hydra.Tx.CollectCom

type Rep UTxOHash = D1 ('MetaData "UTxOHash" "Hydra.Tx.CollectCom" "hydra-tx-0.20.0-b01Sd51Fpn1r0Mfj7XdB1" 'True) (C1 ('MetaCons "UTxOHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data CollectComObservation Source #

Constructors

CollectComObservation 

Fields

Instances

Instances details
Generic CollectComObservation Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Associated Types

type Rep CollectComObservation :: Type -> Type Source #

Methods

from :: CollectComObservation -> Rep CollectComObservation x Source #

to :: Rep CollectComObservation x -> CollectComObservation Source #

Show CollectComObservation Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Methods

showsPrec :: Int -> CollectComObservation -> ShowS Source #

show :: CollectComObservation -> String Source #

showList :: [CollectComObservation] -> ShowS Source #

Eq CollectComObservation Source # 
Instance details

Defined in Hydra.Tx.CollectCom

Methods

(==) :: CollectComObservation -> CollectComObservation -> Bool Source #

(/=) :: CollectComObservation -> CollectComObservation -> Bool Source #

type Rep CollectComObservation Source # 
Instance details

Defined in Hydra.Tx.CollectCom

type Rep CollectComObservation = D1 ('MetaData "CollectComObservation" "Hydra.Tx.CollectCom" "hydra-tx-0.20.0-b01Sd51Fpn1r0Mfj7XdB1" 'False) (C1 ('MetaCons "CollectComObservation" 'PrefixI 'True) (S1 ('MetaSel ('Just "threadOutput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OpenThreadOutput) :*: (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :*: S1 ('MetaSel ('Just "utxoHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTxOHash))))

observeCollectComTx Source #

Arguments

:: UTxO

A UTxO set to lookup tx inputs

-> Tx 
-> Maybe CollectComObservation 

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