feat: add listAccountTransactions method

packages/keyring-api/package.json

@@ -37,7 +37,7 @@
   "dependencies": {
     "@metamask/snaps-sdk": "^6.7.0",
     "@metamask/superstruct": "^3.1.0",
-    "@metamask/utils": "^9.2.1",
+    "@metamask/utils": "^9.3.0",
     "@types/uuid": "^9.0.8",
     "bech32": "^2.0.0",
     "uuid": "^9.0.1",

packages/keyring-api/src/KeyringClient.test.ts

@@ -85,6 +85,184 @@ describe('KeyringClient', () => {
     });
   });
 
+  describe('listAccountTransactions', () => {
+    it('returns an empty list of transactions', async () => {
+      const id = '49116980-0712-4fa5-b045-e4294f1d440e';
+      const expectedResponse = {
+        data: [],
+        next: null,
+      };
+
+      mockSender.send.mockResolvedValue(expectedResponse);
+      const transactions = await keyring.listAccountTransactions(id, {
+        limit: 10,
+      });
+
+      expect(mockSender.send).toHaveBeenCalledWith({
+        jsonrpc: '2.0',
+        id: expect.any(String),
+        method: 'keyring_listAccountTransactions',
+        params: { id, pagination: { limit: 10 } },
+      });
+
+      expect(transactions).toStrictEqual(expectedResponse);
+    });
+
+    it('returns a single page of transactions', async () => {
+      const id = '7bd967bd-9c4a-47cc-9725-75f0d2d8df9d';
+      const expectedResponse = {
+        data: [
+          {
+            id: 'c3d2e7a5-7c3c-4c1b-8d2e-7a57c3c41b8d',
+            account: '03a16e94-df42-46e6-affc-789bd58cf478',
+            chain: 'eip155:1',
+            type: 'send',
+            status: 'confirmed',
+            timestamp: 1716367781,
+            from: [],
+            to: [],
+            fee: {
+              amount: '0.001',
+              asset: {
+                fungible: true,
+                type: 'eip155:1/slip44:60',
+                unit: 'ETH',
+              },
+            },
+          },
+          {
+            id: '774a9423-9dd4-4b63-81a0-26884be90a35',
+            account: '03a16e94-df42-46e6-affc-789bd58cf478',
+            chain: 'eip155:1',
+            type: 'receive',
+            status: 'submitted',
+            timestamp: null,
+            from: [],
+            to: [],
+            fee: {
+              amount: '0',
+              asset: {
+                fungible: true,
+                type: 'eip155:1/slip44:60',
+                unit: 'ETH',
+              },
+            },
+          },
+        ],
+        next: null,
+      };
+
+      mockSender.send.mockResolvedValue(expectedResponse);
+      const transactions = await keyring.listAccountTransactions(id, {
+        limit: 2,
+      });
+
+      expect(mockSender.send).toHaveBeenCalledWith({
+        jsonrpc: '2.0',
+        id: expect.any(String),
+        method: 'keyring_listAccountTransactions',
+        params: { id, pagination: { limit: 2 } },
+      });
+
+      expect(transactions).toStrictEqual(expectedResponse);
+    });
+
+    it('returns a page of transactions with next', async () => {
+      const id = '7bd967bd-9c4a-47cc-9725-75f0d2d8df9d';
+      const expectedResponse = {
+        data: [
+          {
+            id: 'c3d2e7a5-7c3c-4c1b-8d2e-7a57c3c41b8d',
+            account: '03a16e94-df42-46e6-affc-789bd58cf478',
+            chain: 'eip155:1',
+            type: 'send',
+            status: 'confirmed',
+            timestamp: 1716367781,
+            from: [],
+            to: [],
+            fee: {
+              amount: '0.001',
+              asset: {
+                fungible: true,
+                type: 'eip155:1/slip44:60',
+                unit: 'ETH',
+              },
+            },
+          },
+          {
+            id: '774a9423-9dd4-4b63-81a0-26884be90a35',
+            account: '03a16e94-df42-46e6-affc-789bd58cf478',
+            chain: 'eip155:1',
+            type: 'receive',
+            status: 'submitted',
+            timestamp: null,
+            from: [],
+            to: [],
+            fee: {
+              amount: '0',
+              asset: {
+                fungible: true,
+                type: 'eip155:1/slip44:60',
+                unit: 'ETH',
+              },
+            },
+          },
+        ],
+        next: 'some-cursor',
+      };
+
+      mockSender.send.mockResolvedValue(expectedResponse);
+      const transactions = await keyring.listAccountTransactions(id, {
+        limit: 2,
+      });
+
+      expect(mockSender.send).toHaveBeenCalledWith({
+        jsonrpc: '2.0',
+        id: expect.any(String),
+        method: 'keyring_listAccountTransactions',
+        params: { id, pagination: { limit: 2 } },
+      });
+
+      expect(transactions).toStrictEqual(expectedResponse);
+    });
+
+    it('throwns an error when the fee has an invalid amount', async () => {
+      const id = '7bd967bd-9c4a-47cc-9725-75f0d2d8df9d';
+      const expectedResponse = {
+        data: [
+          {
+            id: 'c3d2e7a5-7c3c-4c1b-8d2e-7a57c3c41b8d',
+            account: '03a16e94-df42-46e6-affc-789bd58cf478',
+            chain: 'eip155:1',
+            type: 'send',
+            status: 'confirmed',
+            timestamp: 1716367781,
+            from: [],
+            to: [],
+            fee: {
+              amount: 'invalid-amount', // Should be a numeric string
+              asset: {
+                fungible: true,
+                type: 'eip155:1/slip44:60',
+                unit: 'ETH',
+              },
+            },
+          },
+        ],
+        next: null,
+      };
+
+      mockSender.send.mockResolvedValue(expectedResponse);
+      await expect(
+        keyring.listAccountTransactions(id, {
+          limit: 2,
+        }),
+      ).rejects.toThrow(
+        'At path: data.0.fee.amount -- Expected a value of type `StringNumber`, but received: `"invalid-amount"`',
+      );
+    });
+  });
+
   describe('getAccountBalances', () => {
     it('returns a valid response', async () => {
       const assets = ['bip122:000000000019d6689c085ae165831e93/slip44:0'];

packages/keyring-api/src/KeyringClient.ts

@@ -10,6 +10,7 @@ import type {
   KeyringResponse,
   CaipAssetType,
   Balance,
+  TransactionsPage,
 } from './api';
 import {
   ApproveRequestResponseStruct,
@@ -21,6 +22,7 @@ import {
   GetAccountResponseStruct,
   GetRequestResponseStruct,
   ListAccountsResponseStruct,
+  ListAccountTransactionsResponseStruct,
   ListRequestsResponseStruct,
   RejectRequestResponseStruct,
   SubmitRequestResponseStruct,
@@ -29,6 +31,7 @@ import {
 import { KeyringRpcMethod } from './internal/rpc';
 import type { JsonRpcRequest } from './JsonRpcRequest';
 import { strictMask } from './superstruct';
+import type { Pagination } from './utils';
 
 export type Sender = {
   send(request: JsonRpcRequest): Promise<Json>;
@@ -104,6 +107,19 @@ export class KeyringClient implements Keyring {
     );
   }
 
+  async listAccountTransactions(
+    id: string,
+    pagination: Pagination,
+  ): Promise<TransactionsPage> {
+    return strictMask(
+      await this.#send({
+        method: KeyringRpcMethod.ListAccountTransactions,
+        params: { id, pagination },
+      }),
+      ListAccountTransactionsResponseStruct,
+    );
+  }
+
   async filterAccountChains(id: string, chains: string[]): Promise<string[]> {
     return strictMask(
       await this.#send({

packages/keyring-api/src/api/index.ts

@@ -5,3 +5,4 @@ export * from './export';
 export type * from './keyring';
 export * from './request';
 export * from './response';
+export * from './transaction';

packages/keyring-api/src/api/keyring.ts

@@ -6,6 +6,8 @@ import type { CaipAssetType } from './caip';
 import type { KeyringAccountData } from './export';
 import type { KeyringRequest } from './request';
 import type { KeyringResponse } from './response';
+import type { Transaction } from './transaction';
+import type { Paginated, Pagination } from '../utils';
 
 /**
  * Keyring interface.
@@ -46,6 +48,22 @@ export type Keyring = {
    */
   createAccount(options?: Record<string, Json>): Promise<KeyringAccount>;
 
+  /**
+   * Lists the transactions of an account, paginated and ordered by the most
+   * recent first.
+   *
+   * The pagination options are used to limit the number of transactions in the
+   * response and to iterate over the results.
+   *
+   * @param id - The ID of the account to list the transactions for.
+   * @param pagination - The pagination options.
+   * @returns A promise that resolves to the next page of transactions.
+   */
+  listAccountTransactions?(
+    id: string,
+    pagination: Pagination,
+  ): Promise<Paginated<Transaction>>;
+
   /**
    * Retrieve the balances of a given account.
    *