Feat: transaction preview endpoint (#205)

safe-global · Nov 20, 2024 · 42b31eb · 42b31eb
1 parent 34be8d8
commit 42b31eb
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 0 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -8,6 +8,7 @@ import type {
   SafeModuleTransactionsResponse,
   SafeMultisigTransactionsResponse,
   NoncesResponse,
+  TransactionPreview,
 } from './types/transactions'
 import type {
   EthereumAddress,
@@ -312,6 +313,22 @@ export function getConfirmationView(
   })
 }
 
+/**
+ * Get a tx preview
+ */
+export function getTxPreview(
+  chainId: string,
+  safeAddress: string,
+  data: operations['data_decoder']['parameters']['body']['data'],
+  to?: operations['data_decoder']['parameters']['body']['to'],
+  value?: operations['data_decoder']['parameters']['body']['value'],
+): Promise<TransactionPreview> {
+  return postEndpoint(baseUrl, '/v1/chains/{chainId}/transactions/{safe_address}/preview', {
+    path: { chainId, safe_address: safeAddress },
+    body: { data, to, value },
+  })
+}
+
 /**
  * Returns all defined chain configs
  */

diff --git a/src/types/api.ts b/src/types/api.ts
@@ -16,6 +16,7 @@ import type {
   SafeModuleTransactionsResponse,
   SafeMultisigTransactionsResponse,
   NoncesResponse,
+  TransactionPreview,
 } from './transactions'
 import type { SafeInfo, SafeOverview } from './safe-info'
 import type { ChainListResponse, ChainInfo, ChainIndexingStatus } from './chains'
@@ -248,6 +249,15 @@ export interface paths extends PathRegistry {
       }
     }
   }
+  '/v1/chains/{chainId}/transactions/{safe_address}/preview': {
+    post: operations['preview_transaction']
+    parameters: {
+      path: {
+        chainId: string
+        safe_address: string
+      }
+    }
+  }
   '/v1/chains/{chainId}/safes/{safe_address}/views/transaction-confirmation': {
     post: operations['get_transaction_confirmation_view']
     parameters: {
@@ -828,6 +838,24 @@ export interface operations {
       422: unknown
     }
   }
+  preview_transaction: {
+    parameters: {
+      path: {
+        chainId: string
+        safe_address: string
+      }
+      body: DecodedDataRequest
+    }
+    responses: {
+      200: {
+        schema: TransactionPreview
+      }
+      /** Safe not found */
+      404: unknown
+      /** Safe address checksum not valid */
+      422: unknown
+    }
+  }
   get_transaction_confirmation_view: {
     parameters: {
       path: {

diff --git a/src/types/transactions.ts b/src/types/transactions.ts
@@ -529,6 +529,11 @@ export type TransactionDetails = {
 
 /* Transaction details types end */
 
+export type TransactionPreview = {
+  txInfo: TransactionInfo
+  txData: TransactionData
+}
+
 /* Transaction estimation types */
 
 export type SafeTransactionEstimationRequest = {