Feat: safe overviews endpoint

Author: katspaugh

src/index.ts

@@ -10,14 +10,15 @@ import type {
   NoncesResponse,
 } from './types/transactions'
 import type {
+  EthereumAddress,
   AllOwnedSafes,
   FiatCurrencies,
   OwnedSafes,
   SafeBalanceResponse,
   SafeCollectibleResponse,
   SafeCollectiblesPage,
 } from './types/common'
-import type { SafeInfo } from './types/safe-info'
+import type { SafeInfo, SafeOverview } from './types/safe-info'
 import type { ChainListResponse, ChainInfo } from './types/chains'
 import type { SafeAppsResponse } from './types/safe-apps'
 import type { MasterCopyReponse } from './types/master-copies'
@@ -599,4 +600,19 @@ export function unsubscribeAll(query: operations['unsubscribe_all']['parameters'
   return deleteEndpoint(baseUrl, '/v1/subscriptions/all', { query })
 }
 
+/**
+ * Get Safe overviews per address
+ */
+export function getSafeOverviews(
+  safes: `${number}:${EthereumAddress}`[],
+  query: Omit<operations['SafesController_getSafeOverview']['parameters']['query'], 'safes'>,
+): Promise<SafeOverview[]> {
+  return getEndpoint(baseUrl, '/v1/safes', {
+    query: {
+      ...query,
+      safes: safes.join(','),
+    },
+  })
+}
+
 /* eslint-enable @typescript-eslint/explicit-module-boundary-types */

src/types/api.ts

@@ -17,7 +17,7 @@ import type {
   SafeMultisigTransactionsResponse,
   NoncesResponse,
 } from './transactions'
-import type { SafeInfo } from './safe-info'
+import type { SafeInfo, SafeOverview } from './safe-info'
 import type { ChainListResponse, ChainInfo } from './chains'
 import type { SafeAppsResponse } from './safe-apps'
 import type { DecodedDataRequest, DecodedDataResponse } from './decoded-data'
@@ -413,19 +413,18 @@ export interface paths extends PathRegistry {
     delete: operations['unsubscribe_single']
     parameters: {
       path: null
-      query: {
-        category: string
-        token: string
-      }
     }
   }
   '/v1/subscriptions/all': {
     delete: operations['unsubscribe_all']
     parameters: {
       path: null
-      query: {
-        token: string
-      }
+    }
+  }
+  '/v1/safes': {
+    get: operations['SafesController_getSafeOverview']
+    parameters: {
+      path: null
     }
   }
 }
@@ -1111,4 +1110,20 @@ export interface operations {
       }
     }
   }
+  SafesController_getSafeOverview: {
+    parameters: {
+      query: {
+        currency: string
+        safes: string
+        trusted: boolean
+        exclude_spam: boolean
+        walletAddress: string
+      }
+    }
+    responses: {
+      200: {
+        schema: SafeOverview[]
+      }
+    }
+  }
 }

src/types/common.ts

@@ -58,3 +58,5 @@ export type SafeCollectibleResponse = {
 }
 
 export type SafeCollectiblesPage = Page<SafeCollectibleResponse>
+
+export type EthereumAddress = `0x${string}`

src/types/safe-info.ts

@@ -23,3 +23,13 @@ export type SafeInfo = {
   txHistoryTag: string | null
   messagesTag: string | null
 }
+
+export type SafeOverview = {
+  address: AddressEx
+  chainId: string
+  threshold: number
+  owners: AddressEx[]
+  fiatTotal: string
+  queued: number
+  awaitingConfirmation: number
+}