Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.API.ClientInput

Documentation

data ClientInput tx Source #

Constructors

Init
NewTx
Fields transaction :: tx
Recover
Fields recoverTxId :: TxIdType tx
Decommit
Fields decommitTx :: tx
Close
SafeClose
Contest
Fanout
PartialFanout	Fan out a user-selected subset of the closed head's UTxO. Unlike `Fanout` (which drains the whole set automatically), this distributes only `$sel:utxoToFanout:Init` and then waits for the next `PartialFanout` command. Once a partial fanout has started, `Fanout` is no longer accepted; the user keeps issuing `PartialFanout` until the head is drained, at which point the node automatically produces the final fanout that burns the head tokens.
Fields utxoToFanout :: UTxOType tx
SideLoadSnapshot
Fields snapshot :: ConfirmedSnapshot tx

Instances

Instances details

IsTx tx => FromJSON (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Methods parseJSON :: Value -> Parser (ClientInput tx) parseJSONList :: Value -> Parser [ClientInput tx] omittedField :: Maybe (ClientInput tx)
IsTx tx => ToJSON (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Methods toJSON :: ClientInput tx -> Value toEncoding :: ClientInput tx -> Encoding toJSONList :: [ClientInput tx] -> Value toEncodingList :: [ClientInput tx] -> Encoding omitField :: ClientInput tx -> Bool
Generic (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Associated Types type Rep (ClientInput tx) :: Type -> Type Source # Methods from :: ClientInput tx -> Rep (ClientInput tx) x Source # to :: Rep (ClientInput tx) x -> ClientInput tx Source #
IsTx tx => Show (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Methods showsPrec :: Int -> ClientInput tx -> ShowS Source # show :: ClientInput tx -> String Source # showList :: [ClientInput tx] -> ShowS Source #
IsTx tx => FromCBOR (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Methods fromCBOR :: Decoder s (ClientInput tx) label :: Proxy (ClientInput tx) -> Text
IsTx tx => ToCBOR (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Methods toCBOR :: ClientInput tx -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (ClientInput tx) -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ClientInput tx] -> Size
IsTx tx => Eq (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput Methods (==) :: ClientInput tx -> ClientInput tx -> Bool Source # (/=) :: ClientInput tx -> ClientInput tx -> Bool Source #
type Rep (ClientInput tx) Source #
Instance details Defined in Hydra.API.ClientInput type Rep (ClientInput tx) = D1 ('MetaData "ClientInput" "Hydra.API.ClientInput" "hydra-node-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'False) (((C1 ('MetaCons "Init" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "transaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx))) :+: (C1 ('MetaCons "Recover" 'PrefixI 'True) (S1 ('MetaSel ('Just "recoverTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx))) :+: (C1 ('MetaCons "Decommit" 'PrefixI 'True) (S1 ('MetaSel ('Just "decommitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx)) :+: C1 ('MetaCons "Close" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "SafeClose" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Contest" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Fanout" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PartialFanout" 'PrefixI 'True) (S1 ('MetaSel ('Just "utxoToFanout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "SideLoadSnapshot" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ConfirmedSnapshot tx)))))))