Add ApiTransactionTimeout newtype, Fix after review

Author: vrom911

docs/docs/dev/architecture/hydra-components.svg

@@ -639,19 +639,23 @@ Submit the transaction through the already open WebSocket connection. Generate t
 cat tx-signed.json | jq -c '{tag: "NewTx", transaction: .}'
 ```
 
+<details>
+<summary>Alternative: use the HTTP API endpoint</summary>
+
 Alternatively, you can submit the transaction using the HTTP API endpoint:
 
 ```shell
 curl -X POST 127.0.0.1:4001/transaction \
   --data @tx-signed.json \
-  --header "Content-Type: application/json"
 ```
 
 The HTTP endpoint provides a synchronous response with different status codes:
 - **200 OK**: Transaction was included in a confirmed snapshot (includes `snapshotNumber`)
 - **202 Accepted**: Transaction was accepted but not yet confirmed
 - **400 Bad Request**: Transaction was rejected due to validation errors (includes `validationError`)
 
+</details>
+
 The transaction will be validated by both `hydra-node`s and either result in a
 `TxInvalid` message with a reason, or a `TxValid` message and a
 `SnapshotConfirmed` with the new UTXO available in the head shortly after.

docs/docs/tutorial/index.md

@@ -1,22 +1,22 @@
 {
     "samples": [
         {
-            "tag": "SubmitHydraTxSubmitted"
+            "tag": "SubmitTxSubmitted"
         },
         {
-            "tag": "SubmitHydraTxInvalid",
+            "tag": "SubmitTxInvalid",
             "validationError": ""
         },
         {
-            "tag": "SubmitHydraTxInvalid",
+            "tag": "SubmitTxInvalid",
             "validationError": "\u0001)e"
         },
         {
-            "tag": "SubmitHydraTxInvalid",
+            "tag": "SubmitTxInvalid",
             "validationError": "=\u000e􂨤p"
         },
         {
-            "tag": "SubmitHydraTxSubmitted"
+            "tag": "SubmitTxSubmitted"
         }
     ],
     "seed": -1369626537

hydra-node/golden/ReasonablySized SubmitHydraTxResponse.json

@@ -10,7 +10,7 @@
                 "tag": "IPv4"
             },
             "apiPort": 18036,
-            "apiTransactionTimeout": -0.833333333334,
+            "apiTransactionTimeout": 0,
             "chainConfig": {
                 "cardanoSigningKey": "a/c/b/c.sk",
                 "cardanoVerificationKeys": [
@@ -145,7 +145,7 @@
                 "tag": "IPv4"
             },
             "apiPort": 20019,
-            "apiTransactionTimeout": 26.4375,
+            "apiTransactionTimeout": 26,
             "chainConfig": {
                 "cardanoSigningKey": "c/b/a/b/c/b.sk",
                 "cardanoVerificationKeys": [
@@ -226,7 +226,7 @@
                 "tag": "IPv4"
             },
             "apiPort": 9965,
-            "apiTransactionTimeout": 17.714285714285,
+            "apiTransactionTimeout": 17,
             "chainConfig": {
                 "initialUTxOFile": "b/c/b/a/a/c.json",
                 "ledgerGenesisFile": "b/c/a.json",
@@ -267,7 +267,7 @@
                 "tag": "IPv4"
             },
             "apiPort": 8054,
-            "apiTransactionTimeout": -23.4,
+            "apiTransactionTimeout": 23,
             "chainConfig": {
                 "cardanoSigningKey": "a/c/a.sk",
                 "cardanoVerificationKeys": [

hydra-node/golden/RunOptions.json

@@ -90,6 +90,7 @@ library
     Hydra.Network.Message
     Hydra.NetworkVersions
     Hydra.Node
+    Hydra.Node.ApiTransactionTimeout
     Hydra.Node.DepositPeriod
     Hydra.Node.EmbedTH
     Hydra.Node.Environment

hydra-node/hydra-node.cabal

@@ -367,7 +367,7 @@ channels:
           $ref: "api.yaml#/components/schemas/Transaction"
       bindings:
         http:
-          type: response
+          type: request
           method: POST
           bindingVersion: '0.1.0'
     subscribe:
@@ -390,7 +390,7 @@ channels:
             $ref: "api.yaml#/components/schemas/PostTxError"
       bindings:
         http:
-          type: request
+          type: response
           method: POST
           bindingVersion: '0.1.0'
 
@@ -401,7 +401,7 @@ channels:
       operationId: submitHydraTxRequest
       message:
         summary: |
-          Hydra transaction to be submitted to the head.
+          A transaction to be submitted to the head.
           Accepts transactions encoded as Base16 CBOR string, TextEnvelope type or JSON.
         payload:
           $ref: "api.yaml#/components/schemas/Transaction"
@@ -414,7 +414,7 @@ channels:
       operationId: submitHydraTxResponse
       message:
         oneOf:
-        - name: SubmitHydraTxConfirmed
+        - name: SubmitTxConfirmed
           summary: 200 OK
           description: Transaction was included in a confirmed snapshot.
           payload:
@@ -423,11 +423,11 @@ channels:
             properties:
               tag:
                 type: string
-                enum: ["SubmitHydraTxConfirmed"]
+                enum: ["SubmitTxConfirmed"]
               snapshotNumber:
                 type: integer
                 minimum: 0
-        - name: SubmitHydraTxInvalid
+        - name: SubmitTxInvalid
           summary: 400 Bad Request
           description: Transaction was rejected due to validation errors.
           payload:
@@ -436,10 +436,10 @@ channels:
             properties:
               tag:
                 type: string
-                enum: ["SubmitHydraTxInvalid"]
+                enum: ["SubmitTxInvalid"]
               validationError:
                 type: string
-        - name: SubmitHydraTxSubmitted
+        - name: SubmitTxSubmitted
           summary: 202 Accepted
           description: Transaction was accepted but not yet confirmed.
           payload:
@@ -448,7 +448,7 @@ channels:
             properties:
               tag:
                 type: string
-                enum: ["SubmitHydraTxSubmitted"]
+                enum: ["SubmitTxSubmitted"]
       bindings:
         http:
           type: response
@@ -3326,7 +3326,7 @@ components:
 
     SubmitHydraTxResponse:
       oneOf:
-        - title: SubmitHydraTxConfirmed
+        - title: SubmitTxConfirmed
           type: object
           additionalProperties: false
           required:
@@ -3335,11 +3335,11 @@ components:
           properties:
             tag:
               type: string
-              enum: ["SubmitHydraTxConfirmed"]
+              enum: ["SubmitTxConfirmed"]
             snapshotNumber:
               type: integer
               minimum: 0
-        - title: SubmitHydraTxInvalid
+        - title: SubmitTxInvalid
           type: object
           additionalProperties: false
           required:
@@ -3348,18 +3348,18 @@ components:
           properties:
             tag:
               type: string
-              enum: ["SubmitHydraTxInvalid"]
+              enum: ["SubmitTxInvalid"]
             validationError:
               type: string
-        - title: SubmitHydraTxSubmitted
+        - title: SubmitTxSubmitted
           type: object
           additionalProperties: false
           required:
             - tag
           properties:
             tag:
               type: string
-              enum: ["SubmitHydraTxSubmitted"]
+              enum: ["SubmitTxSubmitted"]
 
     DepositStatus:
       oneOf:

hydra-node/json-schemas/api.yaml

@@ -16,7 +16,7 @@ data APIServerLog
       { method :: Method
       , path :: PathInfo
       }
-  | APITransactionSubmitted {txid :: String}
+  | APITransactionSubmitted {submittedTxId :: String}
   deriving stock (Eq, Show, Generic)
   deriving anyclass (ToJSON)
 

hydra-node/src/Hydra/API/APIServerLog.hs

@@ -21,6 +21,7 @@ import Hydra.Chain.Direct.State ()
 import Hydra.HeadLogic.State (HeadState (..))
 import Hydra.Ledger (ValidationError (..))
 import Hydra.Logging (Tracer, traceWith)
+import Hydra.Node.ApiTransactionTimeout (ApiTransactionTimeout (..))
 import Hydra.Node.DepositPeriod (toNominalDiffTime)
 import Hydra.Node.Environment (Environment (..))
 import Hydra.Tx (CommitBlueprintTx (..), ConfirmedSnapshot, IsTx (..), Snapshot (..), UTxOType)
@@ -124,45 +125,45 @@ instance (Arbitrary tx, Arbitrary (UTxOType tx), IsTx tx) => Arbitrary (SideLoad
   shrink = \case
     SideLoadSnapshotRequest snapshot -> SideLoadSnapshotRequest <$> shrink snapshot
 
--- | Request to submit a Hydra transaction to the head
+-- | Request to submit a transaction to the head
 newtype SubmitHydraTxRequest tx = SubmitHydraTxRequest
   { submitHydraTx :: tx
   }
   deriving newtype (Eq, Show, Arbitrary)
   deriving newtype (ToJSON, FromJSON)
 
--- | Response for Hydra transaction submission
+-- | Response for transaction submission
 data SubmitHydraTxResponse
   = -- | Transaction was included in a confirmed snapshot
-    SubmitHydraTxConfirmed Integer
+    SubmitTxConfirmed Integer
   | -- | Transaction was rejected due to validation errors
-    SubmitHydraTxInvalidResponse Text
+    SubmitTxInvalidResponse Text
   | -- | Transaction was accepted but not yet confirmed
-    SubmitHydraTxSubmitted
+    SubmitTxSubmitted
   deriving stock (Eq, Show, Generic)
 
 instance ToJSON SubmitHydraTxResponse where
   toJSON = \case
-    SubmitHydraTxConfirmed snapshotNumber ->
+    SubmitTxConfirmed snapshotNumber ->
       object
-        [ "tag" .= Aeson.String "SubmitHydraTxConfirmed"
+        [ "tag" .= Aeson.String "SubmitTxConfirmed"
         , "snapshotNumber" .= snapshotNumber
         ]
-    SubmitHydraTxInvalidResponse validationError ->
+    SubmitTxInvalidResponse validationError ->
       object
-        [ "tag" .= Aeson.String "SubmitHydraTxInvalid"
+        [ "tag" .= Aeson.String "SubmitTxInvalid"
         , "validationError" .= validationError
         ]
-    SubmitHydraTxSubmitted -> object ["tag" .= Aeson.String "SubmitHydraTxSubmitted"]
+    SubmitTxSubmitted -> object ["tag" .= Aeson.String "SubmitTxSubmitted"]
 
 instance FromJSON SubmitHydraTxResponse where
-  parseJSON = withObject "SubmitHydraTxResponse" $ \o -> do
+  parseJSON = withObject "SubmitTxResponse" $ \o -> do
     tag <- o .: "tag"
     case tag :: Text of
-      "SubmitHydraTxConfirmed" -> SubmitHydraTxConfirmed <$> o .: "snapshotNumber"
-      "SubmitHydraTxInvalid" -> SubmitHydraTxInvalidResponse <$> o .: "validationError"
-      "SubmitHydraTxSubmitted" -> pure SubmitHydraTxSubmitted
-      _ -> fail "Expected tag to be SubmitHydraTxConfirmed, SubmitHydraTxInvalid, or SubmitHydraTxSubmitted"
+      "SubmitTxConfirmed" -> SubmitTxConfirmed <$> o .: "snapshotNumber"
+      "SubmitTxInvalid" -> SubmitTxInvalidResponse <$> o .: "validationError"
+      "SubmitTxSubmitted" -> pure SubmitTxSubmitted
+      _ -> fail "Expected tag to be SubmitTxConfirmed, SubmitTxInvalid, or SubmitTxSubmitted"
 
 instance Arbitrary SubmitHydraTxResponse where
   arbitrary = genericArbitrary
@@ -187,7 +188,7 @@ httpApp ::
   -- | Callback to yield a 'ClientInput' to the main event loop.
   (ClientInput tx -> IO ()) ->
   -- | Timeout for transaction submission
-  NominalDiffTime ->
+  ApiTransactionTimeout ->
   -- | Channel to listen for events
   TChan (Either (TimedServerOutput tx) (ClientMessage tx)) ->
   Application
@@ -377,7 +378,7 @@ handleSubmitHydraTx ::
   forall tx.
   IsChainState tx =>
   (ClientInput tx -> IO ()) ->
-  NominalDiffTime ->
+  ApiTransactionTimeout ->
   TChan (Either (TimedServerOutput tx) (ClientMessage tx)) ->
   LBS.ByteString ->
   IO Response
@@ -390,15 +391,18 @@ handleSubmitHydraTx putClientInput apiTransactionTimeout responseChannel body =
       putClientInput (NewTx submitHydraTx)
 
       let txid = txId submitHydraTx
-      result <- timeout (realToFrac apiTransactionTimeout) (waitForTransactionResult txid)
+      result <-
+        timeout
+          (realToFrac (apiTransactionTimeoutNominalDiffTime apiTransactionTimeout))
+          (waitForTransactionResult txid)
 
       case result of
-        Just (SubmitHydraTxConfirmed snapshotNumber) ->
-          pure $ responseLBS status200 jsonContent (Aeson.encode $ SubmitHydraTxConfirmed snapshotNumber)
-        Just (SubmitHydraTxInvalidResponse validationError) ->
-          pure $ responseLBS status400 jsonContent (Aeson.encode $ SubmitHydraTxInvalidResponse validationError)
-        Just SubmitHydraTxSubmitted ->
-          pure $ responseLBS status202 jsonContent (Aeson.encode SubmitHydraTxSubmitted)
+        Just (SubmitTxConfirmed snapshotNumber) ->
+          pure $ responseLBS status200 jsonContent (Aeson.encode $ SubmitTxConfirmed snapshotNumber)
+        Just (SubmitTxInvalidResponse validationError) ->
+          pure $ responseLBS status400 jsonContent (Aeson.encode $ SubmitTxInvalidResponse validationError)
+        Just SubmitTxSubmitted ->
+          pure $ responseLBS status202 jsonContent (Aeson.encode SubmitTxSubmitted)
         Nothing ->
           -- Timeout occurred - return 202 Accepted with timeout info
           pure $
@@ -407,30 +411,29 @@ handleSubmitHydraTx putClientInput apiTransactionTimeout responseChannel body =
               jsonContent
               ( Aeson.encode $
                   object
-                    [ "tag" .= Aeson.String "SubmitHydraTxSubmitted"
+                    [ "tag" .= Aeson.String "SubmitTxSubmitted"
                     , "timeout" .= Aeson.String ("Transaction submission timed out after " <> pack (show apiTransactionTimeout) <> " seconds")
                     ]
               )
  where
   --  Wait for transaction result by listening to events
   waitForTransactionResult :: TxIdType tx -> IO SubmitHydraTxResponse
-  waitForTransactionResult txid = do
-    go
+  waitForTransactionResult txid = go
    where
     go = do
       event <- atomically $ readTChan responseChannel
       case event of
         Left (TimedServerOutput{output}) -> case output of
           TxValid{transactionId}
             | transactionId == txid ->
-                pure SubmitHydraTxSubmitted
+                pure SubmitTxSubmitted
           TxInvalid{transaction, validationError = ValidationError reason}
             | txId transaction == txid ->
-                pure $ SubmitHydraTxInvalidResponse reason
+                pure $ SubmitTxInvalidResponse reason
           SnapshotConfirmed{snapshot} ->
             -- Check if the transaction is in the confirmed snapshot
             if txid `elem` map txId (confirmed snapshot)
-              then pure $ SubmitHydraTxConfirmed (fromIntegral $ number snapshot)
+              then pure $ SubmitTxConfirmed (fromIntegral $ number snapshot)
               else go
           _ -> go
         Right _ -> go

hydra-node/src/Hydra/API/HTTPServer.hs

@@ -41,6 +41,7 @@ import Hydra.HeadLogic.State (
 import Hydra.HeadLogic.StateEvent (StateEvent (..))
 import Hydra.Logging (Tracer, traceWith)
 import Hydra.Network (IP, PortNumber)
+import Hydra.Node.ApiTransactionTimeout (ApiTransactionTimeout)
 import Hydra.Node.Environment (Environment)
 import Hydra.Tx (HeadId, IsTx (..), Party, txId)
 import Network.HTTP.Types (status500)
@@ -72,7 +73,7 @@ data APIServerConfig = APIServerConfig
   , port :: PortNumber
   , tlsCertPath :: Maybe FilePath
   , tlsKeyPath :: Maybe FilePath
-  , apiTransactionTimeout :: NominalDiffTime
+  , apiTransactionTimeout :: ApiTransactionTimeout
   }
 
 withAPIServer ::