Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.HeadLogic.Outcome

Synopsis

data Effect tx
- = ClientEffect {
  - clientMessage :: ClientMessage tx
  }
- | NetworkEffect {
  - message :: Message tx
  }
- | OnChainEffect {
  - postChainTx :: PostChainTx tx
  }
data StateChanged tx
- = NetworkConnected
- | NetworkDisconnected
- | PeerConnected {
  - peer :: Host
  }
- | PeerDisconnected {
  - peer :: Host
  }
- | NetworkVersionMismatch {
  - ourVersion :: ProtocolVersion
  - theirVersion :: Maybe ProtocolVersion
  }
- | NetworkClusterIDMismatch {
  - clusterPeers :: Text
  - misconfiguredPeers :: Text
  }
- | HeadOpened {
  - parameters :: HeadParameters
  - chainState :: ChainStateType tx
  - headId :: HeadId
  - headSeed :: HeadSeed
  - parties :: [Party]
  }
- | TransactionReceived {
  - tx :: tx
  }
- | TransactionAppliedToLocalUTxO {
  - headId :: HeadId
  - tx :: tx
  }
- | SnapshotRequestDecided {
  - snapshotNumber :: SnapshotNumber
  }
- | SnapshotRequested {
  - requestedSnapshot :: Snapshot tx
  - newLocalTxs :: Seq tx
  - newCurrentDepositTxId :: Maybe (TxIdType tx)
  }
- | PartySignedSnapshot {
  - snapshotNumber :: SnapshotNumber
  - party :: Party
  - signature :: Signature (Snapshot tx)
  }
- | SnapshotConfirmed {
  - headId :: HeadId
  - snapshot :: Maybe (Snapshot tx)
  - signatures :: MultiSignature (Snapshot tx)
  }
- | DepositRecorded {
  - chainState :: ChainStateType tx
  - headId :: HeadId
  - depositTxId :: TxIdType tx
  - deposited :: UTxOType tx
  - created :: UTCTime
  - deadline :: UTCTime
  }
- | DepositActivated {
  - depositTxId :: TxIdType tx
  - chainTime :: UTCTime
  - deposit :: Deposit tx
  }
- | DepositExpired {
  - depositTxId :: TxIdType tx
  - chainTime :: UTCTime
  - deposit :: Deposit tx
  }
- | DepositRecovered {
  - chainState :: ChainStateType tx
  - headId :: HeadId
  - depositTxId :: TxIdType tx
  - recovered :: UTxOType tx
  }
- | CommitApproved {
  - headId :: HeadId
  - utxoToCommit :: UTxOType tx
  }
- | CommitFinalized {
  - chainState :: ChainStateType tx
  - headId :: HeadId
  - newVersion :: SnapshotVersion
  - depositTxId :: TxIdType tx
  }
- | DecommitRecorded {
  - headId :: HeadId
  - decommitTx :: tx
  }
- | DecommitApproved {
  - headId :: HeadId
  - decommitTxId :: TxIdType tx
  - utxoToDecommit :: UTxOType tx
  }
- | DecommitInvalid {
  - headId :: HeadId
  - decommitTx :: tx
  - decommitInvalidReason :: DecommitInvalidReason tx
  }
- | DecommitFinalized {
  - chainState :: ChainStateType tx
  - headId :: HeadId
  - distributedUTxO :: UTxOType tx
  - newVersion :: SnapshotVersion
  }
- | HeadClosed {
  - headId :: HeadId
  - snapshotNumber :: SnapshotNumber
  - chainState :: ChainStateType tx
  - contestationDeadline :: UTCTime
  }
- | HeadContested {
  - headId :: HeadId
  - chainState :: ChainStateType tx
  - contestationDeadline :: UTCTime
  - snapshotNumber :: SnapshotNumber
  }
- | HeadIsReadyToFanout {
  - headId :: HeadId
  }
- | HeadFanoutInitiated {
  - headId :: HeadId
  - remainingOutputs :: UTxOType tx
  }
- | HeadPartialFanoutSelected {
  - headId :: HeadId
  - remainingOutputs :: UTxOType tx
  - selection :: UTxOType tx
  }
- | HeadFanoutReverted {
  - headId :: HeadId
  }
- | HeadFannedOut {
  - headId :: HeadId
  - finalizedOutputs :: UTxOType tx
  - chainState :: ChainStateType tx
  }
