Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.API.ServerOutput

Synopsis

data TimedServerOutput tx = TimedServerOutput {
- output :: ServerOutput tx
- seq :: Natural
- time :: UTCTime
}
data DecommitInvalidReason tx
- = DecommitTxInvalid {
  - localUTxO :: UTxOType tx
  - validationError :: ValidationError
  }
- | DecommitAlreadyInFlight {
  - otherDecommitTxId :: TxIdType tx
  }
data ClientMessage tx
- = CommandFailed {
  - clientInput :: ClientInput tx
  - state :: HeadState tx
  }
- | PostTxOnChainFailed {
  - postChainTx :: PostChainTx tx
  - postTxError :: PostTxError tx
  }
data Greetings tx = Greetings {
- me :: Party
- headStatus :: HeadStatus
- hydraHeadId :: Maybe HeadId
- snapshotUtxo :: Maybe (UTxOType tx)
- hydraNodeVersion :: String
}
data InvalidInput = InvalidInput {
- reason :: String
- input :: Text
}
data ServerOutput tx
- = NetworkConnected
- | NetworkDisconnected
- | NetworkVersionMismatch {
  - ourVersion :: ProtocolVersion
  - theirVersion :: Maybe ProtocolVersion
  }
- | PeerConnected {
  - peer :: Host
  }
- | PeerDisconnected {
  - peer :: Host
  }
- | 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
  }
- | TxValid {
  - headId :: HeadId
  - transactionId :: TxIdType tx
  - transaction :: tx
  }
- | TxInvalid {
  - headId :: HeadId
  - utxo :: UTxOType tx
  - transaction :: tx
  - validationError :: ValidationError
  }
