feat: add optional CBOR representation to GET_TRANSACTION

blockfrost · Nov 29, 2024 · 36b7266 · 36b7266
1 parent 7259cf4
commit 36b7266
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -635,7 +635,7 @@ Payload contains [protocol parameters](https://docs.blockfrost.io/#tag/cardano--
 
 ### GET_TRANSACTION
 
-Returns information about a specified transaction.
+Returns information about a specified transaction, optionally with CBOR representation.
 
 Input message:
 
@@ -645,6 +645,7 @@ Input message:
   "command": "GET_TRANSACTION";
   "params": {
     "txId": string; // transaction id
+    "cbor":? boolean;
   }
 }
 ```
@@ -686,6 +687,7 @@ Payload contains [transaction data](https://docs.blockfrost.io/#tag/cardano--tra
     asset_mint_or_burn_count: number;
     redeemer_count: number;
     valid_contract: boolean;
+    cbor?: string;
   };
 }
 ```

diff --git a/src/methods/get-transaction.ts b/src/methods/get-transaction.ts
@@ -2,9 +2,5 @@ import { prepareMessage } from '../utils/message.js';
 import { fetchTransactionData } from '../utils/transaction.js';
 import { MessageId } from '../types/message.js';
 
-export default async (id: MessageId, clientId: string, txId: string): Promise<string> => {
-  const data = await fetchTransactionData(txId);
-  const message = prepareMessage({ id, clientId, data });
-
-  return message;
-};
+export default async (id: MessageId, clientId: string, txId: string, cbor?: boolean) =>
+  prepareMessage({ id, clientId, data: await fetchTransactionData(txId, cbor) });
diff --git a/src/server.ts b/src/server.ts
@@ -270,7 +270,7 @@ wss.on('connection', async (ws: Server.Ws) => {
 
       case 'GET_TRANSACTION': {
         validators.GET_TRANSACTION(params);
-        response = await getTransaction(id, clientId, params.txId);
+        response = await getTransaction(id, clientId, params.txId, params.cbor);
 
         break;
       }

diff --git a/src/types/message.ts b/src/types/message.ts
@@ -41,6 +41,7 @@ export type Messages = BaseMessage &
         command: 'GET_TRANSACTION';
         params: {
           txId: string;
+          cbor?: boolean;
         };
       }
     | {

diff --git a/src/utils/message.ts b/src/utils/message.ts
@@ -52,6 +52,7 @@ const schemas: { [k in Validators]: { properties: unknown; required?: string[] }
   GET_TRANSACTION: {
     properties: {
       txId: { type: 'string' },
+      cbor: { type: 'boolean' },
     },
     required: ['txId'],
   },