Merge pull request safe-global#119 from ioloie/feature/all-transactions

Add getAllTransactions endpoint to Safe Service Client

packages/safe-service-client/README.md

@@ -213,6 +213,26 @@ const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPen
 )
 ```
 
+### getAllTransactions
+
+Returns a list of transactions for a Safe. The list has different structures depending on the transaction type.
+
+```js
+const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(safeAddress)
+```
+
+```js
+const allTxsOptions: AllTransactionsOptions = {
+  executed,
+  queued,
+  trusted
+}
+const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
+  safeAddress,
+  allTxsOptions
+)
+```
+
 ### getNextNonce
 
 Returns the right nonce to propose a new transaction right after the last pending transaction.

packages/safe-service-client/e2e/getNextNonce.test.ts

@@ -25,4 +25,4 @@ describe('getNextNonce', () => {
     const nextNonce = await serviceSdk.getNextNonce(safeAddress)
     chai.expect(nextNonce).to.be.equal(0)
   })
-})  
+})

packages/safe-service-client/src/SafeServiceClient.ts

@@ -1,6 +1,8 @@
 import { Signer } from '@ethersproject/abstract-signer'
 import SafeTransactionService from './SafeTransactionService'
 import {
+  AllTransactionsListResponse,
+  AllTransactionsOptions,
   MasterCopyResponse,
   OwnerResponse,
   ProposeTransactionProps,
@@ -212,7 +214,12 @@ class SafeServiceClient implements SafeTransactionService {
    * @throws "Safe=<safe_address> does not exist or it's still not indexed"
    * @throws "Signing owner is not an owner of the Safe"
    */
-  async addSafeDelegate({ safe, delegate, label, signer }: SafeDelegateConfig): Promise<SafeDelegate> {
+  async addSafeDelegate({
+    safe,
+    delegate,
+    label,
+    signer
+  }: SafeDelegateConfig): Promise<SafeDelegate> {
     if (safe === '') {
       throw new Error('Invalid Safe address')
     }
@@ -452,6 +459,38 @@ class SafeServiceClient implements SafeTransactionService {
     })
   }
 
+  /**
+   * Returns a list of transactions for a Safe. The list has different structures depending on the transaction type
+   *
+   * @param safeAddress - The Safe address
+   * @returns The list of transactions waiting for the confirmation of the Safe owners
+   * @throws "Invalid Safe address"
+   * @throws "Checksum address validation failed"
+   */
+  async getAllTransactions(
+    safeAddress: string,
+    options?: AllTransactionsOptions
+  ): Promise<AllTransactionsListResponse> {
+    if (safeAddress === '') {
+      throw new Error('Invalid Safe address')
+    }
+    const url = new URL(`${this.#txServiceBaseUrl}/safes/${safeAddress}/all-transactions/`)
+
+    const trusted = options?.trusted?.toString() || 'true'
+    url.searchParams.set('trusted', trusted)
+
+    const queued = options?.queued?.toString() || 'true'
+    url.searchParams.set('queued', queued)
+
+    const executed = options?.executed?.toString() || 'false'
+    url.searchParams.set('executed', executed)
+
+    return sendRequest({
+      url: url.toString(),
+      method: HttpMethod.Get
+    })
+  }
+
   /**
    * Returns the right nonce to propose a new transaction after the last pending transaction.
    *

packages/safe-service-client/src/types/safeTransactionServiceTypes.ts

@@ -263,3 +263,48 @@ export type TokenInfoListResponse = {
   readonly previous?: string
   readonly results: TokenInfoListResponse[]
 }
+
+export type TransferWithTokenInfoResponse = TransferResponse & {
+  readonly tokenInfo: TokenInfoResponse
+}
+
+export type SafeModuleTransactionWithTransfersResponse = SafeModuleTransaction & {
+  readonly txType?: 'MODULE_TRANSACTION'
+  readonly transfers: TransferWithTokenInfoResponse[]
+}
+
+export type SafeMultisigTransactionWithTransfersResponse = SafeMultisigTransactionResponse & {
+  readonly txType?: 'MULTISIG_TRANSACTION'
+  readonly transfers: TransferWithTokenInfoResponse[]
+}
+
+export type EthereumTxResponse = {
+  readonly executionDate: string
+  readonly to: string
+  readonly data: string
+  readonly txHash: string
+  readonly blockNumber?: number
+  readonly from: string
+}
+
+export type EthereumTxWithTransfersResponse = EthereumTxResponse & {
+  readonly txType?: 'ETHEREUM_TRANSACTION'
+  readonly transfers: TransferWithTokenInfoResponse[]
+}
+
+export type AllTransactionsOptions = {
+  executed?: boolean
+  queued?: boolean
+  trusted?: boolean
+}
+
+export type AllTransactionsListResponse = {
+  readonly count: number
+  readonly next?: string
+  readonly previous?: string
+  readonly results: Array<
+    | SafeModuleTransactionWithTransfersResponse
+    | SafeMultisigTransactionWithTransfersResponse
+    | EthereumTxWithTransfersResponse
+  >
+}

packages/safe-service-client/tests/endpoint.test.ts

@@ -318,6 +318,18 @@ describe('Endpoint tests', () => {
       })
     })
 
+    it('getAllTransactions', async () => {
+      await chai
+        .expect(serviceSdk.getAllTransactions(safeAddress))
+        .to.be.eventually.deep.equals({ data: { success: true } })
+      chai.expect(fetchData).to.have.been.calledWith({
+        url: `${getTxServiceBaseUrl(
+          txServiceBaseUrl
+        )}/safes/${safeAddress}/all-transactions/?trusted=true&queued=true&executed=false`,
+        method: 'get'
+      })
+    })
+
     it('getBalances', async () => {
       await chai
         .expect(serviceSdk.getBalances(safeAddress))