Add AssertionFailed logic error outcome and use it onDecrementTx

This, at least, results in log lines if this situation occurrs.
cardano-scaling · Jul 17, 2024 · deb4923 · deb4923
1 parent 51852cf
commit deb4923
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/hydra-node/json-schemas/logs.yaml b/hydra-node/json-schemas/logs.yaml
@@ -961,6 +961,20 @@ definitions:
           requirementFailure:
             $ref: "logs.yaml#/definitions/RequirementFailure"
 
+      - title: AssertionFailed
+        description: >-
+          An unexpected situation arose in the implementation of the protocol logic. This is different to 'RequireFailed' as these conditions are not defined in the specified protocol.
+        additionalProperties: false
+        required:
+          - tag
+          - message
+        properties:
+          tag:
+            type: string
+            enum: ["AssertionFailed"]
+          message:
+            type: string
+
       - title: NotOurHead
         description: >-
           We just observed an on-chain event that does not apply to

diff --git a/hydra-node/src/Hydra/HeadLogic.hs b/hydra-node/src/Hydra/HeadLogic.hs
@@ -844,7 +844,7 @@ onOpenChainDecrementTx ::
 onOpenChainDecrementTx Environment{party} openState newVersion distributedTxOuts =
   -- Spec: if outputs(txω) = 𝑈ω
   case decommitTx of
-    Nothing -> noop -- TODO: what if decommit observed but none pending?
+    Nothing -> Error $ AssertionFailed "decrement observed but no decommit pending"
     Just tx
       | outputsOfTx tx == distributedTxOuts ->
           -- Spec: txω ← ⊥
@@ -854,7 +854,7 @@ onOpenChainDecrementTx Environment{party} openState newVersion distributedTxOuts
             -- Spec: if ŝ = ̅S.s ∧ leader(̅S.s + 1) = i
             --         multicast (reqSn, v, ̅S.s + 1, T̂ , txω )
             & maybeRequestSnapshot
-      | otherwise -> noop -- TODO: what if decrement not matching pending decommit?
+      | otherwise -> Error $ AssertionFailed "decrement not matching pending decommit"
  where
   maybeRequestSnapshot outcome =
     if seenSn == confirmedSn && isLeader parameters party nextSn

diff --git a/hydra-node/src/Hydra/HeadLogic/Error.hs b/hydra-node/src/Hydra/HeadLogic/Error.hs
@@ -16,6 +16,7 @@ import Hydra.Snapshot (SnapshotNumber, SnapshotVersion)
 data LogicError tx
   = UnhandledInput {input :: Input tx, currentHeadState :: HeadState tx}
   | RequireFailed {requirementFailure :: RequirementFailure tx}
+  | AssertionFailed {message :: Text}
   | NotOurHead {ourHeadId :: HeadId, otherHeadId :: HeadId}
   deriving stock (Generic)