Merge pull request #51 from gnosis/refactor/testrpc-time

Refactor/testrpc time

Author: Velenir

contracts/DutchExchange.sol

@@ -263,13 +263,13 @@ contract DutchExchange {
 
     // --- For Testing only! ---
 
-    uint256 public now = 1508473469;
-    function increaseTimeBy(uint256 byHours, uint256 bySeconds) public {
-        now += byHours * 1 hours;
-        now += bySeconds;
-    }
-
-    function setTime(uint256 newTime) public {
-        now = newTime;
-    }
+    // uint256 public now = 1508473469;
+    // function increaseTimeBy(uint256 byHours, uint256 bySeconds) public {
+    //     now += byHours * 1 hours;
+    //     now += bySeconds;
+    // }
+
+    // function setTime(uint256 newTime) public {
+    //     now = newTime;
+    // }
 }

src/test/browser/ETH2GNO.test.ts

@@ -8,6 +8,7 @@ declare module 'expect' {
 }
 
 import { delay, metamaskWarning } from '../utils'
+import web3Utils from '../../../trufflescripts/utils'
 
 import DXart from '../../../build/contracts/DutchExchangeETHGNO.json'
 import ETHart from '../../../build/contracts/TokenETH.json'
@@ -53,6 +54,7 @@ const withLocalProvider = async (func: () => void) => {
   setCurrentProvider()
 }
 
