Merge the develop branch to the master branch, preparation to v3.0.0-rc1

This merge contains the following set of changes:
  * [Monitor, Improvement] Add statistics about used AMB information requests (#577)
  * [ALM, Improvement] Add safe-execute button in ALM (#580), closes #573, closes #551
  * [Oracle, Improvement] Improve confirm-relay feature (#582), closes #569
  * [Monitor, Fix] Prune print of long error messages about missing file (#579), closes #578
  * [Oracle, Fix] Use safe approach for eth_getLogs requests (#581)
  * [Oracle, Fix] Fix logging in gas price service (#583), closes #552
  * [Oracle, Fix] Fix oracle error patterns and oracle e2e tests (#585)
  * [Common, Other] Fix dependencies versions and update example.yml (#566)
  * [Common, Other] Upload services logs in e2e and ultimate tests (#568)
  * [Oracle, Other] added example of emergency shutdown controller contract (#572)
  * [Oracle, Other] Refactor oracle configuration (#584)

Author: akolotov

.github/workflows/main.yml

@@ -149,6 +149,12 @@ jobs:
         run: docker login ${DOCKER_REGISTRY} -u ${{ github.actor }} -p ${{ github.token }}
       - name: yarn run ${{ matrix.task }}
         run: ${{ !matrix.use-cache || steps.cache-repo.outputs.cache-hit }} && yarn run ${{ matrix.task }}
+      - name: Upload logs
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: logs-${{ matrix.task }}
+          path: e2e-commons/logs
   deployment:
     runs-on: ubuntu-latest
     needs:
@@ -199,7 +205,7 @@ jobs:
       - name: Login to docker registry
         run: docker login ${DOCKER_REGISTRY} -u ${{ github.actor }} -p ${{ github.token }}
       - name: Deploy contracts
-        run: ${{ steps.cache-repo.outputs.cache-hit }} && e2e-commons/up.sh deploy blocks
+        run: ${{ steps.cache-repo.outputs.cache-hit }} && e2e-commons/up.sh deploy generate-amb-tx blocks
       - name: Pull e2e oracle image
         run: |
          docker-compose -f ./e2e-commons/docker-compose.yml pull oracle-amb
@@ -210,3 +216,12 @@ jobs:
         run: sudo chown -R $USER:docker /var/run/docker.sock
       - name: Run oracle e2e tests
         run: docker-compose -f ./e2e-commons/docker-compose.yml run -e ULTIMATE=true e2e yarn workspace oracle-e2e run ${{ matrix.task }}
+      - name: Save logs
+        if: always()
+        run: e2e-commons/down.sh
+      - name: Upload logs
+        if: always()
+        uses: actions/upload-artifact@v2
+        with:
+          name: logs-ultimate-${{ matrix.task }}
+          path: e2e-commons/logs

alm-e2e/run-tests.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 cd $(dirname $0)
 
-../e2e-commons/up.sh deploy blocks alm alm-e2e
+../e2e-commons/up.sh deploy generate-amb-tx blocks alm alm-e2e
 
 # run oracle amb e2e tests to generate transactions for alm
 docker-compose -f ../e2e-commons/docker-compose.yml run e2e yarn workspace oracle-e2e run alm

alm-e2e/src/test.js

@@ -6,8 +6,8 @@ jest.setTimeout(60000)
 const statusText = 'Success'
 const statusSelector = 'label[data-id="status"]'
 
-const homeToForeignTxURL = 'http://localhost:3004/77/0xbc83d43bdc675a615a2b820e43e52d25857aa5fdd77acf2dd92cd247af2c693c'
-const foreignToHomeTxURL = 'http://localhost:3004/42/0x09dfb947dbd17e27bcc117773b6e133829f7cef9646199a93ef019c4f7c0fec6'
+const homeToForeignTxURL = 'http://localhost:3004/77/0x295efbe6ae98937ef35d939376c9bd752b4dc6f6899a9d5ddd6a57cea3d76c89'
+const foreignToHomeTxURL = 'http://localhost:3004/42/0x7262f7dbe6c30599edded2137fbbe93c271b37f5c54dd27f713f0cf510e3b4dd'
 
 describe('ALM', () => {
   let browser

alm/src/abis/ForeignAMB.ts

@@ -123,6 +123,24 @@ const abi: AbiItem[] = [
     stateMutability: 'nonpayable',
     type: 'function'
   },
+  {
+    constant: false,
+    inputs: [
+      {
+        name: '_data',
+        type: 'bytes'
+      },
+      {
+        name: '_signatures',
+        type: 'bytes'
+      }
+    ],
+    name: 'safeExecuteSignaturesWithAutoGasLimit',
+    outputs: [],
+    payable: false,
+    stateMutability: 'nonpayable',
+    type: 'function'
+  },
   {
     constant: true,
     inputs: [

alm/src/components/ExecutionConfirmation.tsx

@@ -1,4 +1,4 @@
-import React from 'react'
+import React, { useEffect, useState } from 'react'
 import { formatTimestamp, formatTxHash, getExplorerTxUrl } from '../utils/networks'
 import { useWindowWidth } from '@react-hook/window-size'
 import { SEARCHING_TX, VALIDATOR_CONFIRMATION_STATUS, ALM_HOME_TO_FOREIGN_MANUAL_EXECUTION } from '../config/constants'
@@ -9,6 +9,7 @@ import { GreyLabel, RedLabel, SuccessLabel } from './commons/Labels'
 import { ExplorerTxLink } from './commons/ExplorerTxLink'
 import { Thead, AgeTd, StatusTd } from './commons/Table'
 import { ManualExecutionButton } from './ManualExecutionButton'
+import { useStateProvider } from '../state/StateProvider'
 
 const StyledExecutionConfirmation = styled.div`
   margin-top: 30px;
@@ -33,6 +34,8 @@ export const ExecutionConfirmation = ({
   executionEventsFetched,
   setPendingExecution
 }: ExecutionConfirmationParams) => {
+  const { foreign } = useStateProvider()
+  const [safeExecutionAvailable, setSafeExecutionAvailable] = useState(false)
   const availableManualExecution =
     !isHome &&
     (executionData.status === VALIDATOR_CONFIRMATION_STATUS.WAITING ||
@@ -48,6 +51,22 @@ export const ExecutionConfirmation = ({
   const formattedValidator =
     windowWidth < 850 && executionData.validator ? formatTxHash(executionData.validator) : executionData.validator
 
+  useEffect(
+    () => {
+      if (!availableManualExecution || !foreign.bridgeContract) return
+
+      const p = foreign.bridgeContract.methods.getBridgeInterfacesVersion().call()
+      p.then(({ major, minor }: any) => {
+        major = parseInt(major, 10)
+        minor = parseInt(minor, 10)
+        if (major < 5 || (major === 5 && minor < 7)) return
+
+        setSafeExecutionAvailable(true)
+      })
+    },
+    [availableManualExecution, foreign.bridgeContract]
+  )
+
   const getExecutionStatusElement = (validatorStatus = '') => {
     switch (validatorStatus) {
       case VALIDATOR_CONFIRMATION_STATUS.SUCCESS:
@@ -105,6 +124,7 @@ export const ExecutionConfirmation = ({
             {availableManualExecution && (
               <td>
                 <ManualExecutionButton
+                  safeExecutionAvailable={safeExecutionAvailable}
                   messageData={messageData}
                   setExecutionData={setExecutionData}
                   signatureCollected={signatureCollected as string[]}

alm/src/components/ManualExecutionButton.tsx

@@ -15,23 +15,27 @@ import { signatureToVRS, packSignatures } from '../utils/signatures'
 import { getSuccessExecutionData } from '../utils/getFinalizationEvent'
 import { TransactionReceipt } from 'web3-eth'
 
-const StyledButton = styled.button`
+const ActionButton = styled.button`
   color: var(--button-color);
   border-color: var(--font-color);
   margin-top: 10px;
+  min-width: 120px;
+  padding: 1rem;
   &:focus {
     outline: var(--button-color);
   }
 `
 
 interface ManualExecutionButtonParams {
+  safeExecutionAvailable: boolean
   messageData: string
   setExecutionData: Function
   signatureCollected: string[]
   setPendingExecution: Function
 }
 
 export const ManualExecutionButton = ({
+  safeExecutionAvailable,
   messageData,
   setExecutionData,
   signatureCollected,
@@ -40,6 +44,7 @@ export const ManualExecutionButton = ({
   const { foreign, setError } = useStateProvider()
   const { library, activate, account, active } = useWeb3React()
   const [manualExecution, setManualExecution] = useState(false)
+  const [allowFailures, setAllowFailures] = useState(false)
 
   useEffect(
     () => {
@@ -72,7 +77,11 @@ export const ManualExecutionButton = ({
       const signatures = packSignatures(signatureCollected.map(signatureToVRS))
       const messageId = messageData.slice(0, 66)
       const bridge = foreign.bridgeContract
-      const data = bridge.methods.executeSignatures(messageData, signatures).encodeABI()
+      const executeMethod =
+        safeExecutionAvailable && !allowFailures
+          ? bridge.methods.safeExecuteSignaturesWithAutoGasLimit
+          : bridge.methods.executeSignatures
+      const data = executeMethod(messageData, signatures).encodeABI()
       setManualExecution(false)
 
       library.eth
@@ -132,15 +141,35 @@ export const ManualExecutionButton = ({
       messageData,
       signatureCollected,
       setExecutionData,
-      setPendingExecution
+      setPendingExecution,
+      safeExecutionAvailable,
+      allowFailures
     ]
   )
 
   return (
-    <div className="is-center">
-      <StyledButton className="button outline" onClick={() => setManualExecution(true)}>
-        Execute
-      </StyledButton>
+    <div>
+      <div className="is-center">
+        <ActionButton className="button outline" onClick={() => setManualExecution(true)}>
+          Execute
+        </ActionButton>
+      </div>
+      {safeExecutionAvailable && (
+        <div
+          title="Allow executed message to fail and record its failure on-chain without reverting the whole transaction.
+          Use fixed gas limit for execution."
+          className="is-center"
+          style={{ paddingTop: 10 }}
+        >
+          <input
+            type="checkbox"
+            id="allow-failures"
+            checked={allowFailures}
+            onChange={e => setAllowFailures(e.target.checked)}
+          />
+          <label htmlFor="allow-failures">Unsafe mode</label>
+        </div>
+      )}
     </div>
   )
 }

commons/message.js

@@ -1,3 +1,5 @@
+const { soliditySha3 } = require('web3-utils')
+
 function strip0x(input) {
   return input.replace(/^0x/, '')
 }
@@ -39,8 +41,35 @@ const normalizeAMBMessageEvent = e => {
   return parseAMBMessage(msgData)
 }
 
+const ambInformationSignatures = [
+  'eth_call(address,bytes)',
+  'eth_call(address,bytes,uint256)',
+  'eth_call(address,address,uint256,bytes)',
+  'eth_blockNumber()',
+  'eth_getBlockByNumber()',
+  'eth_getBlockByNumber(uint256)',
+  'eth_getBlockByHash(bytes32)',
+  'eth_getBalance(address)',
+  'eth_getBalance(address,uint256)',
+  'eth_getTransactionCount(address)',
+  'eth_getTransactionCount(address,uint256)',
+  'eth_getTransactionByHash(bytes32)',
+  'eth_getTransactionReceipt(bytes32)',
+  'eth_getStorageAt(address,bytes32)',
+  'eth_getStorageAt(address,bytes32,uint256)'
+]
+const ambInformationSelectors = Object.fromEntries(ambInformationSignatures.map(sig => [soliditySha3(sig), sig]))
+const normalizeAMBInfoRequest = e => ({
+  messageId: e.returnValues.messageId,
+  sender: e.returnValues.sender,
+  requestSelector: ambInformationSelectors[e.returnValues.requestSelector] || 'unknown',
+  data: e.returnValues.data
+})
+
 module.exports = {
   strip0x,
   parseAMBMessage,
-  normalizeAMBMessageEvent
+  normalizeAMBMessageEvent,
+  ambInformationSignatures,
+  normalizeAMBInfoRequest
 }

commons/package.json

@@ -9,7 +9,8 @@
   },
   "dependencies": {
     "gas-price-oracle": "^0.1.5",
-    "web3-utils": "^1.3.0"
+    "web3-utils": "^1.3.0",
+    "node-fetch": "^2.1.2"
   },
   "devDependencies": {
     "bn-chai": "^1.0.1",

commons/utils.js

@@ -1,5 +1,6 @@
 const { toWei, toBN, BN } = require('web3-utils')
 const { GasPriceOracle } = require('gas-price-oracle')
+const fetch = require('node-fetch')
 const { BRIDGE_MODES } = require('./constants')
 const { REWARDABLE_VALIDATORS_ABI } = require('./abis')
 
@@ -178,17 +179,16 @@ const normalizeGasPrice = (oracleGasPrice, factor, limits = null) => {
   return toBN(toWei(gasPrice.toFixed(2).toString(), 'gwei'))
 }
 
-// fetchFn has to be supplied (instead of just url to oracle),
-// because this utility function is shared between Browser and Node,
-// we use built-in 'fetch' on browser side, and `node-fetch` package in Node.
-const gasPriceFromSupplier = async (fetchFn, options = {}) => {
+const gasPriceFromSupplier = async (url, options = {}) => {
   try {
     let json
-    if (fetchFn) {
-      const response = await fetchFn()
+    if (url === 'gas-price-oracle') {
+      json = await gasPriceOracle.fetchGasPricesOffChain()
+    } else if (url) {
+      const response = await fetch(url, { timeout: 2000 })
       json = await response.json()
     } else {
-      json = await gasPriceOracle.fetchGasPricesOffChain()
+      return null
     }
     const oracleGasPrice = json[options.speedType]
 

deployment-e2e/molecule/multiple/molecule.yml

@@ -34,7 +34,7 @@ provisioner:
   inventory:
     host_vars:
       multiple-host:
-        ORACLE_VALIDATOR_ADDRESS_PRIVATE_KEY: "8e829f695aed89a154550f30262f1529582cc49dc30eff74a6b491359e0230f9"
+        ORACLE_VALIDATOR_ADDRESS_PRIVATE_KEY: "6c48435bd464a53ed66ed62127c4dba8af75cf1a99a8ebe2680599948fbfbc6d"
         MONITOR_PORT: 3003
         syslog_server_port: "udp://127.0.0.1:514"
 verifier: