Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.API.ServerOutput

Synopsis

data TimedServerOutput tx = TimedServerOutput {
- output :: ServerOutput tx
- seq :: Natural
- time :: UTCTime
}
genTimedServerOutput :: ServerOutput tx -> Gen (TimedServerOutput tx)
data DecommitInvalidReason tx
- = DecommitTxInvalid {
  - localUTxO :: UTxOType tx
  - validationError :: ValidationError
  }
- | DecommitAlreadyInFlight {
  - otherDecommitTxId :: TxIdType tx
  }
data ServerOutput tx
- = PeerConnected {
  - peer :: NodeId
  }
- | PeerDisconnected {
  - peer :: NodeId
  }
- | PeerHandshakeFailure {
  - remoteHost :: Host
  - ourVersion :: Natural
  - theirVersions :: [Natural]
  }
- | HeadIsInitializing {
  - headId :: HeadId
  - parties :: [Party]
  }
- | Committed {
  - headId :: HeadId
  - party :: Party
  - utxo :: UTxOType tx
  }
- | HeadIsOpen {
  - headId :: HeadId
  - utxo :: UTxOType tx
  }
- | HeadIsClosed {
  - headId :: HeadId
  - snapshotNumber :: SnapshotNumber
  - contestationDeadline :: UTCTime
  }
- | HeadIsContested {
  - headId :: HeadId
  - snapshotNumber :: SnapshotNumber
  - contestationDeadline :: UTCTime
  }
- | ReadyToFanout {
  - headId :: HeadId
  }
- | HeadIsAborted {
  - headId :: HeadId
  - utxo :: UTxOType tx
  }
- | HeadIsFinalized {
  - headId :: HeadId
  - utxo :: UTxOType tx
  }
- | CommandFailed {
  - clientInput :: ClientInput tx
  - state :: HeadState tx
  }
- | TxValid {
  - headId :: HeadId
  - transactionId :: TxIdType tx
  }
- | TxInvalid {
  - headId :: HeadId
  - utxo :: UTxOType tx
  - transaction :: tx
  - validationError :: ValidationError
  }
- | SnapshotConfirmed {
  - headId :: HeadId
  - snapshot :: Snapshot tx
  - signatures :: MultiSignature (Snapshot tx)
  }
- | GetUTxOResponse {
  - headId :: HeadId
  - utxo :: UTxOType tx
  }
- | InvalidInput {
  - reason :: String
  - input :: Text
  }
- | Greetings {
  - me :: Party
  - headStatus :: HeadStatus
  - hydraHeadId :: Maybe HeadId
  - snapshotUtxo :: Maybe (UTxOType tx)
  - hydraNodeVersion :: String
  }
- | PostTxOnChainFailed {
  - postChainTx :: PostChainTx tx
  - postTxError :: PostTxError tx
  }
- | IgnoredHeadInitializing {
  - headId :: HeadId
  - contestationPeriod :: ContestationPeriod
  - parties :: [Party]
  - participants :: [OnChainId]
  }
- | DecommitRequested {
  - headId :: HeadId
  - decommitTx :: tx
  - utxoToDecommit :: UTxOType tx
  }
- | DecommitInvalid {
  - headId :: HeadId
  - decommitTx :: tx
  - decommitInvalidReason :: DecommitInvalidReason tx
  }
- | DecommitApproved {
  - headId :: HeadId
  - decommitTxId :: TxIdType tx
  - utxoToDecommit :: UTxOType tx
  }
- | CommitRecorded {
  - headId :: HeadId
  - utxoToCommit :: UTxOType tx
  - pendingDeposit :: TxIdType tx
  - deadline :: UTCTime
  }
- | CommitApproved {
  - headId :: HeadId
  - utxoToCommit :: UTxOType tx
  }
- | DecommitFinalized {
  - headId :: HeadId
  - decommitTxId :: TxIdType tx
  }
- | CommitFinalized {
  - headId :: HeadId
  - theDeposit :: TxIdType tx
  }