+const { getTime, increaseTimeBy, setTime } = web3Utils(web3)
 
 describe('ETH 2 GNO contract standalone', () => {
   // TODO: proper types
@@ -170,14 +172,10 @@ describe('ETH 2 GNO contract standalone', () => {
     const sellerGNOBalance = await gno.balanceOf(seller)
     const buyerGNOBalance = await gno.balanceOf(buyer)
 
-    expect(masterETHBalance.add(sellerETHBalance)).toEqual(ETHtotal)
-    expect(masterGNOBalance.add(buyerGNOBalance)).toEqual(GNOtotal)
-
-    expect(sellerGNOBalance.toNumber()).toBe(0)
-    expect(buyerETHBalance.toNumber()).toBe(0)
+    expect(masterETHBalance.add(sellerETHBalance).add(buyerETHBalance)).toEqual(ETHtotal)
+    expect(masterGNOBalance.add(sellerGNOBalance).add(buyerGNOBalance)).toEqual(GNOtotal)
   })
 
-  // TODO: rework to make a part of submit -> buy -> claim flow
   it('seller can submit order to an auction', async () => {
     const amount = 30
 
@@ -217,16 +215,16 @@ describe('ETH 2 GNO contract standalone', () => {
     // still on the first auction
     expect(auctionIndex).toBe(1)
     const auctionStart = (await dx.auctionStart()).toNumber()
-    let now = (await dx.now()).toNumber()
+    let now = getTime()
 
     // auction hasn't started yet
     expect(auctionStart).toBeGreaterThan(now)
     const timeUntilStart = auctionStart - now
 
     await withLocalProvider(async () => {
       // move time to start + 1 hour
-      await dx.increaseTimeBy(1, timeUntilStart, { from: master })
-      now = (await dx.now()).toNumber()
+      increaseTimeBy(timeUntilStart + 3600)
+      now = getTime()
     })
 
     // auction has started
@@ -351,7 +349,7 @@ describe('ETH 2 GNO contract standalone', () => {
     const timeWhenAuctionClears = Math.ceil(72000 * sellVolume / buyVolume - 18000 + auctionStart)
 
     await withLocalProvider(async () => {
-      await dx.setTime(timeWhenAuctionClears, { from: master })
+      setTime(timeWhenAuctionClears)
       const buyerBalance = (await dx.buyerBalances(auctionIndex, buyer)).toNumber()
       const amount = 1
       await gno.approve(dxa, amount, { from: buyer })
@@ -378,7 +376,7 @@ describe('ETH 2 GNO contract standalone', () => {
     // still on the first auction
     expect(auctionIndex).toBe(2)
     const auctionStart = (await dx.auctionStart()).toNumber()
-    const now = (await dx.now()).toNumber()
+    const now = getTime()
 
     // next auction hasn't started yet
     expect(auctionStart).toBeGreaterThan(now)

src/test/browser/ETH2GNO_Abstract.test.ts

@@ -1,5 +1,6 @@
 import expect from 'expect'
 import { delay, metamaskWarning } from '../utils'
+import web3Utils from '../../../trufflescripts/utils'
 
 import { initDutchXConnection } from 'api/dutchx'
 import DXart from '../../../build/contracts/DutchExchangeETHGNO.json'
@@ -20,6 +21,8 @@ const web3 = new Web3(localProvider)
 // Set ONLY DutchExchangeETHGNO to the localProvider
 DX.setProvider(localProvider)
 
+const { getTime, increaseTimeBy, setTime } = web3Utils(web3)
+
 describe('ETH 2 GNO contract via DutchX Class', () => {
   // TODO: proper types
   let dxClass: any
@@ -147,16 +150,17 @@ describe('ETH 2 GNO contract via DutchX Class', () => {
     const ETHtotal = await eth.getTotalSupply()
     const masterETHBalance = await eth.balanceOf(master)
     const sellerETHBalance = await eth.balanceOf(seller)
+    const buyerETHBalance = await eth.balanceOf(buyer)
 
     const GNOtotal = await gno.getTotalSupply()
     const masterGNOBalance = await gno.balanceOf(master)
+    const sellerGNOBalance = await gno.balanceOf(seller)
     const buyerGNOBalance = await gno.balanceOf(buyer)
 
-    expect(masterETHBalance.add(sellerETHBalance)).toEqual(ETHtotal)
-    expect(masterGNOBalance.add(buyerGNOBalance)).toEqual(GNOtotal)
+    expect(masterETHBalance.add(sellerETHBalance).add(buyerETHBalance)).toEqual(ETHtotal)
+    expect(masterGNOBalance.add(sellerGNOBalance).add(buyerGNOBalance)).toEqual(GNOtotal)
   })
 
-  // TODO: rework to make a part of submit -> buy -> claim flow
   it('seller can submit order to an auction', async () => {
     const amount = 30
 
@@ -194,15 +198,15 @@ describe('ETH 2 GNO contract via DutchX Class', () => {
     // still on the first auction
     expect(auctionIndex).toBe(1)
     const auctionStart = (await dx.auctionStart()).toNumber()
-    let now = (await dx.now()).toNumber()
+    let now = getTime()
 
     // auction hasn't started yet
     expect(auctionStart).toBeGreaterThan(now)
     const timeUntilStart = auctionStart - now
 
     // move time to start + 1 hour
-    await dx.increaseTimeBy(1, timeUntilStart, { from: master })
-    now = (await dx.now()).toNumber()
+    increaseTimeBy(timeUntilStart + 3600)
+    now = getTime()
 
     // auction has started
     expect(auctionStart).toBeLessThan(now)
@@ -278,8 +282,6 @@ describe('ETH 2 GNO contract via DutchX Class', () => {
     // balance is kept as a record, just can't be claimed twice
     expect(buyerBalance).toBe(buyerBalancesAfter)
     expect(buyVolumeAfter).toBe(buyVolume)
-
-
   })
 
 
@@ -322,7 +324,7 @@ describe('ETH 2 GNO contract via DutchX Class', () => {
     const timeWhenAuctionClears = Math.ceil(72000 * sellVolume / buyVolume - 18000 + auctionStart)
 
 
-    await dx.setTime(timeWhenAuctionClears, { from: master })
+    setTime(timeWhenAuctionClears)
     const buyerBalance = (await dx.buyerBalances(auctionIndex, buyer)).toNumber()
     const amount = 1
     await gno.approve(dxa, amount, { from: buyer })
@@ -345,7 +347,7 @@ describe('ETH 2 GNO contract via DutchX Class', () => {
     // still on the first auction
     expect(auctionIndex).toBe(2)
     const auctionStart = (await dx.auctionStart()).toNumber()
-    const now = (await dx.now()).toNumber()
+    const now = getTime()
 
     // next auction hasn't started yet
     expect(auctionStart).toBeGreaterThan(now)

stories/TopAuctions.tsx

@@ -26,5 +26,5 @@ storiesOf(`TopAuctions`, module)
   .addDecorator(CenterDecor)
   .addWithJSX('5 random pairs', () => {
     const top5Pairs = getTop5Pairs(ratioPairs.map((pair, i) => object(`Pair ${i}`, pair)))
-    return <TopAuctions pairs={top5Pairs} selectTokenPair={stringifyAction('SELECT_TOKEN_PAIR')} />
+    return <TopAuctions pairs={top5Pairs} selectTokenPairAndSetClosingPrice={stringifyAction('SELECT_TOKEN_PAIR')} />
   })

test/ETH2GNO.js

@@ -52,13 +52,15 @@ contract('ETH to GNO auctionz', async (accounts) => {
     const ETHtotal = await ETH.getTotalSupply()
     const initialiserETHBalance = await ETH.balanceOf(initialiser)
     const sellerETHBalance = await ETH.balanceOf(seller)
+    const buyerETHBalance = await ETH.balanceOf(buyer)
 
     const GNOtotal = await GNO.getTotalSupply()
     const initialiserGNOBalance = await GNO.balanceOf(initialiser)
+    const sellerGNOBalance = await GNO.balanceOf(seller)
     const buyerGNOBalance = await GNO.balanceOf(buyer)
 
-    assert.deepEqual(initialiserETHBalance.add(sellerETHBalance), ETHtotal)
-    assert.deepEqual(initialiserGNOBalance.add(buyerGNOBalance), GNOtotal)
+    assert.deepEqual(initialiserETHBalance.add(sellerETHBalance).add(buyerETHBalance), ETHtotal)
+    assert.deepEqual(initialiserGNOBalance.add(sellerGNOBalance).add(buyerGNOBalance), GNOtotal)
   })
 
 

trufflescripts/buy_order.js

@@ -78,7 +78,7 @@ module.exports = async () => {
 
   [buyVolume, buyerBalance, buyerGNOBalance] = await buyerStats()
 
-  console.log(`now:
+  console.log(`  now:
     buyVolume:\t${buyVolume}
     buyerBalance:\t${buyerBalance} in auction
     \t\t\t${buyerGNOBalance} GNO in account

trufflescripts/get_auction_stats.js

@@ -1,4 +1,7 @@
 const DutchExchangeETHGNO = artifacts.require('./DutchExchangeETHGNO.sol')
+const TokenETH = artifacts.require('./TokenETH.sol')
+const TokenGNO = artifacts.require('./TokenGNO.sol')
+const { getTime } = require('./utils')(web3)
 
 const getTimeStr = (timestamp) => {
   const date = new Date(Math.abs(timestamp))
@@ -16,8 +19,16 @@ const getTimeStr = (timestamp) => {
 
 module.exports = async () => {
   const dx = await DutchExchangeETHGNO.deployed()
+  const eth = await TokenETH.deployed()
+  const gno = await TokenGNO.deployed()
+
+  const dxETHBalance = (await eth.balanceOf(dx.address)).toNumber()
+  const dxGNOBalance = (await gno.balanceOf(dx.address)).toNumber()
+
+  console.log(`Auction holds:\t${dxETHBalance} ETH\t${dxGNOBalance} GNO`)
+
   const auctionStart = (await dx.auctionStart()).toNumber()
-  const now = (await dx.now()).toNumber()
+  const now = getTime()
 
   const timeUntilStart = auctionStart - now
   const timeStr = getTimeStr(timeUntilStart * 1000)

trufflescripts/increase_time.js

@@ -1,4 +1,5 @@
 const DutchExchangeETHGNO = artifacts.require('./DutchExchangeETHGNO.sol')
+const { getTime, increaseTimeBy, setTime } = require('./utils')(web3)
 
 const argv = require('minimist')(process.argv.slice(2))
 
@@ -30,7 +31,7 @@ module.exports = async () => {
 
   const printAuctionTimes = async () => {
     const auctionStart = (await dx.auctionStart()).toNumber()
-    const now = (await dx.now()).toNumber()
+    const now = getTime()
 
     const timeUntilStart = auctionStart - now
     const timeStr = getTimeStr(timeUntilStart * 1000)
@@ -71,13 +72,13 @@ module.exports = async () => {
   console.log(`Setting time to ${argv.start ? 'AUCTION_START' : argv.clear ? 'AUCTION_END' : ''} ${incTimeBy ? `+ ${getTimeStr(incTimeBy * 1000)}` : ''}`)
 
   if (argv.start) {
-    await dx.setTime(auctionStart)
+    setTime(auctionStart)
   } else if (argv.clear && timeWhenAuctionClears !== Infinity) {
-    await dx.setTime(timeWhenAuctionClears)
+    setTime(timeWhenAuctionClears)
   }
 
   if (incTimeBy) {
-    await dx.increaseTimeBy(0, incTimeBy)
+    increaseTimeBy(incTimeBy)
   }
 
   console.log('==========================')

trufflescripts/revert.js

@@ -0,0 +1,43 @@
+/* eslint no-console:0 prefer-const:1 */
+const { revertSnapshot } = require('./utils')(web3)
+
+const argv = require('minimist')(process.argv.slice(2), { string: 'a' })
+
+/**
+ * truffle exec trufflescripts/claim_funds.js
+ * to claim funds for the current auction for both seller and buyer,
+ * from auction's sellerBalances and buyerBalances respectively
+ * @flags:
+ * --seller                     sellerBalance for seller only
+ * --buyer                      buyerBalance for buyer only
+ * -a seller|buyer|<address>    for the given address
+ * -i <index>                   for auction with given index
+ * --last                       for last auction
+ */
+
+module.exports = async () => {
+  let snapshotID
+
+  snapshotID = argv.b || '0x01'
+
+  const timeout = new Promise((resolve, reject) => setTimeout(() => reject(new Error('TIMED-OUT')), 1500))
+  const race = Promise.race([timeout, revertSnapshot(snapshotID)])
+  try {
+    await race
+    console.warn(`
+      CAUTION: Reverting does NOT roll back time to snapshot time. You've been warned...
+    `)
+    console.log(`
+      REVERTED TO SNAPSHOT-ID:  # ${snapshotID}
+      BLOCKNUMBER:              ${web3.eth.blockNumber}
+    `)
+  } catch (e) {
+    console.log(e)
+
+    // Due to lock in rpc, kill w/Node
+    process.on('exit', () => {
+      console.log('KILLING SCRIPT')
+    })
+    process.exit()
+  }
+}

trufflescripts/snapshot.js

@@ -0,0 +1,15 @@
+const { makeSnapshot } = require('./utils')(web3)
+
+/**
+ * truffle exec trufflescripts/snapshot.js
+ * Created snapshot of blockchain state and assigns a Block-ID
+ * Block-ID can be reverted back to via revert.js
+ */
+
+module.exports = () => {
+  const snapshot = makeSnapshot()
+  console.log(`
+    SNAPSHOT CREATED: # ${snapshot}
+    BLOCK-NUMBER:     ${web3.eth.blockNumber} 
+  `)
+}

trufflescripts/start_auction.js

@@ -1,22 +1,26 @@
+/* eslint no-console:0 */
 const DutchExchangeETHGNO = artifacts.require('./DutchExchangeETHGNO.sol')
+const { getTime, increaseTimeBy } = require('./utils')(web3)
 
 /**
  * truffle exec trufflescripts/start_auction.js
  * if auction isn't running,
  * sets time to auction start + 1 hour
  */
 
+const hour = 3600
+
 module.exports = async () => {
   const dx = await DutchExchangeETHGNO.deployed()
   const auctionStart = (await dx.auctionStart()).toNumber()
-  const now = (await dx.now()).toNumber()
+  const now = getTime()
   const timeUntilStart = auctionStart - now
 
   const auctionIndex = (await dx.auctionIndex()).toNumber()
 
   // auctionStart is in the future
   if (timeUntilStart > 0) {
-    await dx.increaseTimeBy(1, timeUntilStart)
+    increaseTimeBy(timeUntilStart + hour)
     console.log(`ETH -> GNO auction ${auctionIndex} started`)
   } else {
     console.log(`ETH -> GNO auction ${auctionIndex} is already running`)