- | SnapshotConfirmed {
  - headId :: HeadId
  - snapshot :: Snapshot tx
  - signatures :: MultiSignature (Snapshot 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
  }
- | DecommitFinalized {
  - headId :: HeadId
  - decommitTxId :: TxIdType tx
  }
- | CommitRecorded {
  - headId :: HeadId
  - utxoToCommit :: UTxOType tx
  - pendingDeposit :: TxIdType tx
  - deadline :: UTCTime
  }
- | CommitApproved {
  - headId :: HeadId
  - utxoToCommit :: UTxOType tx
  }
- | CommitFinalized {
  - headId :: HeadId
  - depositTxId :: TxIdType tx
  }
- | CommitRecovered {
  - headId :: HeadId
  - recoveredUTxO :: UTxOType tx
  - recoveredTxId :: TxIdType tx
  }
- | SnapshotSideLoaded {
  - headId :: HeadId
  - snapshotNumber :: SnapshotNumber
  }
data WithUTxO
- = WithUTxO
- | WithoutUTxO
data WithAddressedTx
- = WithAddressedTx Text
- | WithoutAddressedTx
data ServerOutputConfig = ServerOutputConfig {
- utxoInSnapshot :: WithUTxO
- addressInTx :: WithAddressedTx
}
prepareServerOutput :: IsChainState tx => ServerOutputConfig -> TimedServerOutput tx -> ByteString
removeSnapshotUTxO :: ByteString -> ByteString
handleUtxoInclusion :: ServerOutputConfig -> (a -> a) -> a -> a
data HeadStatus
- = Idle
- | Initializing
- | Open
- | Closed
- | FanoutPossible
- | Final
data CommitInfo
- = CannotCommit
- | NormalCommit HeadId
- | IncrementalCommit HeadId

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.21.0-IAzUD3nPoh4KjMRMHOKHuC" '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))))

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.21.0-IAzUD3nPoh4KjMRMHOKHuC" '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 ClientMessage tx Source #

Individual messages as produced by the HeadLogic in the ClientEffect.

Constructors

CommandFailed
Fields clientInput :: ClientInput tx state :: HeadState tx
PostTxOnChainFailed
Fields postChainTx :: PostChainTx tx postTxError :: PostTxError tx

Instances

Instances details

(IsChainState tx, ArbitraryIsTx tx) => Arbitrary (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods arbitrary :: Gen (ClientMessage tx) shrink :: ClientMessage tx -> [ClientMessage tx]
IsChainState tx => FromJSON (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser (ClientMessage tx) parseJSONList :: Value -> Parser [ClientMessage tx] omittedField :: Maybe (ClientMessage tx)
IsChainState tx => ToJSON (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: ClientMessage tx -> Value toEncoding :: ClientMessage tx -> Encoding toJSONList :: [ClientMessage tx] -> Value toEncodingList :: [ClientMessage tx] -> Encoding omitField :: ClientMessage tx -> Bool
Generic (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep (ClientMessage tx) :: Type -> Type Source # Methods from :: ClientMessage tx -> Rep (ClientMessage tx) x Source # to :: Rep (ClientMessage tx) x -> ClientMessage tx Source #
IsChainState tx => Show (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> ClientMessage tx -> ShowS Source # show :: ClientMessage tx -> String Source # showList :: [ClientMessage tx] -> ShowS Source #
IsChainState tx => Eq (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: ClientMessage tx -> ClientMessage tx -> Bool Source # (/=) :: ClientMessage tx -> ClientMessage tx -> Bool Source #
type Rep (ClientMessage tx) Source #
Instance details Defined in Hydra.API.ServerOutput type Rep (ClientMessage tx) = D1 ('MetaData "ClientMessage" "Hydra.API.ServerOutput" "hydra-node-0.21.0-IAzUD3nPoh4KjMRMHOKHuC" 'False) (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 "PostTxOnChainFailed" 'PrefixI 'True) (S1 ('MetaSel ('Just "postChainTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PostChainTx tx)) :: S1 ('MetaSel ('Just "postTxError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PostTxError tx))))

data Greetings tx Source #

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.

Constructors

Greetings
Fields me :: Party headStatus :: HeadStatus hydraHeadId :: Maybe HeadId snapshotUtxo :: Maybe (UTxOType tx) hydraNodeVersion :: String

Instances

Instances details

ArbitraryIsTx tx => Arbitrary (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods arbitrary :: Gen (Greetings tx) shrink :: Greetings tx -> [Greetings tx]
IsChainState tx => FromJSON (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser (Greetings tx) parseJSONList :: Value -> Parser [Greetings tx] omittedField :: Maybe (Greetings tx)
IsChainState tx => ToJSON (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: Greetings tx -> Value toEncoding :: Greetings tx -> Encoding toJSONList :: [Greetings tx] -> Value toEncodingList :: [Greetings tx] -> Encoding omitField :: Greetings tx -> Bool
Generic (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep (Greetings tx) :: Type -> Type Source # Methods from :: Greetings tx -> Rep (Greetings tx) x Source # to :: Rep (Greetings tx) x -> Greetings tx Source #
IsChainState tx => Show (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> Greetings tx -> ShowS Source # show :: Greetings tx -> String Source # showList :: [Greetings tx] -> ShowS Source #
IsChainState tx => Eq (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: Greetings tx -> Greetings tx -> Bool Source # (/=) :: Greetings tx -> Greetings tx -> Bool Source #
type Rep (Greetings tx) Source #
Instance details Defined in Hydra.API.ServerOutput type Rep (Greetings tx) = D1 ('MetaData "Greetings" "Hydra.API.ServerOutput" "hydra-node-0.21.0-IAzUD3nPoh4KjMRMHOKHuC" 'False) (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)))))

data InvalidInput Source #

Constructors

InvalidInput
Fields reason :: String input :: Text

Instances

Instances details

FromJSON InvalidInput Source #
Instance details Defined in Hydra.API.ServerOutput Methods parseJSON :: Value -> Parser InvalidInput parseJSONList :: Value -> Parser [InvalidInput] omittedField :: Maybe InvalidInput
ToJSON InvalidInput Source #
Instance details Defined in Hydra.API.ServerOutput Methods toJSON :: InvalidInput -> Value toEncoding :: InvalidInput -> Encoding toJSONList :: [InvalidInput] -> Value toEncodingList :: [InvalidInput] -> Encoding omitField :: InvalidInput -> Bool
Generic InvalidInput Source #
Instance details Defined in Hydra.API.ServerOutput Associated Types type Rep InvalidInput :: Type -> Type Source # Methods from :: InvalidInput -> Rep InvalidInput x Source # to :: Rep InvalidInput x -> InvalidInput Source #
Show InvalidInput Source #
Instance details Defined in Hydra.API.ServerOutput Methods showsPrec :: Int -> InvalidInput -> ShowS Source # show :: InvalidInput -> String Source # showList :: [InvalidInput] -> ShowS Source #
Eq InvalidInput Source #
Instance details Defined in Hydra.API.ServerOutput Methods (==) :: InvalidInput -> InvalidInput -> Bool Source # (/=) :: InvalidInput -> InvalidInput -> Bool Source #
type Rep InvalidInput Source #
Instance details Defined in Hydra.API.ServerOutput type Rep InvalidInput = D1 ('MetaData "InvalidInput" "Hydra.API.ServerOutput" "hydra-node-0.21.0-IAzUD3nPoh4KjMRMHOKHuC" 'False) (C1 ('MetaCons "InvalidInput" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data ServerOutput tx Source #

Constructors

NetworkConnected
NetworkDisconnected
NetworkVersionMismatch
Fields ourVersion :: ProtocolVersion theirVersion :: Maybe ProtocolVersion
PeerConnected
Fields peer :: Host
PeerDisconnected
Fields peer :: Host
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
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 transaction :: 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)
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
DecommitFinalized
Fields headId :: HeadId decommitTxId :: TxIdType tx
CommitRecorded
Fields headId :: HeadId utxoToCommit :: UTxOType tx pendingDeposit :: TxIdType tx deadline :: UTCTime
CommitApproved
Fields headId :: HeadId utxoToCommit :: UTxOType tx
CommitFinalized
Fields headId :: HeadId depositTxId :: TxIdType tx
CommitRecovered
Fields headId :: HeadId recoveredUTxO :: UTxOType tx recoveredTxId :: TxIdType tx
SnapshotSideLoaded	Snapshot was side-loaded, and the included transactions can be considered final. The local state has been reset, meaning pending transactions were pruned. Any signing round has been discarded, and the snapshot leader has changed accordingly.
Fields headId :: HeadId snapshotNumber :: SnapshotNumber

Instances

Instances details

ArbitraryIsTx 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.21.0-IAzUD3nPoh4KjMRMHOKHuC" 'False) ((((C1 ('MetaCons "NetworkConnected" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NetworkDisconnected" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NetworkVersionMismatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "ourVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ProtocolVersion) :: S1 ('MetaSel ('Just "theirVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProtocolVersion))))) :+: (C1 ('MetaCons "PeerConnected" 'PrefixI 'True) (S1 ('MetaSel ('Just "peer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Host)) :+: (C1 ('MetaCons "PeerDisconnected" 'PrefixI 'True) (S1 ('MetaSel ('Just "peer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Host)) :+: 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 "TxValid" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "transactionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType tx)) :: S1 ('MetaSel ('Just "transaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 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 "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 "DecommitFinalized" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "decommitTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TxIdType 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 "CommitFinalized" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "depositTxId") '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)))) :+: C1 ('MetaCons "SnapshotSideLoaded" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 HeadId) :: S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SnapshotNumber)))))))

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 #

data WithAddressedTx Source #

Whether or not to filter transaction server outputs by given address.

Constructors

WithAddressedTx Text
WithoutAddressedTx

Instances

Instances details

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

data ServerOutputConfig Source #

Constructors

ServerOutputConfig
Fields utxoInSnapshot :: WithUTxO addressInTx :: WithAddressedTx

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.

removeSnapshotUTxO :: ByteString -> ByteString Source #

handleUtxoInclusion :: ServerOutputConfig -> (a -> a) -> a -> a Source #

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.21.0-IAzUD3nPoh4KjMRMHOKHuC" '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