Rename to SubmitL2Tx

Author: vrom911

hydra-node/golden/ReasonablySized (SubmitHydraTxRequest (Tx ConwayEra)).json renamed to hydra-node/golden/ReasonablySized (SubmitL2TxRequest (Tx ConwayEra)).json

@@ -398,7 +398,7 @@ channels:
     servers:
       - localhost-http
     publish:
-      operationId: submitHydraTxRequest
+      operationId: submitL2TxRequest
       message:
         summary: |
           A transaction to be submitted to the head.
@@ -411,7 +411,7 @@ channels:
           method: POST
           bindingVersion: '0.1.0'
     subscribe:
-      operationId: submitHydraTxResponse
+      operationId: submitL2TxResponse
       message:
         oneOf:
         - name: SubmitTxConfirmed
@@ -3324,7 +3324,7 @@ components:
         status:
           $ref: "api.yaml#/components/schemas/DepositStatus"
 
-    SubmitHydraTxResponse:
+    SubmitL2TxResponse:
       oneOf:
         - title: SubmitTxConfirmed
           type: object

hydra-node/golden/ReasonablySized SubmitHydraTxResponse.json renamed to hydra-node/golden/ReasonablySized SubmitL2TxResponse.json

@@ -126,14 +126,14 @@ instance (Arbitrary tx, Arbitrary (UTxOType tx), IsTx tx) => Arbitrary (SideLoad
     SideLoadSnapshotRequest snapshot -> SideLoadSnapshotRequest <$> shrink snapshot
 
 -- | Request to submit a transaction to the head
-newtype SubmitHydraTxRequest tx = SubmitHydraTxRequest
-  { submitHydraTx :: tx
+newtype SubmitL2TxRequest tx = SubmitL2TxRequest
+  { submitL2Tx :: tx
   }
   deriving newtype (Eq, Show, Arbitrary)
   deriving newtype (ToJSON, FromJSON)
 
 -- | Response for transaction submission
-data SubmitHydraTxResponse
+data SubmitL2TxResponse
   = -- | Transaction was included in a confirmed snapshot
     SubmitTxConfirmed Integer
   | -- | Transaction was rejected due to validation errors
@@ -142,7 +142,7 @@ data SubmitHydraTxResponse
     SubmitTxSubmitted
   deriving stock (Eq, Show, Generic)
 
-instance ToJSON SubmitHydraTxResponse where
+instance ToJSON SubmitL2TxResponse where
   toJSON = \case
     SubmitTxConfirmed snapshotNumber ->
       object
@@ -156,7 +156,7 @@ instance ToJSON SubmitHydraTxResponse where
         ]
     SubmitTxSubmitted -> object ["tag" .= Aeson.String "SubmitTxSubmitted"]
 
-instance FromJSON SubmitHydraTxResponse where
+instance FromJSON SubmitL2TxResponse where
   parseJSON = withObject "SubmitTxResponse" $ \o -> do
     tag <- o .: "tag"
     case tag :: Text of
@@ -165,7 +165,7 @@ instance FromJSON SubmitHydraTxResponse where
       "SubmitTxSubmitted" -> pure SubmitTxSubmitted
       _ -> fail "Expected tag to be SubmitTxConfirmed, SubmitTxInvalid, or SubmitTxSubmitted"
 
-instance Arbitrary SubmitHydraTxResponse where
+instance Arbitrary SubmitL2TxResponse where
   arbitrary = genericArbitrary
 
 jsonContent :: ResponseHeaders
@@ -240,7 +240,7 @@ httpApp tracer directChain env pparams getHeadState getCommitInfo getPendingDepo
         >>= respond
     ("POST", ["transaction"]) ->
       consumeRequestBodyStrict request
-        >>= handleSubmitHydraTx putClientInput apiTransactionTimeout responseChannel
+        >>= handleSubmitL2Tx putClientInput apiTransactionTimeout responseChannel
         >>= respond
     _ ->
       respond $ responseLBS status400 jsonContent . Aeson.encode $ Aeson.String "Resource not found"
@@ -373,27 +373,27 @@ handleSideLoadSnapshot putClientInput body = do
       putClientInput $ SideLoadSnapshot snapshot
       pure $ responseLBS status200 jsonContent (Aeson.encode $ Aeson.String "OK")
 
--- | Handle request to submit a hydra transaction to the head.
-handleSubmitHydraTx ::
+-- | Handle request to submit a transaction to the head.
+handleSubmitL2Tx ::
   forall tx.
   IsChainState tx =>
   (ClientInput tx -> IO ()) ->
   ApiTransactionTimeout ->
   TChan (Either (TimedServerOutput tx) (ClientMessage tx)) ->
   LBS.ByteString ->
   IO Response
-handleSubmitHydraTx putClientInput apiTransactionTimeout responseChannel body = do
-  case Aeson.eitherDecode' @(SubmitHydraTxRequest tx) body of
+handleSubmitL2Tx putClientInput apiTransactionTimeout responseChannel body = do
+  case Aeson.eitherDecode' @(SubmitL2TxRequest tx) body of
     Left err ->
       pure $ responseLBS status400 jsonContent (Aeson.encode $ Aeson.String $ pack err)
-    Right SubmitHydraTxRequest{submitHydraTx} -> do
+    Right SubmitL2TxRequest{submitL2Tx} -> do
       -- Duplicate the channel to avoid consuming messages from other consumers.
       dupChannel <- atomically $ dupTChan responseChannel
 
       -- Submit the transaction to the head
-      putClientInput (NewTx submitHydraTx)
+      putClientInput (NewTx submitL2Tx)
 
-      let txid = txId submitHydraTx
+      let txid = txId submitL2Tx
       result <-
         timeout
           (realToFrac (apiTransactionTimeoutNominalDiffTime apiTransactionTimeout))
@@ -420,7 +420,7 @@ handleSubmitHydraTx putClientInput apiTransactionTimeout responseChannel body =
               )
  where
   --  Wait for transaction result by listening to events