- | HeadPartialFannedOut {
  - headId :: HeadId
  - distributedOutputs :: UTxOType tx
  - remainingOutputs :: UTxOType tx
  - chainState :: ChainStateType tx
  - mode :: FanoutMode tx
  }
- | ChainRolledBack {
  - chainState :: ChainStateType tx
  }
- | TickObserved {
  - chainPoint :: ChainPointType tx
  - chainTime :: UTCTime
  }
- | IgnoredHeadInitializing {
  - headId :: HeadId
  - contestationPeriod :: ContestationPeriod
  - parties :: [Party]
  - participants :: [OnChainId]
  }
- | TxInvalid {
  - headId :: HeadId
  - utxo :: UTxOType tx
  - transaction :: tx
  - validationError :: ValidationError
  }
- | LocalStateCleared {
  - headId :: HeadId
  - snapshotNumber :: SnapshotNumber
  }
- | Checkpoint {
  - state :: NodeState tx
  }
- | NodeUnsynced {
  - chainSlot :: ChainSlot
  - chainTime :: UTCTime
  - drift :: NominalDiffTime
  }
- | NodeSynced {
  - chainSlot :: ChainSlot
  - chainTime :: UTCTime
  - drift :: NominalDiffTime
  }
data Outcome tx
- = Continue {
  - stateChanges :: [StateChanged tx]
  - effects :: [Effect tx]
  }
- | Wait {
  - reason :: WaitReason tx
  - stateChanges :: [StateChanged tx]
  }
- | Error {
  - error :: LogicError tx
  }
noop :: Outcome tx
wait :: WaitReason tx -> Outcome tx
newState :: StateChanged tx -> Outcome tx
cause :: Effect tx -> Outcome tx
causes :: [Effect tx] -> Outcome tx
changes :: [StateChanged tx] -> Outcome tx
data WaitReason tx
- = WaitOnNotApplicableTx {
  - validationError :: ValidationError
  }
- | WaitOnSnapshotNumber {
  - waitingForNumber :: SnapshotNumber
  }
- | WaitOnSnapshotVersion {
  - waitingForVersion :: SnapshotVersion
  }
- | WaitOnSeenSnapshot
- | WaitOnTxs {
  - waitingForTxIds :: [TxIdType tx]
  }
- | WaitOnContestationDeadline
- | WaitOnNotApplicableDecommitTx {
  - notApplicableReason :: DecommitInvalidReason tx
  }
- | WaitOnUnresolvedCommit {
  - commitUTxO :: UTxOType tx
  }
- | WaitOnUnresolvedDecommit {
  - decommitTx :: tx
  }
- | WaitOnDepositObserved {
  - depositTxId :: TxIdType tx
  }
- | WaitOnDepositActivation {
  - depositTxId :: TxIdType tx
  }
- | WaitOnNodeInSync {
  - currentSlot :: ChainSlot
  }

Documentation

data Effect tx Source #

Analogous to inputs, the pure head logic "core" can have effects emitted to the "shell" layers and we distinguish the same: effects onto the client, the network and the chain.

Constructors

ClientEffect	Effect to be handled by the Hydra.API, results in sending this `ClientMessage`.
Fields clientMessage :: ClientMessage tx
NetworkEffect	Effect to be handled by a Hydra.Network, results in a `broadcast`.
Fields message :: Message tx
OnChainEffect	Effect to be handled by a Hydra.Chain, results in a `postTx`.
Fields postChainTx :: PostChainTx tx

Instances

Instances details

