feat(jellyfish-api-core): DFI Payback of all dTokens (#1190)

* Jellyfish minor updates for DFI Payback of all dTokens #1111 * Added setGov test cases with loan_payback and loan_payback_fee_pct keys * Added paybackloan api extention and a testcase * Added paybackloan a new testcase * Updated fortcanningroadheight * Updated fortcanningroadheight * Updated fortcanningroadheight * Added dusd loan payback using dusd test * Fixed failing gov tests. * Updated account.md with new paybackfees and paybacktokens * Updated PaybackLoanMetadata properly and test updates * Updates for review comments - part 1 (Now burn info is checked) * Updates for review comments - part 2 (burn info check, new test cases and paybackLoan method signature update) * Updates for review comments - part 3 (payback multiple loans at once, new test cases) * Minor fixes for CI test fails and interest calculation * Updates for review comments - part 4 (Payback checking before hardfork and minor updates) * Updates for review comments - part 5 (Now Tsla tokens are not minted) * Added dftx interface for Payback Loan V2 * Updated loan.md with payback loan v2 * Ain image from https://github.com/DeFiCh/ain/actions/runs/2020075855 * Update for dftx loan payback v2 * Added tests for dftx loan payback v2 * Comments update about PaybackLoanV2 Co-authored-by: surangap <[email protected]> * Comments update about TokenPayback.dToken Co-authored-by: surangap <[email protected]> Co-authored-by: surangap <[email protected]>
DeFiCh · Mar 30, 2022 · df81748 · df81748
1 parent 18c2389
commit df81748
Show file tree

Hide file tree

Showing 19 changed files with 1,176 additions and 20 deletions.
diff --git a/apps/rich-list-api/docker-compose.yml b/apps/rich-list-api/docker-compose.yml
@@ -41,4 +41,5 @@ services:
       -eunospayaheight=7
       -fortcanningheight=8
       -fortcanningmuseumheight=9
-      -fortcanninghillheight=10
+      -fortcanninghillheight=10
+      -fortcanningroadheight=11
diff --git a/docs/node/CATEGORIES/08-account.md b/docs/node/CATEGORIES/08-account.md
@@ -456,5 +456,13 @@ interface BurnInfo {
    * Amount of tokens that are paid back; formatted as AMOUNT@SYMBOL
    */
   dfipaybacktokens: string[]
+  /**
+   * Amount of paybacks
+   */
+  paybackfees: string[]
+  /**
+   * Amount of tokens that are paid back
+   */
+  paybacktokens: string[]
 }
 ```
diff --git a/docs/node/CATEGORIES/16-loan.md b/docs/node/CATEGORIES/16-loan.md
@@ -612,7 +612,7 @@ Return loan in a desired amount.
 
 ```ts title="client.loan.paybackLoan()"
 interface loan {
-  paybackLoan (metadata: PaybackLoanMetadata, utxos: UTXO[] = []): Promise<string>
+  paybackLoan (metadata: PaybackLoanMetadata | PaybackLoanMetadataV2, utxos: UTXO[] = []): Promise<string>
 }
 
 interface PaybackLoanMetadata {
@@ -621,6 +621,17 @@ interface PaybackLoanMetadata {
   from: string
 }
 
+interface TokenPaybackAmount {
+  dToken: string
+  amounts: string | string[] // amount@symbol
+}
+
+interface PaybackLoanMetadataV2 {
+  vaultId: string
+  from: string
+  loans: TokenPaybackAmount[]
+}
+
 interface UTXO {
   txid: string
   vout: number

diff --git a/packages/jellyfish-api-core/__tests__/category/account/getBurnInfo.test.ts b/packages/jellyfish-api-core/__tests__/category/account/getBurnInfo.test.ts
@@ -52,6 +52,8 @@ it('should getBurnInfo', async () => {
     auctionburn: new BigNumber(0),
     emissionburn: new BigNumber('6274'),
     paybackburn: new BigNumber(0),
+    paybackfees: [],
+    paybacktokens: [],
     dexfeetokens: [],
     dfipaybackfee: new BigNumber(0),
     dfipaybacktokens: []

diff --git a/packages/jellyfish-api-core/__tests__/category/governance/governance_container.ts b/packages/jellyfish-api-core/__tests__/category/governance/governance_container.ts
@@ -14,6 +14,7 @@ export class GovernanceMasterNodeRegTestContainer extends MasterNodeRegTestConta
       .filter(cmd => cmd !== '-fortcanningheight=8')
       .filter(cmd => cmd !== '-fortcanningmuseumheight=9')
       .filter(cmd => cmd !== '-fortcanninghillheight=10')
+      .filter(cmd => cmd !== '-fortcanningroadheight=11')
 
     return [
       ...cmd,

diff --git a/packages/jellyfish-api-core/__tests__/category/loan/paybackLoan.test.ts b/packages/jellyfish-api-core/__tests__/category/loan/paybackLoan.test.ts
diff --git a/packages/jellyfish-api-core/__tests__/category/loan/takeLoan.test.ts b/packages/jellyfish-api-core/__tests__/category/loan/takeLoan.test.ts
@@ -780,7 +780,7 @@ describe('takeloan failed', () => {
       amounts: '1000@TSLA'
     })
     await expect(promise).rejects.toThrow(RpcApiError)
-    await expect(promise).rejects.toThrow('At least 50% of the minimum required collateral must be in DFI when taking a loan.')
+    await expect(promise).rejects.toThrow('At least 50% of the minimum required collateral must be in DFI or DUSD when taking a loan.')
 
     {
       // revert DFI value changes

diff --git a/packages/jellyfish-api-core/__tests__/category/masternode/setGov.test.ts b/packages/jellyfish-api-core/__tests__/category/masternode/setGov.test.ts
@@ -2,6 +2,7 @@ import { RpcApiError } from '@defichain/jellyfish-api-core'
 import { GenesisKeys, MasterNodeRegTestContainer } from '@defichain/testcontainers'
 import { createPoolPair, createToken } from '@defichain/testing'
 import { ContainerAdapterClient } from '../../container_adapter_client'
+import { Testing } from '@defichain/jellyfish-testing'
 
 describe('Masternode', () => {
   const container = new MasterNodeRegTestContainer()
@@ -69,3 +70,71 @@ describe('Masternode', () => {
     await expect(promise).rejects.toThrow('LP_DAILY_DFI_REWARD: Cannot be set manually after Eunos hard fork')
   })
 })
+
+describe('Masternode setGov ATTRIBUTES', () => {
+  const container = new MasterNodeRegTestContainer()
+  const testing = Testing.create(container)
+  const attributeKey = 'ATTRIBUTES'
+  let key: string
+
+  beforeAll(async () => {
+    await testing.container.start()
+    await testing.container.waitForWalletCoinbaseMaturity()
+
+    // setup loan token
+    await testing.rpc.loan.setLoanToken({
+      symbol: 'DUSD',
+      fixedIntervalPriceId: 'DUSD/USD'
+    })
+    await testing.generate(1)
+
+    const address = await container.call('getnewaddress')
+    const metadata = {
+      symbol: 'BTC',
+      name: 'BTC Token',
+      isDAT: true,
+      mintable: true,
+      tradeable: true,
+      collateralAddress: address
+    }
+    await testing.rpc.token.createToken(metadata)
+    await testing.generate(1)
+
+    const dusdInfo = await testing.rpc.token.getToken('DUSD')
+    const dusdId = Object.keys(dusdInfo)[0]
+    key = `v0/token/${dusdId}`
+  })
+
+  afterAll(async () => {
+    await testing.container.stop()
+  })
+
+  it('should setGov with loan_payback and loan_payback_fee_pct', async () => {
+    const key0 = `${key}/loan_payback/1`
+    const key1 = `${key}/loan_payback/2`
+    const key2 = `${key}/loan_payback_fee_pct/1`
+    await testing.rpc.masternode.setGov({ [attributeKey]: { [key0]: 'true', [key1]: 'true', [key2]: '0.25' } })
+    await testing.container.generate(1)
+
+    const govAfter = await testing.rpc.masternode.getGov(attributeKey)
+    expect(govAfter.ATTRIBUTES[key0].toString()).toStrictEqual('true')
+    expect(govAfter.ATTRIBUTES[key1].toString()).toStrictEqual('true')
+    expect(govAfter.ATTRIBUTES[key2].toString()).toStrictEqual('0.25')
+  })
+
+  it('should setGov dfi keys with loan_payback and loan_payback_fee_pct', async () => {
+    const key0 = `${key}/loan_payback/0`
+    const key1 = `${key}/loan_payback_fee_pct/0`
+    await testing.rpc.masternode.setGov({ [attributeKey]: { [key0]: 'false', [key1]: '0.35' } })
+    await testing.container.generate(1)
+
+    const govAfter = await testing.rpc.masternode.getGov(attributeKey)
+    expect(govAfter.ATTRIBUTES[key0]).toBeUndefined()
+    expect(govAfter.ATTRIBUTES[key1]).toBeUndefined()
+
+    const key2 = `${key}/payback_dfi`
+    const key3 = `${key}/payback_dfi_fee_pct`
+    expect(govAfter.ATTRIBUTES[key2].toString()).toStrictEqual('false')
+    expect(govAfter.ATTRIBUTES[key3].toString()).toStrictEqual('0.35')
+  })
+})
diff --git a/packages/jellyfish-api-core/src/category/account.ts b/packages/jellyfish-api-core/src/category/account.ts
@@ -543,4 +543,12 @@ export interface BurnInfo {
    * Amount of tokens that are paid back; formatted as AMOUNT@SYMBOL
    */
   dfipaybacktokens: string[]
+  /**
+   * Amount of paybacks
+   */
+  paybackfees: string[]
+  /**
+   * Amount of tokens that are paid back
+   */
+  paybacktokens: string[]
 }
diff --git a/packages/jellyfish-api-core/src/category/loan.ts b/packages/jellyfish-api-core/src/category/loan.ts
@@ -357,16 +357,19 @@ export class Loan {
   /**
    * Return loan in a desired amount.
    *
-   * @param {PaybackLoanMetadata} metadata
+   * @param {PaybackLoanMetadata | PaybackLoanMetadataV2} metadata
    * @param {string} metadata.vaultId Vault id
    * @param {string| string[]} metadata.amounts In "amount@symbol" format
    * @param {string} metadata.from Address from transfer tokens
+   * @param {TokenPaybackAmount[]} metadata.loans
+   * @param {string | string[]} metadata.loans[0].amounts In "amount@symbol" format to be spent
+   * @param {string} metadata.loans[0].dToken Token to be paid
    * @param {UTXO[]} [utxos = []] Specific UTXOs to spend
    * @param {string} utxos.txid Transaction Id
    * @param {number} utxos.vout Output number
    * @return {Promise<string>} txid
    */
-  async paybackLoan (metadata: PaybackLoanMetadata, utxos: UTXO[] = []): Promise<string> {
+  async paybackLoan (metadata: PaybackLoanMetadata | PaybackLoanMetadataV2, utxos: UTXO[] = []): Promise<string> {
     return await this.client.call('paybackloan', [metadata, utxos], 'number')
   }
 
@@ -605,6 +608,17 @@ export interface PaybackLoanMetadata {
   from: string
 }
 
+export interface TokenPaybackAmount {
+  dToken: string
+  amounts: string | string[] // amount@symbol
+}
+
+export interface PaybackLoanMetadataV2 {
+  vaultId: string
+  from: string
+  loans: TokenPaybackAmount[]
+}
+
 export interface VaultPagination {
   start?: string
   including_start?: boolean