Merge the develop branch to the master branch, preparation to v2.4.0

CONFIGURATION.md

@@ -12,7 +12,7 @@ COMMON_HOME_GAS_PRICE_SUPPLIER_URL | The URL used to get a JSON response from th
 COMMON_HOME_GAS_PRICE_SPEED_TYPE | Assuming the gas price oracle responds with the following JSON structure: `{"fast": 20.0, "block_time": 12.834, "health": true, "standard": 6.0, "block_number": 6470469, "instant": 71.0, "slow": 1.889}`, this parameter specifies the desirable transaction speed. The speed type can be omitted when `COMMON_HOME_GAS_PRICE_SUPPLIER_URL` is not used. | `instant` / `fast` / `standard` / `slow`
 COMMON_HOME_GAS_PRICE_FALLBACK | The gas price (in Wei) that is used if both the oracle and the fall back gas price specified in the Home Bridge contract are not available. | integer
 COMMON_HOME_GAS_PRICE_FACTOR | A value that will multiply the gas price of the oracle to convert it to gwei. If the oracle API returns gas prices in gwei then this can be set to `1`. Also, it could be used to intentionally pay more gas than suggested by the oracle to guarantee the transaction verification. E.g. `1.25` or `1.5`. | integer
-COMMON_FOREIGN_GAS_PRICE_SUPPLIER_URL | The URL used to get a JSON response from the gas price prediction oracle for the Foreign network. The provided gas price is used to send the validator's transactions to the RPC node. If the Foreign network is Ethereum Foundation mainnet, the oracle URL can be: https://gasprice.poa.network. Otherwise this parameter can be omitted. | URL
+COMMON_FOREIGN_GAS_PRICE_SUPPLIER_URL | The URL used to get a JSON response from the gas price prediction oracle for the Foreign network. The provided gas price is used to send the validator's transactions to the RPC node. If the Foreign network is Ethereum Foundation mainnet, the oracle URL can be: https://gasprice.poa.network. Otherwise this parameter can be omitted. Set to `gas-price-oracle` if you want to use npm `gas-price-oracle` package for retrieving gas price from multiple sources. | URL
 COMMON_FOREIGN_GAS_PRICE_SPEED_TYPE | Assuming the gas price oracle responds with the following JSON structure: `{"fast": 20.0, "block_time": 12.834, "health": true, "standard": 6.0, "block_number": 6470469, "instant": 71.0, "slow": 1.889}`, this parameter specifies the desirable transaction speed. The speed type can be omitted when `COMMON_FOREIGN_GAS_PRICE_SUPPLIER_URL`is not used. | `instant` / `fast` / `standard` / `slow`
 COMMON_FOREIGN_GAS_PRICE_FALLBACK | The gas price (in Wei) used if both the oracle and fall back gas price specified in the Foreign Bridge contract are not available. | integer
 COMMON_FOREIGN_GAS_PRICE_FACTOR | A value that will multiply the gas price of the oracle to convert it to gwei. If the oracle API returns gas prices in gwei then this can be set to `1`. Also, it could be used to intentionally pay more gas than suggested by the oracle to guarantee the transaction verification. E.g. `1.25` or `1.5`. | integer

commons/abis.js

