Add utxosToAccount rpc (#215)

packages/jellyfish-api-core/__tests__/category/account.test.ts

@@ -2,6 +2,7 @@ import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
 import { ContainerAdapterClient } from '../container_adapter_client'
 import waitForExpect from 'wait-for-expect'
 import BigNumber from 'bignumber.js'
+import { UtxosToAccountPayload } from '../../src/category/account'
 
 describe('masternode', () => {
   const container = new MasterNodeRegTestContainer()
@@ -481,4 +482,38 @@ describe('masternode', () => {
       })
     })
   })
+
+  describe('utxosToAccount', () => {
+    it('should utxosToAccount', async () => {
+      const payload: UtxosToAccountPayload = {}
+      // NOTE(jingyi2811): Only support sending utxos to DFI account.
+      payload[await container.getNewAddress()] = '5@DFI'
+      payload[await container.getNewAddress()] = '5@DFI'
+
+      const data = await client.account.utxosToAccount(payload)
+
+      expect(typeof data).toBe('string')
+      expect(data.length).toBe(64)
+    })
+
+    it('should utxosToAccount with utxos', async () => {
+      const payload: UtxosToAccountPayload = {}
+      // NOTE(jingyi2811): Only support sending utxos to DFI account.
+      payload[await container.getNewAddress()] = '5@DFI'
+      payload[await container.getNewAddress()] = '5@DFI'
+
+      const utxos = await container.call('listunspent')
+      const inputs = utxos.map((utxo: { txid: string, vout: number }) => {
+        return {
+          txid: utxo.txid,
+          vout: utxo.vout
+        }
+      })
+
+      const data = await client.account.utxosToAccount(payload, inputs)
+
+      expect(typeof data).toBe('string')
+      expect(data.length).toBe(64)
+    })
+  })
 })

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

@@ -220,6 +220,21 @@ export class Account {
   ): Promise<AccountHistory[]> {
     return await this.client.call('listaccounthistory', [owner, options], 'number')
   }
+
+  /**
+   * Creates and submits to a connect node; a transfer transaction from the wallet UTXOs to a specified account.
+   * Optionally, specific UTXOs to spend to create that transaction.
+   *
+   * @param {UtxosToAccountPayload} payload
+   * @param {string} payload[address]
+   * @param {UtxosToAccountUTXO[]} [utxos=[]]
+   * @param {string} [utxos.txid]
+   * @param {number} [utxos.vout]
+   * @return {Promise<string>}
+   */
+  async utxosToAccount (payload: UtxosToAccountPayload, utxos: UtxosToAccountUTXO[] = []): Promise<string> {
+    return await this.client.call('utxostoaccount', [payload, utxos], 'number')
+  }
 }
 
 export interface AccountPagination {
@@ -277,3 +292,12 @@ export interface AccountHistoryOptions {
   txtype?: string
   limit?: number
 }
+
+export interface UtxosToAccountPayload {
+  [key: string]: string
+}
+
+export interface UtxosToAccountUTXO {
+  txid: string
+  vout: number
+}

website/docs/jellyfish/api/account.md

@@ -142,3 +142,23 @@ interface AccountHistoryOptions {
   limit?: number
 }
 ```
+
+## utxosToAccount
+
+Creates and submits to a connect node; a transfer transaction from the wallet UTXOs to a specified account. 
+Optionally, specific UTXOs to spend to create that transaction.
+
+```ts title="client.account.utxosToAccount()"
+interface account {
+  utxosToAccount (payload: UtxosToAccountPayload, utxos: UtxosToAccountUTXO[] = []): Promise<string>
+}
+
+interface UtxosToAccountPayload {
+  [key: string]: string;
+}
+
+interface UtxosToAccountUTXO {
+  txid: string
+  vout: number
+}
+```