feat: add tx filter endpoints (#73)

* feat: add tx filter endpoints

* fix: add `rawUrl`

* fix: add missing query param

* fix: query types

* fix: add `executed` param

* fix: bump version

Author: Aaron Cook

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gnosis.pm/safe-react-gateway-sdk",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "main": "dist/index.min.js",
   "types": "dist/index.d.ts",
   "files": [

src/index.ts

@@ -1,7 +1,16 @@
 import { callEndpoint } from './endpoint'
 import { operations } from './types/api'
 import { SafeTransactionEstimation, TransactionDetails, TransactionListPage } from './types/transactions'
-import { FiatCurrencies, OwnedSafes, SafeBalanceResponse, SafeCollectibleResponse, SafeInfo } from './types/common'
+import {
+  FiatCurrencies,
+  OwnedSafes,
+  SafeBalanceResponse,
+  SafeCollectibleResponse,
+  SafeIncomingTransfersResponse,
+  SafeInfo,
+  SafeModuleTransactionsResponse,
+  SafeMultisigTransactionsResponse,
+} from './types/common'
 import { ChainListResponse, ChainInfo } from './types/chains'
 import { SafeAppsResponse } from './types/safe-apps'
 import { MasterCopyReponse } from './types/master-copies'
@@ -33,6 +42,66 @@ export function getSafeInfo(chainId: string, address: string): Promise<SafeInfo>
   return callEndpoint(baseUrl, '/v1/chains/{chainId}/safes/{address}', { path: { chainId, address } })
 }
 
+/**
+ * Get filterable list of incoming transactions
+ */
+export function getIncomingTransfers(
+  chainId: string,
+  address: string,
+  query?: operations['incoming_transfers']['parameters']['query'],
+  pageUrl?: string,
+): Promise<SafeIncomingTransfersResponse> {
+  return callEndpoint(
+    baseUrl,
+    '/v1/chains/{chainId}/safes/{address}/incoming-transfers/',
+    {
+      path: { chainId, address },
+      query,
+    },
+    pageUrl,
+  )
+}
+
+/**
+ * Get filterable list of module transactions
+ */
+export function getModuleTransactions(
+  chainId: string,
+  address: string,
+  query?: operations['module_transactions']['parameters']['query'],
+  pageUrl?: string,
+): Promise<SafeModuleTransactionsResponse> {
+  return callEndpoint(
+    baseUrl,
+    '/v1/chains/{chainId}/safes/{address}/module-transactions/',
+    {
+      path: { chainId, address },
+      query,
+    },
+    pageUrl,
+  )
+}
+
+/**
+ * Get filterable list of multisig transactions
+ */
+export function getMultisigTransactions(
+  chainId: string,
+  address: string,
+  query?: operations['multisig_transactions']['parameters']['query'],
+  pageUrl?: string,
+): Promise<SafeMultisigTransactionsResponse> {
+  return callEndpoint(
+    baseUrl,
+    '/v1/chains/{chainId}/safes/{address}/multisig-transactions/',
+    {
+      path: { chainId, address },
+      query,
+    },
+    pageUrl,
+  )
+}
+
 /**
  * Get the total balance and all assets stored in a Safe
  */

src/types/api.ts

@@ -1,4 +1,13 @@
-import { FiatCurrencies, OwnedSafes, SafeBalanceResponse, SafeCollectibleResponse, SafeInfo } from './common'
+import {
+  FiatCurrencies,
+  OwnedSafes,
+  SafeBalanceResponse,
+  SafeCollectibleResponse,
+  SafeIncomingTransfersResponse,
+  SafeInfo,
+  SafeModuleTransactionsResponse,
+  SafeMultisigTransactionsResponse,
+} from './common'
 import {
   MultisigTransactionRequest,
   TransactionDetails,
@@ -32,6 +41,36 @@ export interface paths {
       }
     }
   }
+  '/v1/chains/{chainId}/safes/{address}/incoming-transfers/': {
+    get: operations['incoming_transfers']
+    parameters: {
+      path: {
+        chainId: string
+        address: string
+        currency: string
+      }
+    }
+  }
+  '/v1/chains/{chainId}/safes/{address}/module-transactions/': {
+    get: operations['module_transactions']
+    parameters: {
+      path: {
+        chainId: string
+        address: string
+        currency: string
+      }
+    }
+  }
+  '/v1/chains/{chainId}/safes/{address}/multisig-transactions/': {
+    get: operations['multisig_transactions']
+    parameters: {
+      path: {
+        chainId: string
+        address: string
+        currency: string
+      }
+    }
+  }
   '/v1/balances/supported-fiat-codes': {
     get: operations['get_supported_fiat']
     parameters: null
@@ -193,6 +232,79 @@ export interface operations {
       422: unknown
     }
   }
