Add half duplex transfer watcher

oracle/config/half-duplex-transfer-watcher.config.js

@@ -0,0 +1,37 @@
+const baseConfig = require('./base.config')
+const { ERC20_ABI } = require('../../commons')
+const { EXIT_CODES } = require('../src/utils/constants')
+
+const initialChecksJson = process.argv[3]
+
+if (!initialChecksJson) {
+  throw new Error('initial check parameter was not provided.')
+}
+
+let initialChecks
+try {
+  initialChecks = JSON.parse(initialChecksJson)
+} catch (e) {
+  throw new Error('Error on decoding values from initial checks.')
+}
+
+const id = `${baseConfig.id}-half-duplex-transfer`
+
+const transferWatcherRequired = baseConfig.id === 'erc-native'
+
+if (!transferWatcherRequired) {
+  console.error(`Transfer watcher not required for bridge mode ${process.env.ORACLE_BRIDGE_MODE}`)
+  process.exit(EXIT_CODES.WATCHER_NOT_REQUIRED)
+}
+
+module.exports = {
+  ...baseConfig.bridgeConfig,
+  ...baseConfig.foreignConfig,
+  event: 'Transfer',
+  eventContractAddress: initialChecks.halfDuplexTokenAddress,
+  eventAbi: ERC20_ABI,
+  eventFilter: { to: process.env.COMMON_FOREIGN_BRIDGE_ADDRESS },
+  queue: 'home',
+  name: `watcher-${id}`,
+  id
+}

oracle/docker-compose-transfer.yml

@@ -49,6 +49,21 @@ services:
     networks:
       - net_db_bridge_transfer
       - net_rabbit_bridge_transfer
+  bridge_half_duplex_transfer:
+    cpus: 0.1
+    mem_limit: 500m
+    build:
+      context: ..
+      dockerfile: oracle/Dockerfile
+    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_senderhome:
     extends:
       file: docker-compose.yml
@@ -73,6 +88,8 @@ 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:
@@ -85,6 +102,8 @@ networks:
     driver: bridge
   net_rabbit_bridge_transfer:
     driver: bridge
+  net_rabbit_bridge_half_duplex_transfer:
+    driver: bridge
   net_rabbit_bridge_senderhome:
     driver: bridge
   net_rabbit_bridge_senderforeign:

oracle/package.json

@@ -9,9 +9,10 @@
     "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",
     "sender:home": "./scripts/start-worker.sh sender home-sender",
     "sender:foreign": "./scripts/start-worker.sh sender foreign-sender",
-    "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'",
+    "dev": "concurrently -n 'watcher:signature-request,watcher:collected-signatures,watcher:affirmation-request,watcher:transfer,watcher:half-duplex-transfer,sender:home,sender:foreign' -c 'red,green,yellow,blue,white,magenta,cyan' 'yarn watcher:signature-request' 'yarn watcher:collected-signatures' 'yarn watcher:affirmation-request' 'yarn watcher:transfer' 'yarn watcher:half-duplex-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",

oracle/scripts/initialChecks.js

