client: add GET /txs/{hash}/cbor endpoint

blockfrost · Sep 18, 2024 · f14677e · f14677e
1 parent aed4fd3
commit f14677e
Show file tree

Hide file tree

Showing 8 changed files with 50 additions and 0 deletions.
diff --git a/blockfrost-api/CHANGELOG.md b/blockfrost-api/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Version [next](https://github.com/blockfrost/blockfrost-haskell/compare/api-0.11.0.0...master) (2024-MM-DD)
 
+* Additions [#63](https://github.com/blockfrost/blockfrost-haskell/pull/63)
+  * `/txs/:hash/cbor` endpoint with `TransactionCBOR` data type
+
 # Version [0.11.0.0](https://github.com/blockfrost/blockfrost-haskell/compare/api-0.10.0.0...api-0.11.0.0) (2024-08-26)
 
 Changes

diff --git a/blockfrost-api/src/Blockfrost/API/Cardano/Transactions.hs b/blockfrost-api/src/Blockfrost/API/Cardano/Transactions.hs
@@ -83,6 +83,13 @@ data TransactionsAPI route =
         :> Capture "hash" TxHash
         :> "metadata"
         :> Get '[JSON] [TransactionMetaJSON]
+    , _txCBOR
+        :: route
+        :- Summary "Transaction in CBOR"
+        :> Description "Obtain the CBOR serialized transaction."
+        :> Capture "hash" TxHash
+        :> "cbor"
+        :> Get '[JSON] [TransactionCBOR]
     , _txMetadataCBOR
         :: route
         :- Summary "Transaction metadata in CBOR"

diff --git a/blockfrost-api/src/Blockfrost/Lens.hs b/blockfrost-api/src/Blockfrost/Lens.hs
@@ -78,6 +78,7 @@ makeFields ''TransactionPoolUpdate
 makeFields ''PoolUpdateMetadata
 makeFields ''TransactionPoolRetiring
 makeFields ''TransactionMetaJSON
+makeFields ''TransactionCBOR
 makeFields ''TransactionMetaCBOR
 makeFields ''TransactionRedeemer
 

diff --git a/blockfrost-api/src/Blockfrost/Types/Cardano/Transactions.hs b/blockfrost-api/src/Blockfrost/Types/Cardano/Transactions.hs
@@ -15,6 +15,7 @@ module Blockfrost.Types.Cardano.Transactions
   , PoolUpdateMetadata (..)
   , TransactionPoolRetiring (..)
   , TransactionMetaJSON (..)
+  , TransactionCBOR (..)
   , TransactionMetaCBOR (..)
   ) where
 
@@ -367,6 +368,17 @@ instance ToSample TransactionMetaJSON where
         (Just $ oracleMeta "0.15409850555139935")
     ]
 
+-- | Transaction in CBOR
+newtype TransactionCBOR = TransactionCBOR { _transactionCBORCbor :: Text }
+  deriving stock (Show, Eq, Generic)
+  deriving (FromJSON, ToJSON)
+  via CustomJSON '[FieldLabelModifier '[StripPrefix "_transactionCBOR", CamelToSnake]] TransactionCBOR
+
+instance ToSample TransactionCBOR where
+  toSamples = pure $ singleSample $
+    TransactionCBOR
+      "a100a16b436f6d62696e6174696f6e8601010101010c"
+
 -- | Transaction metadata in CBOR
 data TransactionMetaCBOR = TransactionMetaCBOR
   { _transactionMetaCBORLabel        :: Text -- ^ Metadata label

diff --git a/blockfrost-api/test/Cardano/Transactions.hs b/blockfrost-api/test/Cardano/Transactions.hs
@@ -67,6 +67,11 @@ spec_txs = do
     `shouldBe`
     Right transactionMetaJSONExpected
 
+  it "parses transaction (CBOR) sample" $ do
+    eitherDecode transactionCBORSample
+    `shouldBe`
+    Right transactionCBORExpected
+
   it "parses transaction meta (CBOR) sample" $ do
     eitherDecode transactionMetaCBORSample
     `shouldBe`
@@ -429,6 +434,16 @@ transactionMetaJSONExpected =
         (Just $ oracleMeta "0.15409850555139935")
     ]
 
+transactionCBORSample = [r|
+{
+  "cbor": "a100a16b436f6d62696e6174696f6e8601010101010c"
+}
+|]
+
+transactionCBORExpected =
+    TransactionCBOR
+      "a100a16b436f6d62696e6174696f6e8601010101010c"
+
 transactionMetaCBORSample = [r|
 {
   "label": "1968",

diff --git a/blockfrost-client/CHANGELOG.md b/blockfrost-client/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Version [next](https://github.com/blockfrost/blockfrost-haskell/compare/client-0.8.0.1...master) (2024-MM-DD)
 
+* Additions [#63](https://github.com/blockfrost/blockfrost-haskell/pull/63)
+  * `getTxCBOR` for `/txs/:hash/cbor`
+
 # Version [0.8.0.1](https://github.com/blockfrost/blockfrost-haskell/compare/client-0.8.0.0...client-0.8.0.1) (2024-01-16)
 
 * GHC 9.6.3 compatibility

diff --git a/blockfrost-client/src/Blockfrost/Client.hs b/blockfrost-client/src/Blockfrost/Client.hs
@@ -140,6 +140,7 @@ module Blockfrost.Client
   , getTxPoolUpdates
   , getTxPoolRetiring
   , getTxMetadataJSON
+  , getTxCBOR
   , getTxMetadataCBOR
   , getTxRedeemers
   , submitTx

diff --git a/blockfrost-client/src/Blockfrost/Client/Cardano/Transactions.hs b/blockfrost-client/src/Blockfrost/Client/Cardano/Transactions.hs
@@ -11,6 +11,7 @@ module Blockfrost.Client.Cardano.Transactions
   , getTxPoolUpdates
   , getTxPoolRetiring
   , getTxMetadataJSON
+  , getTxCBOR
   , getTxMetadataCBOR
   , submitTx
   ) where
@@ -92,6 +93,13 @@ getTxMetadataJSON_ = _txMetadataJSON . transactionsClient
 getTxMetadataJSON :: MonadBlockfrost m => TxHash -> m [TransactionMetaJSON]
 getTxMetadataJSON t = go (`getTxMetadataJSON_` t)
 
+getTxCBOR_ :: MonadBlockfrost m => Project -> TxHash -> m [TransactionCBOR]
+getTxCBOR_ = _txCBOR . transactionsClient
+
+-- | Get transaction in CBOR
+getTxCBOR :: MonadBlockfrost m => TxHash -> m [TransactionCBOR]
+getTxCBOR t = go (`getTxCBOR_` t)
+
 getTxMetadataCBOR_ :: MonadBlockfrost m => Project -> TxHash -> m [TransactionMetaCBOR]
 getTxMetadataCBOR_ = _txMetadataCBOR . transactionsClient