Add mintTokens rpc

packages/jellyfish-api-core/__tests__/category/token/mintTokens.test.ts

@@ -0,0 +1,88 @@
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+import { RpcApiError } from '../../../src'
+
+describe('Token', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForReady()
+    await container.waitForWalletCoinbaseMaturity()
+    await setup()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  let from: string
+
+  async function setup (): Promise<void> {
+    from = await container.getNewAddress()
+
+    await createToken(from, 'DBTC')
+    await container.generate(1)
+
+    await createToken(from, 'DETH')
+    await container.generate(1)
+  }
+
+  async function createToken (address: string, symbol: string): Promise<void> {
+    const defaultMetadata = {
+      symbol,
+      name: symbol,
+      isDAT: true,
+      mintable: true,
+      tradeable: true,
+      collateralAddress: address
+    }
+    await client.token.createToken({ ...defaultMetadata })
+  }
+
+  it('should mintTokens', async () => {
+    let tokenBalances = await client.account.getTokenBalances()
+
+    expect(tokenBalances.length).toStrictEqual(0)
+
+    const data = await client.token.mintTokens('5@DBTC')
+
+    expect(typeof data).toStrictEqual('string')
+    expect(data.length).toStrictEqual(64)
+
+    await container.generate(1)
+
+    tokenBalances = await client.account.getTokenBalances()
+
+    expect(tokenBalances.length).toStrictEqual(1)
+    expect(tokenBalances[0]).toStrictEqual('5.00000000@1')
+  })
+
+  it('should not mintTokens for non-existence token', async () => {
+    const promise = client.token.mintTokens('5@ETH')
+
+    await expect(promise).rejects.toThrow(RpcApiError)
+    await expect(promise).rejects.toThrow('Invalid Defi token: ETH\', code: 0, method: minttokens')
+  })
+
+  it('should mintTokens with utxos', async () => {
+    let tokenBalances = await client.account.getTokenBalances()
+
+    expect(tokenBalances.length).toStrictEqual(1)
+
+    const { txid, vout } = await container.fundAddress(from, 10)
+
+    const data = await client.token.mintTokens('5@DETH', [{ txid, vout }])
+
+    expect(typeof data).toStrictEqual('string')
+    expect(data.length).toStrictEqual(64)
+
+    await container.generate(1)
+
+    tokenBalances = await client.account.getTokenBalances()
+
+    expect(tokenBalances.length).toStrictEqual(2)
+    expect(tokenBalances[1]).toStrictEqual('5.00000000@2')
+  })
+})

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

@@ -1,5 +1,7 @@
 import { ApiClient } from '../.'
 
+type TokenRegexType = `${number}@${string}`
+
 /**
  * Token RPCs for DeFi Blockchain
  */
@@ -20,12 +22,12 @@ export class Token {
    * @param {boolean} metadata.mintable default = true
    * @param {boolean} metadata.tradeable default = true
    * @param {string} metadata.collateralAddress for keeping collateral amount
-   * @param {CreateTokenUTXO[]} utxos array of specific UTXOs to spend
+   * @param {UTXO[]} utxos array of specific UTXOs to spend
    * @param {string} utxos.txid
    * @param {number} utxos.vout
    * @return {Promise<string>}
    */
-  async createToken (metadata: CreateTokenMetadata, utxos: CreateTokenUTXO[] = []): Promise<string> {
+  async createToken (metadata: CreateTokenMetadata, utxos: UTXO[] = []): Promise<string> {
     const defaultMetadata = {
       isDAT: false,
       mintable: true,
@@ -81,6 +83,19 @@ export class Token {
   async getToken (symbolKey: string): Promise<TokenResult> {
     return await this.client.call('gettoken', [symbolKey], 'number')
   }
+
+  /**
+   * Creates a transaction to mint tokens.
+   *
+   * @param {TokenRegexType} payload
+   * @param {UTXO[]} [utxos = []]
+   * @param {string} [utxos.txid]
+   * @param {number} [utxos.vout]
+   * @return {Promise<string>}
+   */
+  async mintTokens (payload: TokenRegexType, utxos: UTXO[] = []): Promise<string> {
+    return await this.client.call('minttokens', [payload, utxos], 'number')
+  }
 }
 
 export interface TokenResult {
@@ -124,13 +139,13 @@ export interface UpdateTokenMetadata {
   finalize?: boolean
 }
 
-export interface CreateTokenUTXO {
-  txid: string
-  vout: number
-}
-
 export interface TokenPagination {
   start: number
   including_start: boolean
   limit: number
 }
+
+export interface UTXO {
+  txid: string
+  vout: number
+}

website/docs/jellyfish/api/token.md

@@ -19,7 +19,7 @@ Creates a token with given metadata.
 
 ```ts title="client.token.createToken()"
 interface token {
-  createToken (metadata: CreateTokenMetadata, utxos: CreateTokenUTXO[] = []): Promise<string>
+  createToken (metadata: CreateTokenMetadata, utxos: UTXO[] = []): Promise<string>
 }
 
 interface CreateTokenMetadata {
@@ -31,7 +31,7 @@ interface CreateTokenMetadata {
   collateralAddress: string
 }
 
-interface CreateTokenUTXO {
+interface UTXO {
   txid: string
   vout: number
 }
@@ -134,3 +134,20 @@ interface TokenInfo {
   collateralAddress: string
 }
 ```
+
+## mintTokens
+
+Creates a transaction to mint tokens.
+
+```ts title="client.token.mintTokens()"
+interface token {
+  mintTokens (payload: TokenRegexType, utxos: UTXO[] = []): Promise<string>
+}
+
+type TokenRegexType = `${number}@${string}`
+
+interface UTXO {
+  txid: string
+  vout: number
+}
+```