Merge pull request #1129 from input-output-hk/submit-tx-in-cbor

Accept three types of encoding in submit-transaction endpoint

CHANGELOG.md

@@ -10,6 +10,9 @@ changes.
 
 ## [0.14.0] - UNRELEASED
 
+- Hydra node API `submit-transaction` endpoint now accepts three types of
+  encoding: Base16 encoded CBOR string, TextEnvelope type and JSON.
+
 - **BREAKING** Introduce messages resending logic in the `Network`
   layer to improve reliability in the face of transient connection
   issues

hydra-cluster/src/Hydra/Cluster/Scenarios.hs

@@ -28,7 +28,6 @@ import Hydra.API.HTTPServer (
   DraftCommitTxRequest (..),
   DraftCommitTxResponse (..),
   ScriptInfo (..),
-  SubmitTxRequest (..),
   TransactionSubmitted (..),
   TxOutWithWitness (..),
  )
@@ -49,6 +48,7 @@ import Hydra.Cardano.Api (
   mkVkAddress,
   selectLovelace,
   signTx,
+  toLedgerTx,
   toScriptData,
   writeFileTextEnvelope,
  )
@@ -419,7 +419,7 @@ canSubmitTransactionThroughAPI ::
   TxId ->
   IO ()
 canSubmitTransactionThroughAPI tracer workDir node hydraScriptsTxId =
-  (`finally` returnFundsToFaucet tracer node Alice) $ do
+   (`finally` returnFundsToFaucet tracer node Alice) $ do
     refuelIfNeeded tracer node Alice 25_000_000
     aliceChainConfig <- chainConfigFor Alice workDir nodeSocket [] $ UnsafeContestationPeriod 100
     let hydraNodeId = 1
@@ -442,14 +442,16 @@ canSubmitTransactionThroughAPI tracer workDir node hydraScriptsTxId =
         Left e -> failure $ show e
         Right body -> do
           let unsignedTx = makeSignedTransaction [] body
-          let unsignedRequest = SubmitTxRequest{txToSubmit = unsignedTx}
+          let unsignedRequest = toJSON $ toLedgerTx unsignedTx
           sendRequest hydraNodeId unsignedRequest
             `shouldThrow` expectErrorStatus 400 (Just "MissingVKeyWitnessesUTXOW")
 
-          let signedRequest = SubmitTxRequest{txToSubmit = signTx cardanoBobSk unsignedTx}
+          let signedTx = signTx cardanoBobSk unsignedTx
+          let signedRequest = toJSON $ toLedgerTx signedTx
           (sendRequest hydraNodeId signedRequest <&> responseBody)
             `shouldReturn` TransactionSubmitted
  where
+
   RunningNode{networkId, nodeSocket} = node
   sendRequest hydraNodeId tx =
     runReq defaultHttpConfig $

hydra-node/json-schemas/api.yaml

@@ -158,8 +158,12 @@ channels:
       message:
         summary: |
           Cardano transaction to be submitted to the L1 network.
+          Accepts transactions encoded as Base16 CBOR string, TextEnvelope type or JSON.
         payload:
-          $ref: "api.yaml#/components/schemas/Transaction"
+          oneOf:
+              - $ref: "api.yaml#/components/schemas/RawTransaction"
+              - $ref: "api.yaml#/components/schemas/TextEnvelopeTransaction"
+              - $ref: "api.yaml#/components/schemas/Transaction"
       bindings:
         http:
           type: response

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

@@ -120,18 +120,12 @@ instance Arbitrary DraftCommitTxRequest where
   shrink = \case
     DraftCommitTxRequest u -> DraftCommitTxRequest <$> shrink u
 