@@ -13,7 +13,6 @@ const REWARDABLE_VALIDATORS_ABI = require('../contracts/build/contracts/Rewardab
 const HOME_AMB_ABI = require('../contracts/build/contracts/HomeAMB').abi
 const FOREIGN_AMB_ABI = require('../contracts/build/contracts/ForeignAMB').abi
 const BOX_ABI = require('../contracts/build/contracts/Box').abi
-const SAI_TOP = require('../contracts/build/contracts/SaiTopMock').abi
 const HOME_AMB_ERC_TO_ERC_ABI = require('../contracts/build/contracts/HomeAMBErc677ToErc677').abi
 const FOREIGN_AMB_ERC_TO_ERC_ABI = require('../contracts/build/contracts/ForeignAMBErc677ToErc677').abi
 const HOME_STAKE_ERC_TO_ERC_ABI = require('../contracts/build/contracts/HomeStakeTokenMediator').abi
@@ -136,7 +135,6 @@ module.exports = {
   OLD_AMB_USER_REQUEST_FOR_AFFIRMATION_ABI,
   OLD_AMB_USER_REQUEST_FOR_SIGNATURE_ABI,
   BOX_ABI,
-  SAI_TOP,
   HOME_STAKE_ERC_TO_ERC_ABI,
   FOREIGN_STAKE_ERC_TO_ERC_ABI
 }

commons/package.json

@@ -8,6 +8,7 @@
     "test": "NODE_ENV=test mocha"
   },
   "dependencies": {
+    "gas-price-oracle": "^0.1.5",
     "web3-utils": "1.0.0-beta.34"
   },
   "devDependencies": {

commons/utils.js

@@ -1,7 +1,10 @@
 const { toWei, toBN } = require('web3-utils')
+const { GasPriceOracle } = require('gas-price-oracle')
 const { BRIDGE_MODES, FEE_MANAGER_MODE, ERC_TYPES } = require('./constants')
 const { REWARDABLE_VALIDATORS_ABI } = require('./abis')
 
+const gasPriceOracle = new GasPriceOracle()
+
 function decodeBridgeMode(bridgeModeHash) {
   switch (bridgeModeHash) {
     case '0x92a8d7fe':
@@ -235,8 +238,13 @@ const normalizeGasPrice = (oracleGasPrice, factor, limits = null) => {
 // we use built-in 'fetch' on browser side, and `node-fetch` package in Node.
 const gasPriceFromSupplier = async (fetchFn, options = {}) => {
   try {
-    const response = await fetchFn()
-    const json = await response.json()
+    let json
+    if (fetchFn) {
+      const response = await fetchFn()
+      json = await response.json()
+    } else {
+      json = await gasPriceOracle.fetchGasPricesOffChain()
+    }
     const oracleGasPrice = json[options.speedType]
 
     if (!oracleGasPrice) {

e2e-commons/constants.json

@@ -50,8 +50,6 @@
     "home": "0x488Af810997eD1730cB3a3918cD83b3216E6eAda",
     "foreign": "0x488Af810997eD1730cB3a3918cD83b3216E6eAda",
     "foreignToken": "0x7cc4b1851c35959d34e635a470f6b5c43ba3c9c9",
-    "halfDuplexToken": "0x89d24A6b4CcB1B6fAA2625fE562bDD9a23260359",
-    "saiTop": "0x9b0ccf7C8994E19F39b2B4CF708e0A7DF65fA8a3",
     "chaiToken": "0x06af07097c9eeb7fd685c692751d5c66db49c215",
     "ui": "http://localhost:3002",
     "monitor": "http://monitor-erc20-native:3012/bridge"

e2e-commons/up.sh

@@ -22,8 +22,6 @@ startValidator () {
     docker-compose $1 run $2 $3 -d oracle-erc20-native yarn watcher:collected-signatures
     docker-compose $1 run $2 $3 -d oracle-erc20-native yarn watcher:affirmation-request
     docker-compose $1 run $2 $3 -d oracle-erc20-native yarn watcher:transfer
-    docker-compose $1 run $2 $3 -d oracle-erc20-native yarn watcher:half-duplex-transfer
-    docker-compose $1 run $2 $3 -d oracle-erc20-native yarn worker:swap-tokens
     docker-compose $1 run $2 $3 -d oracle-erc20-native yarn worker:convert-to-chai
     docker-compose $1 run $2 $3 -d oracle-amb yarn watcher:signature-request
     docker-compose $1 run $2 $3 -d oracle-amb yarn watcher:collected-signatures
@@ -57,8 +55,6 @@ while [ "$1" != "" ]; do
     docker-compose run -d oracle-erc20-native yarn watcher:collected-signatures
     docker-compose run -d oracle-erc20-native yarn watcher:affirmation-request
     docker-compose run -d oracle-erc20-native yarn watcher:transfer
-    docker-compose run -d oracle-erc20-native yarn watcher:half-duplex-transfer
-    docker-compose run -d oracle-erc20-native yarn worker:swap-tokens
     docker-compose run -d oracle-erc20-native yarn worker:convert-to-chai
     docker-compose run -d oracle-amb yarn watcher:signature-request
     docker-compose run -d oracle-amb yarn watcher:collected-signatures

monitor/docker-compose-build.yml

@@ -3,4 +3,6 @@ version: '2.4'
 services:
   monitor:
     image: poanetwork/tokenbridge-monitor
-    build: .
+    build:
+      context: ..
+      dockerfile: ./monitor/Dockerfile

monitor/validators.js

@@ -100,8 +100,13 @@ async function main(bridgeMode) {
 
   if (MONITOR_VALIDATOR_FOREIGN_TX_LIMIT) {
     logger.debug('calling foreign getGasPrices')
+    const fetchFn =
+      COMMON_FOREIGN_GAS_PRICE_SUPPLIER_URL === 'gas-price-oracle'
+        ? null
+        : () => fetch(COMMON_FOREIGN_GAS_PRICE_SUPPLIER_URL)
+
     foreignGasPrice =
-      (await gasPriceFromSupplier(() => fetch(COMMON_FOREIGN_GAS_PRICE_SUPPLIER_URL), foreignGasPriceSupplierOpts)) ||
+      (await gasPriceFromSupplier(fetchFn, foreignGasPriceSupplierOpts)) ||
       Web3Utils.toBN(COMMON_FOREIGN_GAS_PRICE_FALLBACK)
     foreignGasPriceGwei = Web3Utils.fromWei(foreignGasPrice.toString(), 'gwei')
     foreignTxCost = foreignGasPrice.mul(Web3Utils.toBN(MONITOR_VALIDATOR_FOREIGN_TX_LIMIT))

oracle-e2e/test/ercToNative.js

@@ -31,12 +31,7 @@ const foreignBridge = new foreignWeb3.eth.Contract(FOREIGN_ERC_TO_NATIVE_ABI, CO
 const homeBridge = new homeWeb3.eth.Contract(HOME_ERC_TO_NATIVE_ABI, COMMON_HOME_BRIDGE_ADDRESS)
 
 describe('erc to native', () => {
-  let halfDuplexTokenAddress
-  let halfDuplexToken
   before(async () => {
-    halfDuplexTokenAddress = await foreignBridge.methods.halfDuplexErc20token().call()
-    halfDuplexToken = new foreignWeb3.eth.Contract(ERC677_BRIDGE_TOKEN_ABI, halfDuplexTokenAddress)
-
     // Set 2 required signatures for home bridge
     await setRequiredSignatures({
       bridgeContract: homeBridge,
@@ -59,85 +54,6 @@ describe('erc to native', () => {
       }
     })
   })
-  it('should not convert half duplex tokens to native tokens in home', async () => {
-    const originalBalanceOnHome = await homeWeb3.eth.getBalance(user.address)
-
-    const transferValue = homeWeb3.utils.toWei('0.01')
-
-    // send tokens to foreign bridge
-    await halfDuplexToken.methods
-      .transfer(COMMON_FOREIGN_BRIDGE_ADDRESS, transferValue)
-      .send({
-        from: user.address,
-        gas: '1000000'
-      })
-      .catch(e => {
-        console.error(e)
-      })
-
-    // check that balance does not increases
-    await promiseRetry(async (retry, number) => {
-      const balance = await homeWeb3.eth.getBalance(user.address)
-      // retry at least 4 times to check transfer is not processed
-      if (toBN(balance).eq(toBN(originalBalanceOnHome)) && number < 4) {
-        retry()
-      } else {
-        assert(toBN(balance).eq(toBN(originalBalanceOnHome)), 'User balance should not be increased')
-      }
-    })
-
-    // send tokens to foreign bridge
-    await erc20Token.methods
-      .transfer(COMMON_FOREIGN_BRIDGE_ADDRESS, transferValue)
-      .send({
-        from: user.address,
-        gas: '1000000'
-      })
-      .catch(e => {
-        console.error(e)
-      })
-
-    // check that balance increases
-    await promiseRetry(async (retry, number) => {
-      const balance = await homeWeb3.eth.getBalance(user.address)
-      // retry at least 4 times to check transfer is not double processed by the two watchers
-      if (toBN(balance).lte(toBN(originalBalanceOnHome)) || number < 4) {
-        retry()
-      } else {
-        assert(
-          toBN(balance).eq(toBN(originalBalanceOnHome).add(toBN(transferValue))),
-          'User balance should be increased only by second transfer'
-        )
-      }
-    })
-
-    const afterTransferBalance = await homeWeb3.eth.getBalance(user.address)
-
-    // send tokens to foreign bridge
-    await erc20Token.methods
-      .transfer(COMMON_FOREIGN_BRIDGE_ADDRESS, transferValue)
-      .send({
-        from: user.address,
-        gas: '1000000'
-      })
-      .catch(e => {
-        console.error(e)
-      })
-
-    // check that balance increases
-    await promiseRetry(async (retry, number) => {
-      const balance = await homeWeb3.eth.getBalance(user.address)
-      // retry at least 4 times to check transfer is not double processed by the two watchers
-      if (toBN(balance).lte(toBN(afterTransferBalance)) || number < 4) {
-        retry()
-      } else {
-        assert(
-          toBN(balance).eq(toBN(afterTransferBalance).add(toBN(transferValue))),
-          'User balance should be increased'
-        )
-      }
-    })
-  })
   it('should convert tokens in foreign to coins in home', async () => {
     const balance = await erc20Token.methods.balanceOf(user.address).call()
     const originalBalanceOnHome = await homeWeb3.eth.getBalance(user.address)

oracle/docker-compose-build.yml

@@ -3,4 +3,6 @@ version: '2.4'
 services:
   oracle:
     image: poanetwork/tokenbridge-oracle
-    build: .
+    build:
+      context: ..
+      dockerfile: ./oracle/Dockerfile

oracle/docker-compose-erc-native.yml

@@ -7,16 +7,13 @@ services:
       service: rabbit
     networks:
       - net_rabbit_bridge_transfer
-      - net_rabbit_bridge_half_duplex_transfer
-      - net_rabbit_bridge_swap_tokens_worker
       - net_rabbit_bridge_convert_to_chai_worker
   redis:
     extends:
       file: docker-compose.yml
       service: redis
     networks:
       - net_db_bridge_transfer
-      - net_db_bridge_half_duplex_transfer
   bridge_request:
     extends:
       file: docker-compose.yml
@@ -51,31 +48,6 @@ services:
     networks:
       - net_db_bridge_transfer
       - net_rabbit_bridge_transfer
-  bridge_half_duplex_transfer:
-    cpus: 0.1
-    mem_limit: 500m
-    image: poanetwork/tokenbridge-oracle:latest
-    env_file: ./.env
-    environment:
-      - NODE_ENV=production
-      - ORACLE_VALIDATOR_ADDRESS=${ORACLE_VALIDATOR_ADDRESS}
-    restart: unless-stopped
-    entrypoint: yarn watcher:half-duplex-transfer
-    networks:
-      - net_db_bridge_half_duplex_transfer
-      - net_rabbit_bridge_half_duplex_transfer
-  bridge_swap_tokens_worker:
-    cpus: 0.1
-    mem_limit: 500m
-    image: poanetwork/tokenbridge-oracle:latest
-    env_file: ./.env
-    environment:
-      - NODE_ENV=production
-      - ORACLE_VALIDATOR_ADDRESS=${ORACLE_VALIDATOR_ADDRESS}
-    restart: unless-stopped
-    entrypoint: yarn worker:swap-tokens
-    networks:
-      - net_rabbit_bridge_swap_tokens_worker
   bridge_convert_to_chai_worker:
     cpus: 0.1
     mem_limit: 500m
@@ -112,8 +84,6 @@ networks:
     driver: bridge
   net_db_bridge_transfer:
     driver: bridge
-  net_db_bridge_half_duplex_transfer:
-    driver: bridge
   net_db_bridge_senderhome:
     driver: bridge
   net_db_bridge_senderforeign:
@@ -126,10 +96,6 @@ networks:
     driver: bridge
   net_rabbit_bridge_transfer:
     driver: bridge
-  net_rabbit_bridge_half_duplex_transfer:
-    driver: bridge
-  net_rabbit_bridge_swap_tokens_worker:
-    driver: bridge
   net_rabbit_bridge_senderhome:
     driver: bridge
   net_rabbit_bridge_senderforeign:

oracle/package.json

@@ -9,13 +9,11 @@
     "watcher:collected-signatures": "./scripts/start-worker.sh watcher collected-signatures-watcher",
     "watcher:affirmation-request": "./scripts/start-worker.sh watcher affirmation-request-watcher",
     "watcher:transfer": "./scripts/start-worker.sh watcher transfer-watcher",
-    "watcher:half-duplex-transfer": "./scripts/start-worker.sh watcher half-duplex-transfer-watcher",
-    "worker:swap-tokens": "./scripts/start-worker.sh worker swap-tokens-worker",
     "worker:convert-to-chai": "./scripts/start-worker.sh worker convert-to-chai-worker",
     "sender:home": "./scripts/start-worker.sh sender home-sender",
     "sender:foreign": "./scripts/start-worker.sh sender foreign-sender",
     "confirm:transfer": "./scripts/start-worker.sh confirmRelay transfer-watcher",
-    "dev": "concurrently -n 'watcher:signature-request,watcher:collected-signatures,watcher:affirmation-request,watcher:transfer,watcher:half-duplex-transfer, worker:swap-tokens, sender:home,sender:foreign' -c 'red,green,yellow,blue,white,gray,magenta,cyan' 'yarn watcher:signature-request' 'yarn watcher:collected-signatures' 'yarn watcher:affirmation-request' 'yarn watcher:transfer' 'yarn watcher:half-duplex-transfer' 'yarn worker:swap-tokens' 'yarn sender:home' 'yarn sender:foreign'",
+    "dev": "concurrently -n 'watcher:signature-request,watcher:collected-signatures,watcher:affirmation-request,watcher:transfer, sender:home,sender:foreign' -c 'red,green,yellow,blue,magenta,cyan' 'yarn watcher:signature-request' 'yarn watcher:collected-signatures' 'yarn watcher:affirmation-request' 'yarn watcher:transfer' 'yarn sender:home' 'yarn sender:foreign'",
     "test": "NODE_ENV=test mocha",
     "test:watch": "NODE_ENV=test mocha --watch --reporter=min",
     "coverage": "NODE_ENV=test nyc --reporter=text --reporter=html mocha",