@@ -18,6 +18,7 @@ async function initialChecks() {
   } else if (ORACLE_BRIDGE_MODE === 'ERC_TO_NATIVE') {
     const bridge = new foreignWeb3.eth.Contract(FOREIGN_ERC_TO_NATIVE_ABI, COMMON_FOREIGN_BRIDGE_ADDRESS)
     result.bridgeableTokenAddress = await bridge.methods.erc20token().call()
+    result.halfDuplexTokenAddress = await bridge.methods.halfDuplexErc20token().call()
   }
 
   if (ORACLE_BRIDGE_MODE === 'ERC_TO_ERC') {

oracle/src/events/processHalfDuplexTransfers/index.js

@@ -0,0 +1,132 @@
+require('../../../env')
+const promiseLimit = require('promise-limit')
+const { HttpListProviderError } = require('http-list-provider')
+const { BRIDGE_VALIDATORS_ABI, ZERO_ADDRESS } = require('../../../../commons')
+const rootLogger = require('../../services/logger')
+const { web3Home, web3Foreign } = require('../../services/web3')
+const { AlreadyProcessedError, AlreadySignedError, InvalidValidatorError } = require('../../utils/errors')
+const { EXIT_CODES, MAX_CONCURRENT_EVENTS } = require('../../utils/constants')
+const estimateGas = require('../processAffirmationRequests/estimateGas')
+
+const limit = promiseLimit(MAX_CONCURRENT_EVENTS)
+
+let validatorContract = null
+
+function processTransfersBuilder(config) {
+  const homeBridge = new web3Home.eth.Contract(config.homeBridgeAbi, config.homeBridgeAddress)
+  const foreignBridge = new web3Home.eth.Contract(config.foreignBridgeAbi, config.foreignBridgeAddress)
+  const userRequestForAffirmationAbi = config.foreignBridgeAbi.filter(
+    e => e.type === 'event' && e.name === 'UserRequestForAffirmation'
+  )[0]
+  const tokensSwappedAbi = config.foreignBridgeAbi.filter(e => e.type === 'event' && e.name === 'TokensSwapped')[0]
+  const userRequestForAffirmationHash = web3Home.eth.abi.encodeEventSignature(userRequestForAffirmationAbi)
+  const tokensSwappedHash = tokensSwappedAbi ? web3Home.eth.abi.encodeEventSignature(tokensSwappedAbi) : '0x'
+
+  return async function processTransfers(transfers) {
+    const txToSend = []
+
+    if (validatorContract === null) {
+      rootLogger.debug('Getting validator contract address')
+      const validatorContractAddress = await homeBridge.methods.validatorContract().call()
+      rootLogger.debug({ validatorContractAddress }, 'Validator contract address obtained')
+
+      validatorContract = new web3Home.eth.Contract(BRIDGE_VALIDATORS_ABI, validatorContractAddress)
+    }
+
+    rootLogger.debug(`Processing ${transfers.length} Transfer events`)
+    const callbacks = transfers
+      .map(transfer => async () => {
+        const { from, value } = transfer.returnValues
+
+        const logger = rootLogger.child({
+          eventTransactionHash: transfer.transactionHash
+        })
+
+        logger.info({ from, value }, `Processing transfer ${transfer.transactionHash}`)
+
+        const block = await web3Foreign.eth.getBlock('latest')
+        const tokenSwapAllowed = await foreignBridge.methods.isTokenSwapAllowed(block.timestamp)
+
+        if (!tokenSwapAllowed) {
+          logger.info(
+            `Transfer event discarded because SCD Emergency Shutdown has happened ${transfer.transactionHash}`
+          )
+          return
+        }
+
+        const receipt = await web3Foreign.eth.getTransactionReceipt(transfer.transactionHash)
+
+        const existsAffirmationEvent = receipt.logs.some(
+          e => e.address === config.foreignBridgeAddress && e.topics[0] === userRequestForAffirmationHash
+        )
+
+        if (existsAffirmationEvent) {
+          logger.info(
+            `Transfer event discarded because a transaction with alternative receiver detected in transaction ${
+              transfer.transactionHash
+            }`
+          )
+          return
+        }
+
+        const existsTokensSwappedEvent = tokensSwappedAbi
+          ? receipt.logs.some(e => e.address === config.foreignBridgeAddress && e.topics[0] === tokensSwappedHash)
+          : false
+
+        if (from === ZERO_ADDRESS && existsTokensSwappedEvent) {
+          logger.info(
+            `Transfer event discarded because token swap is detected in transaction ${transfer.transactionHash}`
+          )
+          return
+        }
+
+        let gasEstimate
+        try {
+          logger.debug('Estimate gas')
+          gasEstimate = await estimateGas({
+            web3: web3Home,
+            homeBridge,
+            validatorContract,
+            recipient: from,
+            value,
+            txHash: transfer.transactionHash,
+            address: config.validatorAddress
+          })
+          logger.debug({ gasEstimate }, 'Gas estimated')
+        } catch (e) {
+          if (e instanceof HttpListProviderError) {
+            throw new Error('RPC Connection Error: submitSignature Gas Estimate cannot be obtained.')
+          } else if (e instanceof InvalidValidatorError) {
+            logger.fatal({ address: config.validatorAddress }, 'Invalid validator')
+            process.exit(EXIT_CODES.INCOMPATIBILITY)
+          } else if (e instanceof AlreadySignedError) {
+            logger.info(`Already signed transfer ${transfer.transactionHash}`)
+            return
+          } else if (e instanceof AlreadyProcessedError) {
+            logger.info(`transfer ${transfer.transactionHash} was already processed by other validators`)
+            return
+          } else {
+            logger.error(e, 'Unknown error while processing transaction')
+            throw e
+          }
+        }
+
+        const data = await homeBridge.methods
+          .executeAffirmation(from, value, transfer.transactionHash)
+          .encodeABI({ from: config.validatorAddress })
+
+        txToSend.push({
+          data,
+          gasEstimate,
+          transactionReference: transfer.transactionHash,
+          to: config.homeBridgeAddress
+        })
+      })
+      .map(promise => limit(promise))
+
+    await Promise.all(callbacks)
+    return txToSend
+  }
+}
+
+module.exports = processTransfersBuilder

oracle/src/watcher.js

@@ -101,6 +101,7 @@ function processEvents(events) {
       return processAffirmationRequests(events)
     case 'erc-erc-transfer':
     case 'erc-native-transfer':
+    case 'erc-native-half-duplex-transfer':
       return processTransfers(events)
     case 'amb-signature-request':
       return processAMBSignatureRequests(events)