- | CommitRecovered {
  - headId :: HeadId
  - recoveredUTxO :: UTxOType tx
  - recoveredTxId :: TxIdType tx
  }
data WithUTxO
- = WithUTxO
- | WithoutUTxO
newtype ServerOutputConfig = ServerOutputConfig {
- utxoInSnapshot :: WithUTxO
}
prepareServerOutput :: IsChainState tx => ServerOutputConfig -> TimedServerOutput tx -> ByteString
data HeadStatus
- = Idle
- | Initializing
- | Open
- | Closed
- | FanoutPossible
- | Final
data CommitInfo
- = CannotCommit
- | NormalCommit HeadId
- | IncrementalCommit HeadId
projectPendingDeposits :: IsTx tx => [TxIdType tx] -> ServerOutput tx -> [TxIdType tx]
projectCommitInfo :: CommitInfo -> ServerOutput tx -> CommitInfo
projectInitializingHeadId :: Maybe HeadId -> ServerOutput tx -> Maybe HeadId
projectHeadStatus :: HeadStatus -> ServerOutput tx -> HeadStatus
projectSnapshotUtxo :: Maybe (UTxOType tx) -> ServerOutput tx -> Maybe (UTxOType tx)

Documentation

data TimedServerOutput tx Source #

The type of messages sent to clients by the Server.

Constructors

TimedServerOutput
Fields output :: ServerOutput tx seq :: Natural time :: UTCTime

Instances

Instances details

