Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Contract.Commit

Description

The validator used to collect & open or abort a Head.

Synopsis

data CommitRedeemer
- = ViaCollectCom
- | ViaAbort
data Commit = Commit {
- input :: TxOutRef
- preSerializedOutput :: BuiltinByteString
}
serializeCommit :: (TxIn, TxOut CtxUTxO) -> Maybe Commit
deserializeCommit :: Network -> Commit -> Maybe (TxIn, TxOut CtxUTxO)
type DatumType = (Party, [Commit], CurrencySymbol)
type RedeemerType = CommitRedeemer
validator :: DatumType -> RedeemerType -> ScriptContext -> Bool
compiledValidator :: CompiledCode ValidatorType
validatorScript :: SerialisedScript
validatorHash :: ScriptHash
datum :: DatumType -> Datum
redeemer :: RedeemerType -> Redeemer

Documentation

data CommitRedeemer Source #

Constructors

ViaCollectCom
ViaAbort

Instances

Instances details

FromData CommitRedeemer Source #
Instance details Defined in Hydra.Contract.Commit Methods fromBuiltinData :: BuiltinData -> Maybe CommitRedeemer
ToData CommitRedeemer Source #
Instance details Defined in Hydra.Contract.Commit Methods toBuiltinData :: CommitRedeemer -> BuiltinData
UnsafeFromData CommitRedeemer Source #
Instance details Defined in Hydra.Contract.Commit Methods unsafeFromBuiltinData :: BuiltinData -> CommitRedeemer

data Commit Source #

A data type representing comitted outputs on-chain. Besides recording the original TxOutRef, it also stores a binary representation compatible between on- and off-chain code to be hashed in the validators.

Constructors

Commit
Fields input :: TxOutRef preSerializedOutput :: BuiltinByteString

Instances

Instances details

Show Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods showsPrec :: Int -> Commit -> ShowS Source # show :: Commit -> String Source # showList :: [Commit] -> ShowS Source #
Eq Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods (==) :: Commit -> Commit -> Bool Source # (/=) :: Commit -> Commit -> Bool Source #
Ord Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods compare :: Commit -> Commit -> Ordering Source # (<) :: Commit -> Commit -> Bool Source # (<=) :: Commit -> Commit -> Bool Source # (>) :: Commit -> Commit -> Bool Source # (>=) :: Commit -> Commit -> Bool Source # max :: Commit -> Commit -> Commit Source # min :: Commit -> Commit -> Commit Source #
Eq Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods (==) :: Commit -> Commit -> Bool
FromData Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods fromBuiltinData :: BuiltinData -> Maybe Commit
ToData Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods toBuiltinData :: Commit -> BuiltinData
UnsafeFromData Commit Source #
Instance details Defined in Hydra.Contract.Commit Methods unsafeFromBuiltinData :: BuiltinData -> Commit

serializeCommit :: (TxIn, TxOut CtxUTxO) -> Maybe Commit Source #

Record an off-chain TxOut as a Commit on-chain. NOTE: Depends on the Serialise instance for Plutus' Data.

deserializeCommit :: Network -> Commit -> Maybe (TxIn, TxOut CtxUTxO) Source #

Decode an on-chain SerializedTxOut back into an off-chain TxOut. NOTE: Depends on the Serialise instance for Plutus' Data.

type DatumType = (Party, [Commit], CurrencySymbol) Source #

type RedeemerType = CommitRedeemer Source #

validator :: DatumType -> RedeemerType -> ScriptContext -> Bool Source #

The v_commit validator verifies that:

spent in a transaction also consuming a v_head output
ST is burned if the redeemer is ViaAbort
ST is present in the output if the redeemer is ViaCollectCom

compiledValidator :: CompiledCode ValidatorType Source #

validatorScript :: SerialisedScript Source #

validatorHash :: ScriptHash Source #

datum :: DatumType -> Datum Source #

redeemer :: RedeemerType -> Redeemer Source #