Improve code

BirthdayResearch · May 17, 2021 · f124f6d · f124f6d
1 parent 8211bea
commit f124f6d
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 9 deletions.
diff --git a/packages/jellyfish-api-core/__tests__/category/account.test.ts b/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()
@@ -490,7 +491,8 @@ describe('masternode', () => {
     })
 
     it('should utxosToAccount', async () => {
-      const payload: any = {}
+      const payload: UtxosToAccountPayload = {}
+      // NOTE(jingyi2811): Only support sending utxos to DFI account.
       payload[address1] = '5@DFI'
       payload[address2] = '5@DFI'
 
@@ -501,7 +503,8 @@ describe('masternode', () => {
     })
 
     it('should utxosToAccount with utxos', async () => {
-      const payload: any = {}
+      const payload: UtxosToAccountPayload = {}
+      // NOTE(jingyi2811): Only support sending utxos to DFI account.
       payload[address1] = '5@DFI'
       payload[address2] = '5@DFI'
 

diff --git a/packages/jellyfish-api-core/src/category/account.ts b/packages/jellyfish-api-core/src/category/account.ts
@@ -225,14 +225,14 @@ export class Account {
    * Creates (and submits to local node and network) a transfer transaction from the wallet UTXOs to specfied account.
    * The second optional argument (may be empty array) is an array of specific UTXOs to spend.
    *
-   * @param {any} [payload]
-   * @param {UtxosToAccountUTXO[]} [options=[]]
-   * @param {string} [options.txid]
-   * @param {number} [options.vout]
+   * @param {UtxosToAccountPayload} [payload]
+   * @param {UtxosToAccountUTXO[]} [utxos=[]]
+   * @param {string} [utxos.txid]
+   * @param {number} [utxos.vout]
    * @return {Promise<string>}
    */
-  async utxosToAccount (payload: any, options: UtxosToAccountUTXO[] = []): Promise<string> {
-    return await this.client.call('utxostoaccount', [payload, options], 'number')
+  async utxosToAccount (payload: UtxosToAccountPayload, utxos: UtxosToAccountUTXO[] = []): Promise<string> {
+    return await this.client.call('utxostoaccount', [payload, utxos], 'number')
   }
 }
 
@@ -292,6 +292,10 @@ export interface AccountHistoryOptions {
   limit?: number
 }
 
+export interface UtxosToAccountPayload {
+  [key: string]: string
+}
+
 export interface UtxosToAccountUTXO {
   txid: string
   vout: number

diff --git a/website/docs/jellyfish/api/account.md b/website/docs/jellyfish/api/account.md
@@ -150,7 +150,11 @@ The second optional argument (may be empty array) is an array of specific UTXOs
 
 ```ts title="client.account.utxosToAccount()"
 interface account {
-  utxosToAccount (payload: any, options: UtxosToAccountUTXO[] = []): Promise<string>
+  utxosToAccount (payload: UtxosToAccountPayload, utxos: UtxosToAccountUTXO[] = []): Promise<string>
+}
+
+interface UtxosToAccountPayload {
+  [key: string]: string;
 }
 
 interface UtxosToAccountUTXO {