-newtype SubmitTxRequest = SubmitTxRequest
-  { txToSubmit :: Tx
+newtype SubmitTxRequest tx = SubmitTxRequest
+  { txToSubmit :: tx
   }
-  deriving stock (Eq, Show, Generic)
+  deriving newtype (Eq, Show, Arbitrary)
   deriving newtype (ToJSON, FromJSON)
 
-instance Arbitrary SubmitTxRequest where
-  arbitrary = genericArbitrary
-
-  shrink = \case
-    SubmitTxRequest u -> SubmitTxRequest <$> shrink u
-
 data TransactionSubmitted = TransactionSubmitted
   deriving stock (Eq, Show, Generic)
 
@@ -302,10 +296,10 @@ handleSubmitUserTx ::
   LBS.ByteString ->
   IO Response
 handleSubmitUserTx directChain body = do
-  case Aeson.eitherDecode' body :: Either String SubmitTxRequest of
+  case Aeson.eitherDecode' body :: Either String Tx of
     Left err ->
       pure $ responseLBS status400 [] (Aeson.encode $ Aeson.String $ pack err)
-    Right SubmitTxRequest{txToSubmit} -> do
+    Right txToSubmit -> do
       try (submitTx txToSubmit) <&> \case
         Left (e :: PostTxError Tx) -> return400 e
         Right _ ->

hydra-node/test/Hydra/API/HTTPServerSpec.hs

@@ -5,24 +5,28 @@ module Hydra.API.HTTPServerSpec where
 import Hydra.Prelude hiding (get)
 import Test.Hydra.Prelude
 
-import Data.Aeson (encode)
+import Cardano.Binary (serialize')
+import Data.Aeson (Result (Error, Success), Value (String), encode, fromJSON)
 import Data.Aeson.Lens (key, nth)
-import Hydra.API.HTTPServer (DraftCommitTxRequest, DraftCommitTxResponse, SubmitTxRequest, TransactionSubmitted, httpApp)
+import qualified Data.ByteString.Base16 as Base16
+import Hydra.API.HTTPServer (DraftCommitTxRequest, DraftCommitTxResponse, SubmitTxRequest (..), TransactionSubmitted, httpApp)
 import Hydra.API.ServerSpec (dummyChainHandle)
+import Hydra.Cardano.Api (toLedgerTx, serialiseToTextEnvelope)
 import Hydra.Chain.Direct.Fixture (defaultPParams)
 import Hydra.Chain.Direct.State ()
 import Hydra.JSONSchema (prop_validateJSONSchema)
+import Hydra.Ledger.Cardano (Tx)
 import Hydra.Logging (nullTracer)
 import Test.Aeson.GenericSpecs (roundtripAndGoldenSpecs)
 import Test.Hspec.Wai (MatchBody (..), ResponseMatcher (matchBody), get, shouldRespondWith, with)
-import Test.QuickCheck.Property (property, withMaxSuccess)
+import Test.QuickCheck.Property (counterexample, forAll, property, withMaxSuccess)
 
 spec :: Spec
 spec = do
   parallel $ do
     roundtripAndGoldenSpecs (Proxy @(ReasonablySized DraftCommitTxResponse))
     roundtripAndGoldenSpecs (Proxy @(ReasonablySized DraftCommitTxRequest))
-    roundtripAndGoldenSpecs (Proxy @(ReasonablySized SubmitTxRequest))
+    roundtripAndGoldenSpecs (Proxy @(ReasonablySized (SubmitTxRequest Tx)))
     roundtripAndGoldenSpecs (Proxy @(ReasonablySized TransactionSubmitted))
 
     prop "Validate /commit publish api schema" $
@@ -40,7 +44,7 @@ spec = do
     prop "Validate /cardano-transaction publish api schema" $
       property $
         withMaxSuccess 1 $
-          prop_validateJSONSchema @SubmitTxRequest "api.json" $
+          prop_validateJSONSchema @(SubmitTxRequest Tx) "api.json" $
             key "channels"
               . key "/cardano-transaction"
               . key "publish"
@@ -60,6 +64,25 @@ spec = do
               . key "payload"
 
     apiServerSpec
+    describe "SubmitTxRequest accepted tx formats" $ do
+      prop "accepts Base16 cbor encoded bytestring" $
+        forAll (arbitrary @Tx) $ \tx ->
+          let json = String $ decodeUtf8 $ Base16.encode $ serialize' (toLedgerTx tx)
+           in case fromJSON @(SubmitTxRequest Tx) json of
+                Success{} -> property True
+                Error e -> counterexample (toString $ toText e) $ property False
+      prop "accepts json encoded transaction" $
+        forAll (arbitrary @Tx) $ \tx ->
+          let json = toJSON (toLedgerTx tx)
+           in case fromJSON @(SubmitTxRequest Tx) json of
+                Success{} -> property True
+                Error e -> counterexample (toString $ toText e) $ property False
+      prop "accepts transaction encoded as TextEnvelope" $
+        forAll (arbitrary @Tx) $ \tx ->
+          let json = toJSON $ serialiseToTextEnvelope Nothing tx
+           in case fromJSON @(SubmitTxRequest Tx) json of
+                Success{} -> property True
+                Error e -> counterexample (toString $ toText e) $ property False
 
 -- TODO: we should add more tests for other routes here (eg. /commit)
 apiServerSpec :: Spec