IsChainState tx => ToJSON (Effect tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods toJSON :: Effect tx -> Value toEncoding :: Effect tx -> Encoding toJSONList :: [Effect tx] -> Value toEncodingList :: [Effect tx] -> Encoding omitField :: Effect tx -> Bool
Generic (Effect tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Associated Types type Rep (Effect tx) :: Type -> Type Source # Methods from :: Effect tx -> Rep (Effect tx) x Source # to :: Rep (Effect tx) x -> Effect tx Source #
IsChainState tx => Show (Effect tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods showsPrec :: Int -> Effect tx -> ShowS Source # show :: Effect tx -> String Source # showList :: [Effect tx] -> ShowS Source #
IsChainState tx => Eq (Effect tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods (==) :: Effect tx -> Effect tx -> Bool Source # (/=) :: Effect tx -> Effect tx -> Bool Source #
type Rep (Effect tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome type Rep (Effect tx) = D1 ('MetaData "Effect" "Hydra.HeadLogic.Outcome" "hydra-node-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'False) (C1 ('MetaCons "ClientEffect" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ClientMessage tx))) :+: (C1 ('MetaCons "NetworkEffect" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Message tx))) :+: C1 ('MetaCons "OnChainEffect" 'PrefixI 'True) (S1 ('MetaSel ('Just "postChainTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (PostChainTx tx)))))

data StateChanged tx Source #

Head state changed event. These events represent all the internal state changes, get persisted and processed in an event sourcing manner.

Constructors

NetworkConnected
NetworkDisconnected
PeerConnected
Fields peer :: Host
PeerDisconnected
Fields peer :: Host
NetworkVersionMismatch
Fields ourVersion :: ProtocolVersion theirVersion :: Maybe ProtocolVersion
NetworkClusterIDMismatch
Fields clusterPeers :: Text misconfiguredPeers :: Text
HeadOpened
Fields parameters :: HeadParameters chainState :: ChainStateType tx headId :: HeadId headSeed :: HeadSeed parties :: [Party]
TransactionReceived
Fields tx :: tx
TransactionAppliedToLocalUTxO
Fields headId :: HeadId tx :: tx
SnapshotRequestDecided
Fields snapshotNumber :: SnapshotNumber
SnapshotRequested
Fields requestedSnapshot :: Snapshot tx newLocalTxs :: Seq tx newCurrentDepositTxId :: Maybe (TxIdType tx)
PartySignedSnapshot
Fields snapshotNumber :: SnapshotNumber party :: Party signature :: Signature (Snapshot tx)
SnapshotConfirmed
Fields headId :: HeadId snapshot :: Maybe (Snapshot tx) `Nothing` on the normal signing path (snapshot already in `seenSnapshot`); `Just` only for the side-load path where no preceding `SnapshotRequested` exists. signatures :: MultiSignature (Snapshot tx)
DepositRecorded
Fields chainState :: ChainStateType tx headId :: HeadId depositTxId :: TxIdType tx deposited :: UTxOType tx created :: UTCTime deadline :: UTCTime
DepositActivated
Fields depositTxId :: TxIdType tx chainTime :: UTCTime deposit :: Deposit tx
DepositExpired
Fields depositTxId :: TxIdType tx chainTime :: UTCTime deposit :: Deposit tx
DepositRecovered
Fields chainState :: ChainStateType tx headId :: HeadId depositTxId :: TxIdType tx recovered :: UTxOType tx
CommitApproved
Fields headId :: HeadId utxoToCommit :: UTxOType tx
CommitFinalized
Fields chainState :: ChainStateType tx headId :: HeadId newVersion :: SnapshotVersion depositTxId :: TxIdType tx
DecommitRecorded
Fields headId :: HeadId decommitTx :: tx
DecommitApproved
Fields headId :: HeadId decommitTxId :: TxIdType tx utxoToDecommit :: UTxOType tx
DecommitInvalid
Fields headId :: HeadId decommitTx :: tx decommitInvalidReason :: DecommitInvalidReason tx
DecommitFinalized
Fields chainState :: ChainStateType tx headId :: HeadId distributedUTxO :: UTxOType tx newVersion :: SnapshotVersion
HeadClosed
Fields headId :: HeadId snapshotNumber :: SnapshotNumber chainState :: ChainStateType tx contestationDeadline :: UTCTime
HeadContested
Fields headId :: HeadId chainState :: ChainStateType tx contestationDeadline :: UTCTime snapshotNumber :: SnapshotNumber
HeadIsReadyToFanout
Fields headId :: HeadId
HeadFanoutInitiated	This node initiated a full automatic fanout (`Fanout` command). It transitions `Closed` → `PartialFanout` in `AutoDrain` mode so that this node (the driver) auto-continues draining as chunks are observed. Other parties that merely observe the resulting partial fanout do NOT auto-drive (they go to `AwaitingSelection`). No chain state change (client command).
Fields headId :: HeadId remainingOutputs :: UTxOType tx
HeadPartialFanoutSelected	A user initiated or updated a selective partial fanout. From `Closed` this transitions into the `PartialFanout` state (using `$sel:remainingOutputs:NetworkConnected` as the initial remaining set); from `PartialFanout` it just updates the active selection. No chain state change (driven by a client command).
Fields headId :: HeadId remainingOutputs :: UTxOType tx selection :: UTxOType tx
HeadFanoutReverted	Revert an optimistic `Closed` → `PartialFanout` transition back to `Closed`. Emitted when posting the initiating fanout transaction fails terminally before any partial fanout has landed on chain (i.e. while the off-chain state is `PartialFanout` but the on-chain datum is still `Closed`). Without this the head would wedge in `PartialFanout` with `Fanout` rejected. No chain state change.
Fields headId :: HeadId
HeadFannedOut
Fields headId :: HeadId finalizedOutputs :: UTxOType tx chainState :: ChainStateType tx
HeadPartialFannedOut
Fields headId :: HeadId distributedOutputs :: UTxOType tx remainingOutputs :: UTxOType tx chainState :: ChainStateType tx mode :: FanoutMode tx The fanout mode to continue with after this step (drives whether the node auto-resumes draining or waits for the next `PartialFanout`).
ChainRolledBack
Fields chainState :: ChainStateType tx
TickObserved
Fields chainPoint :: ChainPointType tx chainTime :: UTCTime
IgnoredHeadInitializing
Fields headId :: HeadId contestationPeriod :: ContestationPeriod parties :: [Party] participants :: [OnChainId]
TxInvalid
Fields headId :: HeadId utxo :: UTxOType tx transaction :: tx validationError :: ValidationError
LocalStateCleared
Fields headId :: HeadId snapshotNumber :: SnapshotNumber
Checkpoint
Fields state :: NodeState tx
NodeUnsynced
Fields chainSlot :: ChainSlot chainTime :: UTCTime drift :: NominalDiffTime
NodeSynced
Fields chainSlot :: ChainSlot chainTime :: UTCTime drift :: NominalDiffTime

Instances

Instances details

(IsChainState tx, IsTx tx, FromJSON (NodeState tx), FromJSON (ChainStateType tx)) => FromJSON (StateChanged tx) Source #	Decoded generically, except that a `HeadPartialFannedOut` persisted before the `$sel:mode:NetworkConnected` field existed (event logs from an earlier node) is decoded with `$sel:mode:NetworkConnected` defaulting to `AwaitingSelection`. That is the safe default: the node waits for the next `PartialFanout` rather than assuming an auto-drain, so a node mid-fanout can still restart. All other constructors decode as before.
Instance details Defined in Hydra.HeadLogic.Outcome Methods parseJSON :: Value -> Parser (StateChanged tx) parseJSONList :: Value -> Parser [StateChanged tx] omittedField :: Maybe (StateChanged tx)
(IsChainState tx, IsTx tx, ToJSON (ChainStateType tx)) => ToJSON (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods toJSON :: StateChanged tx -> Value toEncoding :: StateChanged tx -> Encoding toJSONList :: [StateChanged tx] -> Value toEncodingList :: [StateChanged tx] -> Encoding omitField :: StateChanged tx -> Bool
Generic (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Associated Types type Rep (StateChanged tx) :: Type -> Type Source # Methods from :: StateChanged tx -> Rep (StateChanged tx) x Source # to :: Rep (StateChanged tx) x -> StateChanged tx Source #
(IsChainState tx, IsTx tx, Show (NodeState tx), Show (ChainStateType tx)) => Show (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods showsPrec :: Int -> StateChanged tx -> ShowS Source # show :: StateChanged tx -> String Source # showList :: [StateChanged tx] -> ShowS Source #
IsChainState tx => FromCBOR (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods fromCBOR :: Decoder s (StateChanged tx) label :: Proxy (StateChanged tx) -> Text
IsChainState tx => ToCBOR (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods toCBOR :: StateChanged tx -> Encoding encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (StateChanged tx) -> Size encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [StateChanged tx] -> Size
(IsChainState tx, IsTx tx, Eq (NodeState tx), Eq (ChainStateType tx)) => Eq (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods (==) :: StateChanged tx -> StateChanged tx -> Bool Source # (/=) :: StateChanged tx -> StateChanged tx -> Bool Source #
type Rep (StateChanged tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome type Rep (StateChanged tx) = D1 ('MetaData "StateChanged" "Hydra.HeadLogic.Outcome" "hydra-node-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'False) (((((C1 ('MetaCons "NetworkConnected" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NetworkDisconnected" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PeerConnected" 'PrefixI 'True) (S1 ('MetaSel ('Just "peer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Host)) :+: C1 ('MetaCons "PeerDisconnected" 'PrefixI 'True) (S1 ('MetaSel ('Just "peer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Host)))) :+: ((C1 ('MetaCons "NetworkVersionMismatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "ourVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProtocolVersion) :: S1 ('MetaSel ('Just "theirVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProtocolVersion))) :+: C1 ('MetaCons "NetworkClusterIDMismatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "clusterPeers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "misconfiguredPeers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :+: (C1 ('MetaCons "HeadOpened" 'PrefixI 'True) ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadParameters) :: S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx))) :: (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "headSeed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadSeed) :: S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Party])))) :+: (C1 ('MetaCons "TransactionReceived" 'PrefixI 'True) (S1 ('MetaSel ('Just "tx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx)) :+: C1 ('MetaCons "TransactionAppliedToLocalUTxO" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "tx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx)))))) :+: (((C1 ('MetaCons "SnapshotRequestDecided" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotNumber)) :+: C1 ('MetaCons "SnapshotRequested" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestedSnapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Snapshot tx)) :: (S1 ('MetaSel ('Just "newLocalTxs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Seq tx)) :: S1 ('MetaSel ('Just "newCurrentDepositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (TxIdType tx)))))) :+: (C1 ('MetaCons "PartySignedSnapshot" 'PrefixI 'True) (S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotNumber) :: (S1 ('MetaSel ('Just "party") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Party) :: S1 ('MetaSel ('Just "signature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Signature (Snapshot tx))))) :+: (C1 ('MetaCons "SnapshotConfirmed" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "snapshot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snapshot tx))) :: S1 ('MetaSel ('Just "signatures") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (MultiSignature (Snapshot tx))))) :+: C1 ('MetaCons "DepositRecorded" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)) :: (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx)))) :: (S1 ('MetaSel ('Just "deposited") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)) :: (S1 ('MetaSel ('Just "created") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "deadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime))))))) :+: ((C1 ('MetaCons "DepositActivated" 'PrefixI 'True) (S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx)) :: (S1 ('MetaSel ('Just "chainTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "deposit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Deposit tx)))) :+: C1 ('MetaCons "DepositExpired" 'PrefixI 'True) (S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx)) :: (S1 ('MetaSel ('Just "chainTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "deposit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Deposit tx))))) :+: (C1 ('MetaCons "DepositRecovered" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)) :: S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId)) :: (S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx)) :: S1 ('MetaSel ('Just "recovered") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)))) :+: (C1 ('MetaCons "CommitApproved" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxoToCommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "CommitFinalized" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)) :: S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId)) :: (S1 ('MetaSel ('Just "newVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotVersion) :: S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx))))))))) :+: ((((C1 ('MetaCons "DecommitRecorded" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "decommitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx)) :+: C1 ('MetaCons "DecommitApproved" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "decommitTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx)) :: S1 ('MetaSel ('Just "utxoToDecommit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))))) :+: (C1 ('MetaCons "DecommitInvalid" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "decommitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx) :: S1 ('MetaSel ('Just "decommitInvalidReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (DecommitInvalidReason tx)))) :+: (C1 ('MetaCons "DecommitFinalized" 'PrefixI 'True) ((S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)) :: S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId)) :: (S1 ('MetaSel ('Just "distributedUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)) :: S1 ('MetaSel ('Just "newVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotVersion))) :+: C1 ('MetaCons "HeadClosed" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotNumber)) :: (S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)) :: S1 ('MetaSel ('Just "contestationDeadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)))))) :+: ((C1 ('MetaCons "HeadContested" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx))) :: (S1 ('MetaSel ('Just "contestationDeadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotNumber))) :+: C1 ('MetaCons "HeadIsReadyToFanout" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId))) :+: (C1 ('MetaCons "HeadFanoutInitiated" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "remainingOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))) :+: (C1 ('MetaCons "HeadPartialFanoutSelected" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "remainingOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)) :: S1 ('MetaSel ('Just "selection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)))) :+: C1 ('MetaCons "HeadFanoutReverted" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId)))))) :+: (((C1 ('MetaCons "HeadFannedOut" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: (S1 ('MetaSel ('Just "finalizedOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)) :: S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)))) :+: C1 ('MetaCons "HeadPartialFannedOut" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "distributedOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))) :: (S1 ('MetaSel ('Just "remainingOutputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx)) :: (S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx)) :: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (FanoutMode tx)))))) :+: (C1 ('MetaCons "ChainRolledBack" 'PrefixI 'True) (S1 ('MetaSel ('Just "chainState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainStateType tx))) :+: (C1 ('MetaCons "TickObserved" 'PrefixI 'True) (S1 ('MetaSel ('Just "chainPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (ChainPointType tx)) :: S1 ('MetaSel ('Just "chainTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime)) :+: C1 ('MetaCons "IgnoredHeadInitializing" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "contestationPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ContestationPeriod)) :: (S1 ('MetaSel ('Just "parties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Party]) :: S1 ('MetaSel ('Just "participants") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [OnChainId])))))) :+: ((C1 ('MetaCons "TxInvalid" 'PrefixI 'True) ((S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "utxo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))) :: (S1 ('MetaSel ('Just "transaction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx) :: S1 ('MetaSel ('Just "validationError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidationError))) :+: C1 ('MetaCons "LocalStateCleared" 'PrefixI 'True) (S1 ('MetaSel ('Just "headId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HeadId) :: S1 ('MetaSel ('Just "snapshotNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotNumber))) :+: (C1 ('MetaCons "Checkpoint" 'PrefixI 'True) (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NodeState tx))) :+: (C1 ('MetaCons "NodeUnsynced" 'PrefixI 'True) (S1 ('MetaSel ('Just "chainSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChainSlot) :: (S1 ('MetaSel ('Just "chainTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "drift") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NominalDiffTime))) :+: C1 ('MetaCons "NodeSynced" 'PrefixI 'True) (S1 ('MetaSel ('Just "chainSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChainSlot) :: (S1 ('MetaSel ('Just "chainTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UTCTime) :: S1 ('MetaSel ('Just "drift") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NominalDiffTime)))))))))

data Outcome tx Source #

Constructors

Continue	Continue with the given state updates and side effects.
Fields stateChanges :: [StateChanged tx] effects :: [Effect tx]
Wait	Wait for some condition to be met with optional state updates.
Fields reason :: WaitReason tx stateChanges :: [StateChanged tx]
Error	Processing resulted in an error.
Fields error :: LogicError tx

Instances

Instances details

IsChainState tx => ToJSON (Outcome tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods toJSON :: Outcome tx -> Value toEncoding :: Outcome tx -> Encoding toJSONList :: [Outcome tx] -> Value toEncodingList :: [Outcome tx] -> Encoding omitField :: Outcome tx -> Bool
Semigroup (Outcome tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods (<>) :: Outcome tx -> Outcome tx -> Outcome tx Source # sconcat :: NonEmpty (Outcome tx) -> Outcome tx Source # stimes :: Integral b => b -> Outcome tx -> Outcome tx Source #
Generic (Outcome tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Associated Types type Rep (Outcome tx) :: Type -> Type Source # Methods from :: Outcome tx -> Rep (Outcome tx) x Source # to :: Rep (Outcome tx) x -> Outcome tx Source #
IsChainState tx => Show (Outcome tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods showsPrec :: Int -> Outcome tx -> ShowS Source # show :: Outcome tx -> String Source # showList :: [Outcome tx] -> ShowS Source #
IsChainState tx => Eq (Outcome tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods (==) :: Outcome tx -> Outcome tx -> Bool Source # (/=) :: Outcome tx -> Outcome tx -> Bool Source #
type Rep (Outcome tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome type Rep (Outcome tx) = D1 ('MetaData "Outcome" "Hydra.HeadLogic.Outcome" "hydra-node-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'False) (C1 ('MetaCons "Continue" 'PrefixI 'True) (S1 ('MetaSel ('Just "stateChanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StateChanged tx]) :: S1 ('MetaSel ('Just "effects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Effect tx])) :+: (C1 ('MetaCons "Wait" 'PrefixI 'True) (S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (WaitReason tx)) :: S1 ('MetaSel ('Just "stateChanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [StateChanged tx])) :+: C1 ('MetaCons "Error" 'PrefixI 'True) (S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (LogicError tx)))))

noop :: Outcome tx Source #

wait :: WaitReason tx -> Outcome tx Source #

newState :: StateChanged tx -> Outcome tx Source #

cause :: Effect tx -> Outcome tx Source #

causes :: [Effect tx] -> Outcome tx Source #

changes :: [StateChanged tx] -> Outcome tx Source #

data WaitReason tx Source #

Constructors

WaitOnNotApplicableTx
Fields validationError :: ValidationError
WaitOnSnapshotNumber
Fields waitingForNumber :: SnapshotNumber
WaitOnSnapshotVersion
Fields waitingForVersion :: SnapshotVersion
WaitOnSeenSnapshot
WaitOnTxs
Fields waitingForTxIds :: [TxIdType tx]
WaitOnContestationDeadline
WaitOnNotApplicableDecommitTx
Fields notApplicableReason :: DecommitInvalidReason tx
WaitOnUnresolvedCommit
Fields commitUTxO :: UTxOType tx
WaitOnUnresolvedDecommit
Fields decommitTx :: tx
WaitOnDepositObserved
Fields depositTxId :: TxIdType tx
WaitOnDepositActivation
Fields depositTxId :: TxIdType tx
WaitOnNodeInSync
Fields currentSlot :: ChainSlot

Instances

Instances details

IsTx tx => ToJSON (WaitReason tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods toJSON :: WaitReason tx -> Value toEncoding :: WaitReason tx -> Encoding toJSONList :: [WaitReason tx] -> Value toEncodingList :: [WaitReason tx] -> Encoding omitField :: WaitReason tx -> Bool
Generic (WaitReason tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Associated Types type Rep (WaitReason tx) :: Type -> Type Source # Methods from :: WaitReason tx -> Rep (WaitReason tx) x Source # to :: Rep (WaitReason tx) x -> WaitReason tx Source #
IsTx tx => Show (WaitReason tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods showsPrec :: Int -> WaitReason tx -> ShowS Source # show :: WaitReason tx -> String Source # showList :: [WaitReason tx] -> ShowS Source #
IsTx tx => Eq (WaitReason tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome Methods (==) :: WaitReason tx -> WaitReason tx -> Bool Source # (/=) :: WaitReason tx -> WaitReason tx -> Bool Source #
type Rep (WaitReason tx) Source #
Instance details Defined in Hydra.HeadLogic.Outcome type Rep (WaitReason tx) = D1 ('MetaData "WaitReason" "Hydra.HeadLogic.Outcome" "hydra-node-2.3.0-1cgalYNmLJQC1YXlYVq7mp" 'False) (((C1 ('MetaCons "WaitOnNotApplicableTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "validationError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidationError)) :+: (C1 ('MetaCons "WaitOnSnapshotNumber" 'PrefixI 'True) (S1 ('MetaSel ('Just "waitingForNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotNumber)) :+: C1 ('MetaCons "WaitOnSnapshotVersion" 'PrefixI 'True) (S1 ('MetaSel ('Just "waitingForVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SnapshotVersion)))) :+: (C1 ('MetaCons "WaitOnSeenSnapshot" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "WaitOnTxs" 'PrefixI 'True) (S1 ('MetaSel ('Just "waitingForTxIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [TxIdType tx])) :+: C1 ('MetaCons "WaitOnContestationDeadline" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "WaitOnNotApplicableDecommitTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "notApplicableReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (DecommitInvalidReason tx))) :+: (C1 ('MetaCons "WaitOnUnresolvedCommit" 'PrefixI 'True) (S1 ('MetaSel ('Just "commitUTxO") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (UTxOType tx))) :+: C1 ('MetaCons "WaitOnUnresolvedDecommit" 'PrefixI 'True) (S1 ('MetaSel ('Just "decommitTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 tx)))) :+: (C1 ('MetaCons "WaitOnDepositObserved" 'PrefixI 'True) (S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx))) :+: (C1 ('MetaCons "WaitOnDepositActivation" 'PrefixI 'True) (S1 ('MetaSel ('Just "depositTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (TxIdType tx))) :+: C1 ('MetaCons "WaitOnNodeInSync" 'PrefixI 'True) (S1 ('MetaSel ('Just "currentSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChainSlot))))))