+  /** Get filterable incoming transfers */
+  incoming_transfers: {
+    parameters: {
+      path: {
+        chainId: string
+        address: string
+      }
+      query?: {
+        execution_date__gte?: string
+        execution_date__lte?: string
+        to?: string
+        token_address?: string
+        value?: string
+      }
+    }
+    responses: {
+      200: {
+        schema: SafeIncomingTransfersResponse
+      }
+      /** Safe not found */
+      404: unknown
+      /** Safe address checksum not valid */
+      422: unknown
+    }
+  }
+  /** Get filterable module transactions */
+  module_transactions: {
+    parameters: {
+      path: {
+        chainId: string
+        address: string
+      }
+      query?: {
+        module?: string
+        to?: string
+      }
+    }
+    responses: {
+      200: {
+        schema: SafeModuleTransactionsResponse
+      }
+      /** Safe not found */
+      404: unknown
+      /** Safe address checksum not valid */
+      422: unknown
+    }
+  }
+  /** Get filterable multisig transactions */
+  multisig_transactions: {
+    parameters: {
+      path: {
+        chainId: string
+        address: string
+      }
+      query?: {
+        execution_date__gte?: string
+        execution_date__lte?: string
+        to?: string
+        value?: string
+        nonce?: string
+        executed?: string
+      }
+    }
+    responses: {
+      200: {
+        schema: SafeMultisigTransactionsResponse
+      }
+      /** Safe not found */
+      404: unknown
+      /** Safe address checksum not valid */
+      422: unknown
+    }
+  }
   get_supported_fiat: {
     parameters: null
     responses: {

src/types/chains.ts

@@ -1,3 +1,5 @@
+import { Page } from './transactions'
+
 export enum RPC_AUTHENTICATION {
   API_KEY_PATH = 'API_KEY_PATH',
   NO_AUTHENTICATION = 'NO_AUTHENTICATION',
@@ -82,8 +84,4 @@ export type ChainInfo = {
   features: FEATURES[]
 }
 
-export type ChainListResponse = {
-  next: string | null
-  previous: string | null
-  results: ChainInfo[]
-}
+export type ChainListResponse = Page<ChainInfo>

src/types/common.ts

@@ -1,3 +1,5 @@
+import { IncomingTransfer, ModuleTransaction, MultisigTransaction, Page } from '..'
+
 export type AddressEx = {
   value: string
   name: string | null
@@ -49,6 +51,12 @@ export type SafeBalanceResponse = {
   }>
 }
 
+export type SafeIncomingTransfersResponse = Page<IncomingTransfer>
+
+export type SafeModuleTransactionsResponse = Page<ModuleTransaction>
+
+export type SafeMultisigTransactionsResponse = Page<MultisigTransaction>
+
 export type SafeCollectibleResponse = {
   address: string
   tokenName: string

src/types/transactions.ts

@@ -228,6 +228,28 @@ export type Transaction = {
   type: 'TRANSACTION'
 }
 
+// WIP types:
+
+export type IncomingTransfer = Omit<Transaction, 'transaction'> & {
+  transaction: Omit<TransactionSummary, 'txInfo' | 'executionInfo'> & {
+    txInfo: Omit<Transfer, 'direction'> & { direction: TransferDirection.INCOMING }
+  }
+}
+
+export type ModuleTransaction = Omit<Transaction, 'transaction'> & {
+  transaction: Omit<TransactionSummary, 'txInfo' | 'executionInfo'> & {
+    txInfo: Transfer
+    executionInfo?: ModuleExecutionInfo
+  }
+}
+
+export type MultisigTransaction = Omit<Transaction, 'transaction'> & {
+  transaction: Omit<TransactionSummary, 'txInfo' | 'executionInfo'> & {
+    txInfo: Omit<Transfer, 'direction'> & { direction: TransferDirection.OUTGOING }
+    executionInfo?: MultisigExecutionInfo
+  }
+}
+
 export type DateLabel = {
   timestamp: number
   type: 'DATE_LABEL'
@@ -253,7 +275,7 @@ export type ConflictHeader = {
 
 export type TransactionListItem = Transaction | Label | ConflictHeader
 
-type Page<T> = {
+export type Page<T> = {
   next?: string
   previous?: string
   results: Array<T>