feat(jellyfish-api-core): add wallet.listtransactions RPC

docs/node/CATEGORIES/05-wallet.md

@@ -407,3 +407,20 @@ interface wallet {
   signMessage (address: string, message: string): Promise<string>
 }
 ```
+
+## listTransactions
+
+List transactions based on the given criteria.
+
+```ts title="client.wallet.listTransactions()"
+interface wallet {
+  listTransactions  ({
+    label?: string = '*',
+    count?: number = 10,
+    skip?: number = 0,
+    includeWatchOnly?: boolean = true
+    excludeCustomTx?: boolean = false
+  }): Promise<InWalletTransactionWithCategory[]>
+}
+```
+

packages/jellyfish-api-core/__tests__/category/wallet/listTransactions.test.ts

@@ -0,0 +1,230 @@
+import { BigNumber } from '@defichain/jellyfish-json'
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+
+describe('listTransactions', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  const address = 'mwsZw8nF7pKxWH8eoKL9tPxTpaFkz7QeLU'
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForWalletCoinbaseMaturity()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should listTransactions', async () => {
+    await Promise.all(Array.from({ length: 10 }).map(async (_, i) => {
+      return await client.wallet.sendToAddress(address, 0.0001)
+    }))
+    await container.generate(1, address)
+
+    const inWalletTransactions = await client.wallet.listTransactions({})
+
+    expect(inWalletTransactions.length).toStrictEqual(10)
+
+    for (const inWalletTransaction of inWalletTransactions) {
+      expect(inWalletTransaction).toMatchObject({
+        address: expect.any(String),
+        txid: expect.any(String),
+        amount: expect.any(BigNumber),
+        confirmations: expect.any(Number),
+        blockhash: expect.any(String),
+        blocktime: expect.any(Number),
+        blockindex: expect.any(Number),
+        time: expect.any(Number),
+        timereceived: expect.any(Number),
+        // "bip125-replaceable" is "BIP125" enum but we test with "string" here
+        'bip125-replaceable': expect.any(String),
+        // "category" is "InWalletTransactionCategory" enum but we test with "string" here
+        category: expect.any(String),
+        label: expect.any(String),
+        vout: expect.any(Number)
+      })
+    }
+  })
+
+  it('should listTransactions with label set', async () => {
+    await Promise.all(Array.from({ length: 10 }).map(async (_, i) => {
+      return await client.wallet.sendToAddress(address, 0.0001)
+    }))
+    await container.generate(1, address)
+
+    const inWalletTransactions = await client.wallet.listTransactions({ label: 'owner' })
+
+    inWalletTransactions.forEach((inWalletTransaction) => {
+      expect(inWalletTransaction.label).toStrictEqual('owner')
+    })
+
+    expect(inWalletTransactions.length).toStrictEqual(10)
+
+    for (const inWalletTransaction of inWalletTransactions) {
+      expect(inWalletTransaction).toMatchObject({
+        address: expect.any(String),
+        txid: expect.any(String),
+        amount: expect.any(BigNumber),
+        confirmations: expect.any(Number),
+        blockhash: expect.any(String),
+        blocktime: expect.any(Number),
+        blockindex: expect.any(Number),
+        time: expect.any(Number),
+        timereceived: expect.any(Number),
+        // "bip125-replaceable" is "BIP125" enum but we test with "string" here
+        'bip125-replaceable': expect.any(String),
+        // "category" is "InWalletTransactionCategory" enum but we test with "string" here
+        category: expect.any(String),
+        label: expect.any(String),
+        vout: expect.any(Number)
+      })
+    }
+  })
+
+  it('should listTransactions with label set', async () => {
+    await Promise.all(Array.from({ length: 10 }).map(async (_, i) => {
+      return await client.wallet.sendToAddress(address, 0.0001)
+    }))
+    await container.generate(1, address)
+
+    const inWalletTransactions = await client.wallet.listTransactions({ label: 'owner' })
+
+    inWalletTransactions.forEach((inWalletTransaction) => {
+      expect(inWalletTransaction.label).toStrictEqual('owner')
+    })
+
+    expect(inWalletTransactions.length).toStrictEqual(10)
+
+    for (const inWalletTransaction of inWalletTransactions) {
+      expect(inWalletTransaction).toMatchObject({
+        address: expect.any(String),
+        txid: expect.any(String),
+        amount: expect.any(BigNumber),
+        confirmations: expect.any(Number),
+        blockhash: expect.any(String),
+        blocktime: expect.any(Number),
+        blockindex: expect.any(Number),
+        time: expect.any(Number),
+        timereceived: expect.any(Number),
+        // "bip125-replaceable" is "BIP125" enum but we test with "string" here
+        'bip125-replaceable': expect.any(String),
+        // "category" is "InWalletTransactionCategory" enum but we test with "string" here
+        category: expect.any(String),
+        label: expect.any(String),
+        vout: expect.any(Number)
+      })
+    }
+  })
+
+  it('should listTransactions with count = 5', async () => {
+    await Promise.all(Array.from({ length: 5 }).map(async (_, i) => {
+      return await client.wallet.sendToAddress(address, 0.0001)
+    }))
+    await container.generate(1, address)
+
+    const inWalletTransactions = await client.wallet.listTransactions({ count: 5 })
+
+    expect(inWalletTransactions.length).toStrictEqual(5)
+
+    for (const inWalletTransaction of inWalletTransactions) {
+      expect(inWalletTransaction).toMatchObject({
+        address: expect.any(String),
+        txid: expect.any(String),
+        amount: expect.any(BigNumber),
+        confirmations: expect.any(Number),
+        blockhash: expect.any(String),
+        blocktime: expect.any(Number),
+        blockindex: expect.any(Number),
+        time: expect.any(Number),
+        timereceived: expect.any(Number),
+        // "bip125-replaceable" is "BIP125" enum but we test with "string" here
+        'bip125-replaceable': expect.any(String),
+        // "category" is "InWalletTransactionCategory" enum but we test with "string" here
+        category: expect.any(String),
+        label: expect.any(String),
+        vout: expect.any(Number)
+      })
+    }
+  })
+
+  it('should not listTransactions with count = -1', async () => {
+    await expect(client.wallet.listTransactions({ count: -1 })).rejects.toThrow('RpcApiError: \'Negative count\', code: -8, method: listtransactions')
+  })
+
+  it('should listTransactions with count = 0', async () => {
+    const inWalletTransactions = await client.wallet.listTransactions({ count: 0 })
+    expect(inWalletTransactions.length).toStrictEqual(0)
+  })
+
+  it('should listTransactions with includeWatchOnly false', async () => {
+    await Promise.all(Array.from({ length: 10 }).map(async (_, i) => {
+      return await client.wallet.sendToAddress(address, 0.0001)
+    }))
+    await container.generate(1, address)
+
+    const inWalletTransactions = await client.wallet.listTransactions({ includeWatchOnly: false })
+
+    inWalletTransactions.forEach((inWalletTransaction) => {
+      expect(inWalletTransaction.address).toStrictEqual(address)
+    })
+
+    expect(inWalletTransactions.length).toStrictEqual(10)
+
+    for (const inWalletTransaction of inWalletTransactions) {
+      expect(inWalletTransaction).toMatchObject({
+        address: expect.any(String),
+        txid: expect.any(String),
+        amount: expect.any(BigNumber),
+        confirmations: expect.any(Number),
+        blockhash: expect.any(String),
+        blocktime: expect.any(Number),
+        blockindex: expect.any(Number),
+        time: expect.any(Number),
+        timereceived: expect.any(Number),
+        // "bip125-replaceable" is "BIP125" enum but we test with "string" here
+        'bip125-replaceable': expect.any(String),
+        // "category" is "InWalletTransactionCategory" enum but we test with "string" here
+        category: expect.any(String),
+        label: expect.any(String),
+        vout: expect.any(Number)
+      })
+    }
+  })
+
+  it('should listTransactions with excludeCustomTx = true', async () => {
+    await Promise.all(Array.from({ length: 10 }).map(async (_, i) => {
+      return await client.wallet.sendToAddress(address, 0.0001)
+    }))
+    await container.generate(1, address)
+
+    const inWalletTransactions = await client.wallet.listTransactions({ excludeCustomTx: true })
+
+    inWalletTransactions.forEach((inWalletTransaction) => {
+      expect(inWalletTransaction.address).toStrictEqual(address)
+    })
+
+    expect(inWalletTransactions.length).toStrictEqual(10)
+
+    for (const inWalletTransaction of inWalletTransactions) {
+      expect(inWalletTransaction).toMatchObject({
+        address: expect.any(String),
+        txid: expect.any(String),
+        amount: expect.any(BigNumber),
+        confirmations: expect.any(Number),
+        blockhash: expect.any(String),
+        blocktime: expect.any(Number),
+        blockindex: expect.any(Number),
+        time: expect.any(Number),
+        timereceived: expect.any(Number),
+        // "bip125-replaceable" is "BIP125" enum but we test with "string" here
+        'bip125-replaceable': expect.any(String),
+        // "category" is "InWalletTransactionCategory" enum but we test with "string" here
+        category: expect.any(String),
+        label: expect.any(String),
+        vout: expect.any(Number)
+      })
+    }
+  })
+})

packages/jellyfish-api-core/src/category/wallet.ts

@@ -325,6 +325,33 @@ export class Wallet {
     return await this.client.call('listwallets', [], 'number')
   }
 
+  /**
+   * If a label name is provided, this will return only incoming transactions paying to addresses with the specified label.
+   * Returns up to 'count' most recent transactions skipping the first 'from' transactions.
+   *
+   * @param {string} label If set, should be a valid label name to return only incoming transactions with the specified label, or '*' to disable filtering and return all transactions. (default = '*')
+   * @param {string} count The number of transactions to return (default = 10)
+   * @param {string} skip The number of transactions to skip (default = 0)
+   * @param {boolean} includeWatchOnly Whether to include watch-only addresses (default = true)
+   * @param {boolean} excludeCustomTx False to include all transactions, otherwise exclude custom transactions (default = false)
+   * @return {Promise<Array<InWalletTransactionWithFlatDetails>>}
+   */
+  async listTransactions ({
+    label = '*',
+    count = 10,
+    skip = 0,
+    includeWatchOnly = true,
+    excludeCustomTx = false
+  }: {
+    label?: string
+    count?: number
+    skip?: number
+    includeWatchOnly?: boolean
+    excludeCustomTx?: boolean
+  }): Promise<InWalletTransactionWithFlatDetails[]> {
+    return await this.client.call('listtransactions', [label, count, skip, includeWatchOnly, excludeCustomTx], { amount: 'bignumber' })
+  }
+
   /**
    * Sign a message with the private key of an address
    * Requires wallet to be unlocked for usage. Use `walletpassphrase` to unlock wallet.
@@ -494,6 +521,26 @@ export interface InWalletTransaction {
   hex: string
 }
 
+export interface InWalletTransactionWithFlatDetails {
+  address: string
+  category: InWalletTransactionCategory
+  amount: BigNumber
+  label?: string
+  vout: number
+  fee?: number
+  confirmations: number
+  trusted: boolean
+  blockhash: string
+  blockindex: number
+  blocktime: number
+  txid: string
+  time: number
+  timereceived: number
+  comment?: string
+  'bip125-replaceable': BIP125
+  abandoned?: boolean
+}
+
 export interface InWalletTransactionDetail {
   address: string
   category: InWalletTransactionCategory