Merge pull request #110 from input-output-hk/KtorZ/3.1.1-fix-submit-api

Revert added feature in 3.0.0 causing issue

Author: KtorZ

docker-compose.yml

@@ -61,7 +61,7 @@ services:
         max-file: "10"
 
   cardano-explorer-api:
-    image: inputoutput/cardano-explorer-api:${CARDANO_EXPLORER_API_VERSION:-3.1.0}
+    image: inputoutput/cardano-explorer-api:${CARDANO_EXPLORER_API_VERSION:-3.1.1}
     depends_on:
       - postgres
       - cardano-db-sync
@@ -83,7 +83,7 @@ services:
         max-file: "10"
 
   cardano-submit-api:
-    image: inputoutput/cardano-submit-api:${CARDANO_SUBMIT_API_VERSION:-3.1.0}
+    image: inputoutput/cardano-submit-api:${CARDANO_SUBMIT_API_VERSION:-3.1.1}
     environment:
       - NETWORK=${NETWORK:-mainnet}
     depends_on:

explorer-api/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 3.1.1 -- December 2020
+
+* ø (patch in submit-api).
+
 ## 3.1.0 -- December 2020
 
 * Fix an internal error with 'InnerJoin' requests on block's transaction summary.

explorer-api/cardano-explorer-api.cabal

@@ -3,7 +3,7 @@ cabal-version:          >= 1.10
 -- http://haskell.org/cabal/users-guide/
 
 name:                   cardano-explorer-api
-version:                3.1.0
+version:                3.1.1
 synopsis:               A Block Explorer for the Cardano network
 description:
 homepage:               https://github.com/input-output-hk/cardano-explorer

rest-common/cardano-rest-common.cabal

@@ -3,7 +3,7 @@ cabal-version:          >= 1.10
 -- http://haskell.org/cabal/users-guide/
 
 name:                   cardano-rest-common
-version:                3.1.0
+version:                3.1.1
 synopsis:               A Block Explorer for the Cardano network
 description:
 homepage:               https://github.com/input-output-hk/cardano-explorer

submit-api/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 3.1.1 -- December 2020 
+
+* Revert the MIME-type `encoding` addition from 3.1.0. Turns out there's a bug with an underlying dependency 
+  causing the feature to misbehave. Removing for now. Will rework later if time allows.
+
 ## 3.1.0 -- December 2020
 
 * Allow clients to define an extra outer-encoding for the submit endpoint using a MIME-type parameter `encoding`. 

submit-api/cardano-submit-api.cabal

@@ -3,7 +3,7 @@ cabal-version:          >= 1.10
 -- http://haskell.org/cabal/users-guide/
 
 name:                   cardano-submit-api
-version:                3.1.0
+version:                3.1.1
 synopsis:               A web server that allows transactions to be POSTed to the cardano chain
 description:
 homepage:               https://github.com/input-output-hk/cardano-explorer
@@ -52,8 +52,7 @@ library
   build-depends:        base                            >= 4.12         && < 4.13
                       , aeson
                       , async
-                      , base16
-                      , base64
+                      , base16-bytestring
                       , bytestring
                       , cardano-api
                       , cardano-binary

submit-api/src/Cardano/TxSubmit/Types.hs

@@ -17,28 +17,18 @@ import Cardano.Binary
     ( DecoderError )
 import Cardano.TxSubmit.Tx
     ( TxSubmitError, renderTxSubmitError )
-import Control.Arrow
-    ( left )
 import Data.Aeson
     ( ToJSON (..), Value (..) )
-import Data.Bifunctor
-    ( bimap )
-import Data.ByteString.Base16
-    ( decodeBase16 )
 import Data.ByteString.Char8
     ( ByteString )
-import Data.ByteString.Lazy.Base64
-    ( decodeBase64 )
-import Data.List.NonEmpty
-    ( NonEmpty (..) )
 import Data.Text
     ( Text )
 import Formatting
     ( build, sformat )
 import GHC.Generics
     ( Generic )
 import Network.HTTP.Media
-    ( parameters, (//), (/:) )
+    ( (//) )
 import Servant
     ( (:>)
     , Accept (..)
@@ -52,8 +42,6 @@ import Servant.API.Generic
     ( (:-), ToServantApi )
 
 import qualified Data.ByteString.Lazy.Char8 as LBS
-import qualified Data.Map.Strict as Map
-import qualified Data.Text as T
 
 newtype TxSubmitPort
   = TxSubmitPort Int
@@ -98,10 +86,7 @@ data TxSubmitApiRecord route = TxSubmitApiRecord
 data CBORStream
 
 instance Accept CBORStream where
-  contentTypes _ = "application" // "cbor" /: ("encoding", "base16") :|
-    [ "application" // "cbor" /: ("encoding", "base64")
-    , "application" // "cbor"
-    ]
+  contentType _ = "application" // "cbor"
 
 instance MimeRender CBORStream ByteString where
     mimeRender _ = LBS.fromStrict
@@ -110,16 +95,7 @@ instance MimeRender CBORStream LBS.ByteString where
     mimeRender _ = id
 
 instance MimeUnrender CBORStream ByteString where
-    mimeUnrender proxy = fmap LBS.toStrict . mimeUnrender proxy
+    mimeUnrender _ = Right . LBS.toStrict
 
 instance MimeUnrender CBORStream LBS.ByteString where
-    mimeUnrenderWithType _ mediaType bytes =
-        case Map.lookup "encoding" (parameters mediaType) of
-            Nothing ->
-                Right bytes
-            Just "base16" ->
-                bimap T.unpack LBS.fromStrict . decodeBase16 . LBS.toStrict $ bytes
-            Just "base64" ->
-                left T.unpack . decodeBase64 $ bytes
-            Just _ ->
-                Left "unrecognized encoding: must be 'base16' or 'base64' if specified."
+    mimeUnrender _ = Right . id

submit-api/swagger.yaml

@@ -20,13 +20,13 @@ paths:
     post:
       operationId: postTransaction
       summary: Submit Tx
-      description: Submit an already serialized transaction to the network. Use an extra 'encoding' MIME parameter to send bytestring encoded in `base16` or `base64`.
+      description: Submit an already serialized transaction to the network.
       parameters:
         - in: header
           name: Content-Type
           required: true
           type: string
-          enum: ["application/cbor", "application/cbor; encoding=base16", "application/cbor; encoding=base64"]
+          enum: ["application/cbor"]
 
       x-code-samples:
         - lang: "Shell"