Arbitrary (ServerOutput tx) => Arbitrary (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods arbitrary :: Gen (TimedServerOutput tx) shrink :: TimedServerOutput tx -> [TimedServerOutput tx]
IsChainState tx => FromJSON (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser (TimedServerOutput tx) parseJSONList :: Value -> Parser [TimedServerOutput tx] omittedField :: Maybe (TimedServerOutput tx)
IsChainState tx => ToJSON (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: TimedServerOutput tx -> Value toEncoding :: TimedServerOutput tx -> Encoding toJSONList :: [TimedServerOutput tx] -> Value toEncodingList :: [TimedServerOutput tx] -> Encoding omitField :: TimedServerOutput tx -> Bool
Generic (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep (TimedServerOutput tx) :: Type -> Type Source # Methods from :: TimedServerOutput tx -> Rep (TimedServerOutput tx) x Source # to :: Rep (TimedServerOutput tx) x -> TimedServerOutput tx Source #
IsChainState tx => Show (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> TimedServerOutput tx -> ShowS Source # show :: TimedServerOutput tx -> String Source # showList :: [TimedServerOutput tx] -> ShowS Source #
IsChainState tx => Eq (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: TimedServerOutput tx -> TimedServerOutput tx -> Bool Source # (/=) :: TimedServerOutput tx -> TimedServerOutput tx -> Bool Source #
type Rep (TimedServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput type Rep (TimedServerOutput tx) = D1 ('MetaData "TimedServerOutput" "Hydra.API.ServerOutput" "hydra-node-0.20.0-5pXAEiXeWsXH8K4KfwlMxW" 'False) (C1 ('MetaCons "TimedServerOutput" 'PrefixI 'True) (S1 ('MetaSel ('Just "output") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ServerOutput tx)) :: (S1 ('MetaSel ('Just "seq") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: S1 ('MetaSel ('Just "time") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime))))

genTimedServerOutput :: ServerOutput tx -> Gen (TimedServerOutput tx) Source #

Generate a random timed server output given a normal server output.

data DecommitInvalidReason tx Source #

Constructors

DecommitTxInvalid
Fields localUTxO :: UTxOType tx validationError :: ValidationError
DecommitAlreadyInFlight
Fields otherDecommitTxId :: TxIdType tx

Instances

Instances details

ArbitraryIsTx tx => Arbitrary (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods arbitrary :: Gen (DecommitInvalidReason tx) shrink :: DecommitInvalidReason tx -> [DecommitInvalidReason tx]
(FromJSON (TxIdType tx), FromJSON (UTxOType tx)) => FromJSON (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser (DecommitInvalidReason tx) parseJSONList :: Value -> Parser [DecommitInvalidReason tx] omittedField :: Maybe (DecommitInvalidReason tx)
(ToJSON (TxIdType tx), ToJSON (UTxOType tx)) => ToJSON (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: DecommitInvalidReason tx -> Value toEncoding :: DecommitInvalidReason tx -> Encoding toJSONList :: [DecommitInvalidReason tx] -> Value toEncodingList :: [DecommitInvalidReason tx] -> Encoding omitField :: DecommitInvalidReason tx -> Bool
Generic (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep (DecommitInvalidReason tx) :: Type -> Type Source # Methods from :: DecommitInvalidReason tx -> Rep (DecommitInvalidReason tx) x Source # to :: Rep (DecommitInvalidReason tx) x -> DecommitInvalidReason tx Source #
(Show (TxIdType tx), Show (UTxOType tx)) => Show (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> DecommitInvalidReason tx -> ShowS Source # show :: DecommitInvalidReason tx -> String Source # showList :: [DecommitInvalidReason tx] -> ShowS Source #
(Eq (TxIdType tx), Eq (UTxOType tx)) => Eq (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: DecommitInvalidReason tx -> DecommitInvalidReason tx -> Bool Source # (/=) :: DecommitInvalidReason tx -> DecommitInvalidReason tx -> Bool Source #
type Rep (DecommitInvalidReason tx) Source #
Instance details Defined in Hydra.API.ServerOutput type Rep (DecommitInvalidReason tx) = D1 ('MetaData "DecommitInvalidReason" "Hydra.API.ServerOutput" "hydra-node-0.20.0-5pXAEiXeWsXH8K4KfwlMxW" 'False) (C1 ('MetaCons "DecommitTxInvalid" 'PrefixI 'True) (S1 ('MetaSel ('Just "localUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx)) :*: S1 ('MetaSel ('Just "validationError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ValidationError)) :+: C1 ('MetaCons "DecommitAlreadyInFlight" 'PrefixI 'True) (S1 ('MetaSel ('Just "otherDecommitTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx))))

data ServerOutput tx Source #

Individual server output messages as produced by the HeadLogic in the ClientEffect.

Constructors

PeerConnected
Fields peer :: NodeId
PeerDisconnected
Fields peer :: NodeId
PeerHandshakeFailure
Fields remoteHost :: Host ourVersion :: Natural theirVersions :: [Natural]
HeadIsInitializing
Fields headId :: HeadId parties :: [Party]
Committed
Fields headId :: HeadId party :: Party utxo :: UTxOType tx
HeadIsOpen
Fields headId :: HeadId utxo :: UTxOType tx
HeadIsClosed
Fields headId :: HeadId snapshotNumber :: SnapshotNumber contestationDeadline :: UTCTime Nominal deadline until which contest can be submitted and after which fanout is possible. NOTE: Use this only for informational purpose and wait for `ReadyToFanout` instead before sending `Fanout` as the ledger of our cardano-node might not have progressed sufficiently in time yet and we do not re-submit transactions (yet).
HeadIsContested
Fields headId :: HeadId snapshotNumber :: SnapshotNumber contestationDeadline :: UTCTime Nominal deadline until which contest can be submitted and after which fanout is possible. NOTE: Use this only for informational purpose and wait for `ReadyToFanout` instead before sending `Fanout` as the ledger of our cardano-node might not have progressed sufficiently in time yet and we do not re-submit transactions (yet).
ReadyToFanout
Fields headId :: HeadId
HeadIsAborted
Fields headId :: HeadId utxo :: UTxOType tx
HeadIsFinalized
Fields headId :: HeadId utxo :: UTxOType tx
CommandFailed
Fields clientInput :: ClientInput tx state :: HeadState tx
TxValid	Given transaction has been seen as valid in the Head. It is expected to eventually be part of a `SnapshotConfirmed`.
Fields headId :: HeadId transactionId :: TxIdType tx
TxInvalid	Given transaction was not not applicable to the given UTxO in time and has been dropped.
Fields headId :: HeadId utxo :: UTxOType tx transaction :: tx validationError :: ValidationError
SnapshotConfirmed	Given snapshot was confirmed and included transactions can be considered final.
Fields headId :: HeadId snapshot :: Snapshot tx signatures :: MultiSignature (Snapshot tx)
GetUTxOResponse
Fields headId :: HeadId utxo :: UTxOType tx
InvalidInput
Fields reason :: String input :: Text
Greetings	A friendly welcome message which tells a client something about the node. Currently used for knowing what signing key the server uses (it only knows one), `HeadStatus` and optionally (if `HeadIsOpen` or `SnapshotConfirmed` message is emitted) UTxO's present in the Hydra Head.
Fields me :: Party headStatus :: HeadStatus hydraHeadId :: Maybe HeadId snapshotUtxo :: Maybe (UTxOType tx) hydraNodeVersion :: String
PostTxOnChainFailed
Fields postChainTx :: PostChainTx tx postTxError :: PostTxError tx
IgnoredHeadInitializing
Fields headId :: HeadId contestationPeriod :: ContestationPeriod parties :: [Party] participants :: [OnChainId]
DecommitRequested
Fields headId :: HeadId decommitTx :: tx utxoToDecommit :: UTxOType tx
DecommitInvalid
Fields headId :: HeadId decommitTx :: tx decommitInvalidReason :: DecommitInvalidReason tx
DecommitApproved
Fields headId :: HeadId decommitTxId :: TxIdType tx utxoToDecommit :: UTxOType tx
CommitRecorded
Fields headId :: HeadId utxoToCommit :: UTxOType tx pendingDeposit :: TxIdType tx deadline :: UTCTime
CommitApproved
Fields headId :: HeadId utxoToCommit :: UTxOType tx
DecommitFinalized
Fields headId :: HeadId decommitTxId :: TxIdType tx
CommitFinalized
Fields headId :: HeadId theDeposit :: TxIdType tx
CommitRecovered
Fields headId :: HeadId recoveredUTxO :: UTxOType tx recoveredTxId :: TxIdType tx

Instances

Instances details

(ArbitraryIsTx tx, IsChainState tx) => Arbitrary (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods arbitrary :: Gen (ServerOutput tx) shrink :: ServerOutput tx -> [ServerOutput tx]
IsChainState tx => FromJSON (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser (ServerOutput tx) parseJSONList :: Value -> Parser [ServerOutput tx] omittedField :: Maybe (ServerOutput tx)
IsChainState tx => ToJSON (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: ServerOutput tx -> Value toEncoding :: ServerOutput tx -> Encoding toJSONList :: [ServerOutput tx] -> Value toEncodingList :: [ServerOutput tx] -> Encoding omitField :: ServerOutput tx -> Bool
Generic (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep (ServerOutput tx) :: Type -> Type Source # Methods from :: ServerOutput tx -> Rep (ServerOutput tx) x Source # to :: Rep (ServerOutput tx) x -> ServerOutput tx Source #
IsChainState tx => Show (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> ServerOutput tx -> ShowS Source # show :: ServerOutput tx -> String Source # showList :: [ServerOutput tx] -> ShowS Source #
IsChainState tx => Eq (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: ServerOutput tx -> ServerOutput tx -> Bool Source # (/=) :: ServerOutput tx -> ServerOutput tx -> Bool Source #
(ArbitraryIsTx tx, IsChainState tx) => ToADTArbitrary (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods toADTArbitrarySingleton :: Proxy (ServerOutput tx) -> Gen (ADTArbitrarySingleton (ServerOutput tx)) toADTArbitrary :: Proxy (ServerOutput tx) -> Gen (ADTArbitrary (ServerOutput tx))
type Rep (ServerOutput tx) Source #
Instance details Defined in Hydra.API.ServerOutput type Rep (ServerOutput tx) = D1 ('MetaData "ServerOutput" "Hydra.API.ServerOutput" "hydra-node-0.20.0-5pXAEiXeWsXH8K4KfwlMxW" 'False) ((((C1 ('MetaCons "PeerConnected" 'PrefixI 'True) (S1 ('MetaSel ('Just "peer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeId)) :+: (C1 ('MetaCons "PeerDisconnected" 'PrefixI 'True) (S1 ('MetaSel ('Just "peer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NodeId)) :+: C1 ('MetaCons "PeerHandshakeFailure" 'PrefixI 'True) (S1 ('MetaSel ('Just "remoteHost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Host) :: (S1 ('MetaSel ('Just "ourVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: S1 ('MetaSel ('Just "theirVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Natural]))))) :+: ((C1 ('MetaCons "HeadIsInitializing" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party])) :+: C1 ('MetaCons "Committed" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "party") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Party) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))))) :+: (C1 ('MetaCons "HeadIsOpen" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "HeadIsClosed" '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)))))) :+: ((C1 ('MetaCons "HeadIsContested" '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))) :+: (C1 ('MetaCons "ReadyToFanout" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId)) :+: C1 ('MetaCons "HeadIsAborted" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))))) :+: ((C1 ('MetaCons "HeadIsFinalized" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "CommandFailed" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientInput") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ClientInput tx)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HeadState tx)))) :+: (C1 ('MetaCons "TxValid" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx))) :+: C1 ('MetaCons "TxInvalid" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :: (S1 ('MetaSel ('Just "transaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 tx) :: S1 ('MetaSel ('Just "validationError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ValidationError))))))) :+: (((C1 ('MetaCons "SnapshotConfirmed" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "snapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Snapshot tx)) :: S1 ('MetaSel ('Just "signatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MultiSignature (Snapshot tx))))) :+: (C1 ('MetaCons "GetUTxOResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "InvalidInput" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :+: ((C1 ('MetaCons "Greetings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "me") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Party) :: S1 ('MetaSel ('Just "headStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadStatus)) :: (S1 ('MetaSel ('Just "hydraHeadId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe HeadId)) :: (S1 ('MetaSel ('Just "snapshotUtxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (UTxOType tx))) :: S1 ('MetaSel ('Just "hydraNodeVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))) :+: C1 ('MetaCons "PostTxOnChainFailed" 'PrefixI 'True) (S1 ('MetaSel ('Just "postChainTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PostChainTx tx)) :: S1 ('MetaSel ('Just "postTxError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PostTxError tx)))) :+: (C1 ('MetaCons "IgnoredHeadInitializing" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "contestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ContestationPeriod)) :: (S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Party]) :: S1 ('MetaSel ('Just "participants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [OnChainId]))) :+: C1 ('MetaCons "DecommitRequested" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "decommitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 tx) :: S1 ('MetaSel ('Just "utxoToDecommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))))))) :+: ((C1 ('MetaCons "DecommitInvalid" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "decommitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 tx) :: S1 ('MetaSel ('Just "decommitInvalidReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (DecommitInvalidReason tx)))) :+: (C1 ('MetaCons "DecommitApproved" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "decommitTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx)) :: S1 ('MetaSel ('Just "utxoToDecommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx)))) :+: C1 ('MetaCons "CommitRecorded" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxoToCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :: (S1 ('MetaSel ('Just "pendingDeposit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx)) :: S1 ('MetaSel ('Just "deadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime))))) :+: ((C1 ('MetaCons "CommitApproved" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxoToCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "DecommitFinalized" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "decommitTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx)))) :+: (C1 ('MetaCons "CommitFinalized" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "theDeposit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx))) :+: C1 ('MetaCons "CommitRecovered" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "recoveredUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (UTxOType tx)) :*: S1 ('MetaSel ('Just "recoveredTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx)))))))))

data WithUTxO Source #

Whether or not to include full UTxO in server outputs.

Constructors

WithUTxO
WithoutUTxO

Instances

Instances details

Show WithUTxO Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> WithUTxO -> ShowS Source # show :: WithUTxO -> String Source # showList :: [WithUTxO] -> ShowS Source #
Eq WithUTxO Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: WithUTxO -> WithUTxO -> Bool Source # (/=) :: WithUTxO -> WithUTxO -> Bool Source #

newtype ServerOutputConfig Source #

Constructors

ServerOutputConfig
Fields utxoInSnapshot :: WithUTxO

Instances

Instances details

Show ServerOutputConfig Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> ServerOutputConfig -> ShowS Source # show :: ServerOutputConfig -> String Source # showList :: [ServerOutputConfig] -> ShowS Source #
Eq ServerOutputConfig Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: ServerOutputConfig -> ServerOutputConfig -> Bool Source # (/=) :: ServerOutputConfig -> ServerOutputConfig -> Bool Source #

prepareServerOutput Source #

Arguments

:: IsChainState tx
=> ServerOutputConfig	Decide on tx representation
-> TimedServerOutput tx	Server output
-> ByteString	Final output

Replaces the json encoded tx field with it's cbor representation.

NOTE: we deliberately pattern match on all ServerOutput constructors in handleTxOutput so that we don't forget to update this function if they change.

data HeadStatus Source #

All possible Hydra states displayed in the API server outputs.

Constructors

Idle
Initializing
Open
Closed
FanoutPossible
Final

Instances

Instances details

Arbitrary HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput Methods arbitrary :: Gen HeadStatus shrink :: HeadStatus -> [HeadStatus]
FromJSON HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser HeadStatus parseJSONList :: Value -> Parser [HeadStatus] omittedField :: Maybe HeadStatus
ToJSON HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: HeadStatus -> Value toEncoding :: HeadStatus -> Encoding toJSONList :: [HeadStatus] -> Value toEncodingList :: [HeadStatus] -> Encoding omitField :: HeadStatus -> Bool
Generic HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep HeadStatus :: Type -> Type Source # Methods from :: HeadStatus -> Rep HeadStatus x Source # to :: Rep HeadStatus x -> HeadStatus Source #
Show HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> HeadStatus -> ShowS Source # show :: HeadStatus -> String Source # showList :: [HeadStatus] -> ShowS Source #
Eq HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: HeadStatus -> HeadStatus -> Bool Source # (/=) :: HeadStatus -> HeadStatus -> Bool Source #
type Rep HeadStatus Source #
Instance details Defined in Hydra.API.ServerOutput type Rep HeadStatus = D1 ('MetaData "HeadStatus" "Hydra.API.ServerOutput" "hydra-node-0.20.0-5pXAEiXeWsXH8K4KfwlMxW" 'False) ((C1 ('MetaCons "Idle" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Initializing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Open" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "Closed" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "FanoutPossible" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Final" 'PrefixI 'False) (U1 :: Type -> Type))))

data CommitInfo Source #

All information needed to distinguish behavior of the commit endpoint.

Constructors

CannotCommit
NormalCommit HeadId
IncrementalCommit HeadId

projectPendingDeposits :: IsTx tx => [TxIdType tx] -> ServerOutput tx -> [TxIdType tx] Source #

Projection to obtain the list of pending deposits.

projectCommitInfo :: CommitInfo -> ServerOutput tx -> CommitInfo Source #

Projection to obtain CommitInfo needed to draft commit transactions. NOTE: We only want to project HeadId when the Head is in the Initializing state since this is when Head parties need to commit some funds.

projectInitializingHeadId :: Maybe HeadId -> ServerOutput tx -> Maybe HeadId Source #

Projection to obtain the HeadId needed to draft a commit transaction. NOTE: We only want to project HeadId when the Head is in the Initializing state since this is when Head parties need to commit some funds.

projectHeadStatus :: HeadStatus -> ServerOutput tx -> HeadStatus Source #

Projection function related to $sel:headStatus:PeerConnected field in Greetings message.

projectSnapshotUtxo :: Maybe (UTxOType tx) -> ServerOutput tx -> Maybe (UTxOType tx) Source #

Projection of latest confirmed snapshot UTxO.