-  waitForTransactionResult :: TChan (Either (TimedServerOutput tx) (ClientMessage tx)) -> TxIdType tx -> IO SubmitHydraTxResponse
+  waitForTransactionResult :: TChan (Either (TimedServerOutput tx) (ClientMessage tx)) -> TxIdType tx -> IO SubmitL2TxResponse
   waitForTransactionResult dupChannel txid = go
    where
     go = do

hydra-node/json-schemas/api.yaml

@@ -14,8 +14,8 @@ import Hydra.API.HTTPServer (
   DraftCommitTxRequest (..),
   DraftCommitTxResponse (..),
   SideLoadSnapshotRequest (..),
-  SubmitHydraTxRequest (..),
-  SubmitHydraTxResponse (..),
+  SubmitL2TxRequest (..),
+  SubmitL2TxResponse (..),
   SubmitTxRequest (..),
   TransactionSubmitted,
   httpApp,
@@ -67,8 +67,8 @@ spec = do
     roundtripAndGoldenSpecs (Proxy @(ReasonablySized TransactionSubmitted))
     roundtripAndGoldenSpecs (Proxy @(ReasonablySized (SideLoadSnapshotRequest Tx)))
     roundtripAndGoldenSpecs (Proxy @(ReasonablySized (HeadState Tx)))
-    roundtripAndGoldenSpecs (Proxy @(ReasonablySized SubmitHydraTxResponse))
-    roundtripAndGoldenSpecs (Proxy @(ReasonablySized (SubmitHydraTxRequest Tx)))
+    roundtripAndGoldenSpecs (Proxy @(ReasonablySized SubmitL2TxResponse))
+    roundtripAndGoldenSpecs (Proxy @(ReasonablySized (SubmitL2TxRequest Tx)))
 
     prop "Validate /commit publish api schema" $
       prop_validateJSONSchema @(DraftCommitTxRequest Tx) "api.json" $
@@ -175,18 +175,18 @@ spec = do
           . key "message"
 
     prop "Validate /transaction publish api schema" $
-      prop_validateJSONSchema @(SubmitHydraTxRequest Tx) "api.json" $
+      prop_validateJSONSchema @(SubmitL2TxRequest Tx) "api.json" $
         key "channels"
           . key "/transaction"
           . key "publish"
           . key "message"
           . key "payload"
 
     prop "Validate /transaction subscribe api schema" $
-      prop_validateJSONSchema @SubmitHydraTxResponse "api.json" $
+      prop_validateJSONSchema @SubmitL2TxResponse "api.json" $
         key "components"
           . key "schemas"
-          . key "SubmitHydraTxResponse"
+          . key "SubmitL2TxResponse"
 
     apiServerSpec
     describe "SubmitTxRequest accepted tx formats" $ do
@@ -562,7 +562,7 @@ apiServerSpec = do
                 _ -> 500
 
     describe "POST /transaction" $ do
-      let mkReq tx = encode $ SubmitHydraTxRequest tx
+      let mkReq tx = encode $ SubmitL2TxRequest tx
           testTx = SimpleTx 42 mempty mempty
           testHeadId = generateWith arbitrary 42
       now <- runIO getCurrentTime