feat: add listAccountTransactions method

[danroc]

This method was originally part of the Chain API, but we decided to migrate it to the Keyring API since it's close related to accounts.

Also, it will allow to list the trasactions for a given account ID instead of address, which make it simpler to get the balances for Bitcoin accounts, for example.

Closes: https://github.com/MetaMask/accounts-planning/issues/460
Closes: https://github.com/MetaMask/accounts-planning/issues/453
Replaces: MetaMask/keyring-api#322

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/utils@9.3.0	None	+1	730 kB	metamaskbot

🚮 Removed packages: npm/@metamask/utils@9.2.1

View full report↗︎

[ccharly]

I wonder if we should optional(nullable(string())) here...

I was thinking of this example

const keyring = ...;

const pagination = {
  limit: 10,
  next: null, // No cursor yet
};
do {
  const page = await keyring.listAccountTransactions(accountId, pagination);
  // Do something with `page.transactions`...
  pagination.next = page.next;
} while (page.next);

I think we cannot write this code here, because of the exactOptional, right?

[danroc]

This type was supposed to be used in the request, not the response:

listAccountTransactions(id, {limit: 10});
// or
listAccountTransactions(id, {limit: 10, next: '<cursor_token>'});

But now that you mentioned this case, I think we can do the change you mentioned and repurpose it to be used both ways 🤔 WDYT?

[ccharly]

Well... I really liked the exactOptional initially yes, but I'm worried about it being hard to use, so I believe we could just allow null in this case yes.

[danroc]

TODO: Rename to AssetAmountStruct

[danroc]

TODO: Discuss if it should be an array.