txn-builder: remove-oracle (#307)

* updated to latest image * Updated to 1.7.0 rc5 tag * Fix mining test * Initial setup * Updated test * Updated EunosHeight in RegTest container * Added override pair * Tests passing, added docs * Increased code coverage * Add `blockchain.getBlockStats`, `blockchain.getBestBlockHash` RPC (#256) * getBlockStats, getBestBlockHash RCP implementation * Fixed and implemented requested changes. * Fixed requested changes * Minor fixes * Changed assertion to toStricEquals, additional test for getblockstats * Update packages/jellyfish-api-core/src/category/blockchain.ts Co-authored-by: Fuxing Loh <[email protected]> * Update packages/jellyfish-api-core/__tests__/category/blockchain.test.ts Co-authored-by: Fuxing Loh <[email protected]> * Update packages/jellyfish-api-core/src/category/blockchain.ts Co-authored-by: Fuxing Loh <[email protected]> * Additional test cases for getBlockStats * Minor fixes * Update blockchain.md * Minor fixes * Update blockchain.md Co-authored-by: Fuxing Loh <[email protected]> * Added remove oracle and tests * Fix test * Tidy test * Apply suggestions from code review Co-authored-by: Fuxing Loh <[email protected]> Co-authored-by: Fuxing Loh <[email protected]> Co-authored-by: Suraj Auwal <[email protected]> Co-authored-by: Fuxing Loh <[email protected]>
BirthdayResearch · May 28, 2021 · 0302ad2 · 0302ad2
1 parent 8424ed8
commit 0302ad2
Show file tree

Hide file tree

Showing 4 changed files with 111 additions and 17 deletions.
diff --git a/packages/jellyfish-transaction-builder/__tests__/test.utils.ts b/packages/jellyfish-transaction-builder/__tests__/test.utils.ts
@@ -1,6 +1,6 @@
-import { Bech32, Elliptic, EllipticPair } from '@defichain/jellyfish-crypto'
+import { Bech32, Elliptic, EllipticPair, dSHA256 } from '@defichain/jellyfish-crypto'
 import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
-import { CTransactionSegWit, TransactionSegWit } from '@defichain/jellyfish-transaction'
+import { CTransaction, CTransactionSegWit, Transaction, TransactionSegWit } from '@defichain/jellyfish-transaction'
 import { SmartBuffer } from 'smart-buffer'
 import { BigNumber } from 'bignumber.js'
 
@@ -59,6 +59,12 @@ export async function sendTransaction (container: MasterNodeRegTestContainer, tr
   return tx.vout as TxOut[]
 }
 
+export function calculateTxid (transaction: Transaction): string {
+  const buffer = new SmartBuffer()
+  new CTransaction(transaction).toBuffer(buffer)
+  return dSHA256(buffer.toBuffer()).reverse().toString('hex')
+}
+
 export interface TxOut {
   value: number
   n: number

diff --git a/packages/jellyfish-transaction-builder/__tests__/txn/txn_builder_appoint_oracle.test.ts b/packages/jellyfish-transaction-builder/__tests__/txn/txn_builder_appoint_oracle.test.ts
@@ -61,21 +61,21 @@ describe('appoint oracle', () => {
     expect(prevouts[0].value.toNumber()).toBeLessThan(10)
     expect(prevouts[0].value.toNumber()).toBeGreaterThan(9.999)
   })
-})
 
-it('should reject invalid appoint oracle arg - weightage over 100', async () => {
-  // Appoint Oracle
-  const script = await providers.elliptic.script()
-  await expect(builder.oracles.appointOracle({
-    script: script,
-    weightage: 200,
-    priceFeeds: [
-      {
-        token: 'TEST',
-        currency: 'USD'
-      }
-    ]
-  }, script)).rejects.toThrow('Conversion input `appointOracle.weightage` must be above `0` and below `101`')
+  it('should reject invalid appoint oracle arg - weightage over 100', async () => {
+    // Appoint Oracle
+    const script = await providers.elliptic.script()
+    await expect(builder.oracles.appointOracle({
+      script: script,
+      weightage: 200,
+      priceFeeds: [
+        {
+          token: 'TEST',
+          currency: 'USD'
+        }
+      ]
+    }, script)).rejects.toThrow('Conversion input `appointOracle.weightage` must be above `0` and below `101`')
+  })
 })
 
 // TODO(monstrobishi): test account state once RPC calls are in place
diff --git a/packages/jellyfish-transaction-builder/__tests__/txn/txn_builder_remove_oracle.test.ts b/packages/jellyfish-transaction-builder/__tests__/txn/txn_builder_remove_oracle.test.ts
@@ -0,0 +1,74 @@
+import { MasterNodeRegTestContainer, GenesisKeys } from '@defichain/testcontainers'
+import { getProviders, MockProviders } from '../provider.mock'
+import { P2WPKHTransactionBuilder } from '../../src'
+import { calculateTxid, fundEllipticPair, sendTransaction } from '../test.utils'
+import { WIF } from '@defichain/jellyfish-crypto'
+
+const container = new MasterNodeRegTestContainer()
+let providers: MockProviders
+let builder: P2WPKHTransactionBuilder
+
+beforeAll(async () => {
+  await container.start()
+  await container.waitForReady()
+  await container.waitForWalletCoinbaseMaturity()
+
+  providers = await getProviders(container)
+  providers.setEllipticPair(WIF.asEllipticPair(GenesisKeys[GenesisKeys.length - 1].owner.privKey))
+  builder = new P2WPKHTransactionBuilder(providers.fee, providers.prevout, providers.elliptic)
+
+  // Prep 1000 DFI Token for testing
+  await container.waitForWalletBalanceGTE(1001)
+})
+
+afterAll(async () => {
+  await container.stop()
+})
+
+describe('remove oracle', () => {
+  beforeEach(async () => {
+    await container.waitForWalletBalanceGTE(1)
+  })
+
+  it('should appoint and then remove oracle', async () => {
+    // Fund 10 DFI UTXO
+    await fundEllipticPair(container, providers.ellipticPair, 10)
+    await providers.setupMocks() // required to move utxos
+
+    // Appoint Oracle
+    const script = await providers.elliptic.script()
+    const appointTxn = await builder.oracles.appointOracle({
+      script: script,
+      weightage: 1,
+      priceFeeds: [
+        {
+          token: 'TEST',
+          currency: 'USD'
+        }
+      ]
+    }, script)
+
+    const txid = calculateTxid(appointTxn)
+    await sendTransaction(container, appointTxn)
+
+    // Remove Oracle
+    const removeTxn = await builder.oracles.removeOracle({
+      oracleId: txid
+    }, script)
+
+    // Ensure the created txn is correct.
+    const outs = await sendTransaction(container, removeTxn)
+    expect(outs[0].value).toStrictEqual(0)
+    expect(outs[1].value).toBeLessThan(10)
+    expect(outs[1].value).toBeGreaterThan(9.999)
+    expect(outs[1].scriptPubKey.addresses[0]).toStrictEqual(await providers.getAddress())
+
+    // Ensure you don't send all your balance away during appoint oracle
+    const prevouts = await providers.prevout.all()
+    expect(prevouts.length).toStrictEqual(1)
+    expect(prevouts[0].value.toNumber()).toBeLessThan(10)
+    expect(prevouts[0].value.toNumber()).toBeGreaterThan(9.999)
+  })
+})
+
+// TODO(monstrobishi): test account state once RPC calls are in place
diff --git a/packages/jellyfish-transaction-builder/src/txn/txn_builder_oracles.ts b/packages/jellyfish-transaction-builder/src/txn/txn_builder_oracles.ts
@@ -1,4 +1,4 @@
-import { AppointOracle } from '@defichain/jellyfish-transaction/dist/script/defi/dftx_oracles'
+import { AppointOracle, RemoveOracle } from '@defichain/jellyfish-transaction/dist/script/defi/dftx_oracles'
 import { OP_CODES, Script, TransactionSegWit } from '@defichain/jellyfish-transaction'
 import { P2WPKHTxnBuilder } from './txn_builder'
 import { TxnBuilderError, TxnBuilderErrorType } from './txn_builder_error'
@@ -24,4 +24,18 @@ export class TxnBuilderOracles extends P2WPKHTxnBuilder {
       changeScript
     )
   }
+
+  /**
+   * Removes an oracle. Currently requires Foundation Authorization.
+   *
+   * @param {RemoveOracle} removeOracle txn to create
+   * @param {Script} changeScript to send unspent to after deducting the (converted + fees)
+   * @returns {Promise<TransactionSegWit>}
+   */
+  async removeOracle (removeOracle: RemoveOracle, changeScript: Script): Promise<TransactionSegWit> {
+    return await super.createDeFiTx(
+      OP_CODES.OP_DEFI_TX_REMOVE_ORACLE(removeOracle),
+      changeScript
+    )
+  }
 }