Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Tx.Deposit

Contents

Construction
Observation

Synopsis

depositTx :: HasCallStack => NetworkId -> PParams LedgerEra -> HeadId -> CommitBlueprintTx Tx -> SlotNo -> UTCTime -> Maybe AddressInEra -> Tx
mkDepositOutput :: NetworkId -> HeadId -> UTxO -> UTCTime -> TxOut ctx
constructDepositUTxO :: TxId -> [TxOut CtxTx] -> UTxO
depositAddress :: NetworkId -> AddressInEra
data DepositObservation = DepositObservation {
- headId :: HeadId
- depositTxId :: TxId
- deposited :: UTxO
- created :: SlotNo
- deadline :: UTCTime
}
observeDepositTx :: NetworkId -> Tx -> Maybe DepositObservation
observeDepositTxOut :: Network -> TxOut CtxUTxO -> Maybe (HeadId, UTxO, POSIXTime)

Construction

depositTx Source #

Arguments

:: HasCallStack
=> NetworkId
-> PParams LedgerEra
-> HeadId
-> CommitBlueprintTx Tx
-> SlotNo	Slot to use as upper validity. Will mark the time of creation of the deposit.
-> UTCTime	Deposit deadline from which onward the deposit can be recovered.
-> Maybe AddressInEra
-> Tx

Builds a deposit transaction to lock funds into the v_deposit script.

mkDepositOutput :: NetworkId -> HeadId -> UTxO -> UTCTime -> TxOut ctx Source #

constructDepositUTxO :: TxId -> [TxOut CtxTx] -> UTxO Source #

depositAddress :: NetworkId -> AddressInEra Source #

Observation

data DepositObservation Source #

Constructors

DepositObservation
Fields headId :: HeadId depositTxId :: TxId deposited :: UTxO created :: SlotNo deadline :: UTCTime

Instances

Instances details

FromJSON DepositObservation Source #
Instance details Defined in Hydra.Tx.Deposit Methods parseJSON :: Value -> Parser DepositObservation parseJSONList :: Value -> Parser [DepositObservation] omittedField :: Maybe DepositObservation
ToJSON DepositObservation Source #
Instance details Defined in Hydra.Tx.Deposit Methods toJSON :: DepositObservation -> Value toEncoding :: DepositObservation -> Encoding toJSONList :: [DepositObservation] -> Value toEncodingList :: [DepositObservation] -> Encoding omitField :: DepositObservation -> Bool
Generic DepositObservation Source #
Instance details Defined in Hydra.Tx.Deposit Associated Types type Rep DepositObservation :: Type -> Type Source # Methods from :: DepositObservation -> Rep DepositObservation x Source # to :: Rep DepositObservation x -> DepositObservation Source #
Show DepositObservation Source #
Instance details Defined in Hydra.Tx.Deposit Methods showsPrec :: Int -> DepositObservation -> ShowS Source # show :: DepositObservation -> String Source # showList :: [DepositObservation] -> ShowS Source #
Eq DepositObservation Source #
Instance details Defined in Hydra.Tx.Deposit Methods (==) :: DepositObservation -> DepositObservation -> Bool Source # (/=) :: DepositObservation -> DepositObservation -> Bool Source #
type Rep DepositObservation Source #
Instance details Defined in Hydra.Tx.Deposit type Rep DepositObservation = D1 ('MetaData "DepositObservation" "Hydra.Tx.Deposit" "hydra-tx-2.3.0-AmphLXDqLbeiaw5uNmLIz" 'False) (C1 ('MetaCons "DepositObservation" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TxId)) :: (S1 ('MetaSel ('Just "deposited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTxO) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo) :: S1 ('MetaSel ('Just "deadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

observeDepositTx :: NetworkId -> Tx -> Maybe DepositObservation Source #

Observe a deposit transaction by decoding the target head id, deposit deadline and deposited utxo in the datum.

This includes checking whether - the transaction's first output is the deposit output - all of deposited value is contained in the deposit tx output, - the deposit script output actually contains the deposited value, - an upper validity bound has been set (used as creation slot).

observeDepositTxOut :: Network -> TxOut CtxUTxO -> Maybe (HeadId, UTxO, POSIXTime) Source #