Add support for fetching contracts from blockscout instances

apps/remix-ide-e2e/src/tests/url.test.ts

@@ -107,6 +107,46 @@ module.exports = {
       })
   },
 
+  'Should load Blockscout verified contracts from URL "address" and "blockscout" params (single source)': function (browser: NightwatchBrowser) {
+    browser
+      .url('http://127.0.0.1:8080/#address=0xdAC17F958D2ee523a2206206994597C13D831ec7&blockscout=eth.blockscout.com')
+      .refreshPage()
+      .pause(7000)
+      .currentWorkspaceIs('code-sample')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0xdAC17F958D2ee523a2206206994597C13D831ec7"]')
+      .getEditorValue((content) => {
+        browser.assert.ok(content && content.indexOf(
+          'contract TetherToken is Pausable, StandardToken, BlackList {') !== -1)
+
+      })
+  },
+
+  'Should load Blockscout verified contracts from URL "address" and "blockscout" params (multiple sources)': function (browser: NightwatchBrowser) {
+    browser
+      .url('http://127.0.0.1:8080/#address=0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9&blockscout=eth.blockscout.com')
+      .refreshPage()
+      .pause(7000)
+      .currentWorkspaceIs('code-sample')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/Address.sol"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/BaseAdminUpgradeabilityProxy.sol"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/BaseUpgradeabilityProxy.sol"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/InitializableAdminUpgradeabilityProxy.sol"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/InitializableUpgradeabilityProxy.sol"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/Proxy.sol"]')
+      .assert.elementPresent('*[data-id="treeViewLitreeViewItemeth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/UpgradeabilityProxy.sol"]')
+      .openFile('eth.blockscout.com/0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9/contracts/open-zeppelin/InitializableAdminUpgradeabilityProxy.sol')
+      .getEditorValue((content) => {
+        browser.assert.ok(content && content.indexOf(
+          'contract InitializableAdminUpgradeabilityProxy is BaseAdminUpgradeabilityProxy, InitializableUpgradeabilityProxy {') !== -1)
+      })
+
+  },
+
   'Should load the code from URL & code params #group1': function (browser: NightwatchBrowser) {
     browser
       .url('http://127.0.0.1:8080/#optimize=true&runs=300&url=https://github.com/ethereum/remix-project/blob/master/apps/remix-ide/contracts/app/solidity/mode.sol&code=cHJhZ21hIHNvbGlkaXR5ID49MC42LjAgPDAuNy4wOwoKaW1wb3J0ICJodHRwczovL2dpdGh1Yi5jb20vT3BlblplcHBlbGluL29wZW56ZXBwZWxpbi1jb250cmFjdHMvYmxvYi9tYXN0ZXIvY29udHJhY3RzL2FjY2Vzcy9Pd25hYmxlLnNvbCI7Cgpjb250cmFjdCBHZXRQYWlkIGlzIE93bmFibGUgewogIGZ1bmN0aW9uIHdpdGhkcmF3KCkgZXh0ZXJuYWwgb25seU93bmVyIHsKICB9Cn0')

libs/remix-core-plugin/src/index.ts

@@ -8,3 +8,4 @@ export * from './types/contract'
 export { LinkLibraries, DeployLibraries } from './lib/link-libraries'
 export { OpenZeppelinProxy } from './lib/openzeppelin-proxy'
 export { fetchContractFromEtherscan } from './lib/helpers/fetch-etherscan'
+export { fetchContractFromBlockscout } from './lib/helpers/fetch-blockscout'

libs/remix-core-plugin/src/lib/helpers/fetch-blockscout.ts

@@ -0,0 +1,67 @@
+export const fetchContractFromBlockscout = async (plugin, endpoint, contractAddress, targetPath, shouldSetFile = true) => {
+  let data
+  const compilationTargets = {}
+
+  try {
+    data = await fetch('https://' + endpoint + '/api?module=contract&action=getsourcecode&address=' + contractAddress)
+    data = await data.json()
+    console.log(data)
+    // blockscout api doc https://blockscout.com/poa/core/api-docs
+    if (data.message === 'OK' && data.status === "1") {
+      if (data.result.length) {
+        if (!data.result[0].SourceCode || data.result[0].SourceCode === '') {
+          throw new Error(`contract not verified on Blockscout ${endpoint} network`)
+        }
+      }
+    } else throw new Error('unable to retrieve contract data ' + data.message)
+  } catch (e) {
+    throw new Error('unable to retrieve contract data: ' + e.message)
+  }
+
+  if (!data || !data.result) {
+    return null
+  }
+
+  if (data.result[0].FileName === '') {
+    const fileName = `${targetPath}/${data.result[0].ContractName}.sol`
+    if (shouldSetFile) await plugin.call('fileManager', 'setFile', fileName, data.result[0].SourceCode)
+    compilationTargets[fileName] = { content: data.result[0].SourceCode }
+  } else {
+    const sources = {}
+    sources[data.result[0].FileName] = data.result[0].SourceCode
+    if (data.result[0].AdditionalSources && Array.isArray(data.result[0].AdditionalSources)) {
+      for (const object of data.result[0].AdditionalSources) {
+        sources[object.Filename] = object.SourceCode
+      }
+    }
+
+    for (let [file, source] of Object.entries(sources)) { // eslint-disable-line
+      file = file.replace('browser/', '') // should be fixed in the remix IDE end.
+      file = file.replace(/^\//g, '') // remove first slash.
+      if (await plugin.call('contentImport', 'isExternalUrl', file)) {
+        // nothing to do, the compiler callback will handle those
+      } else {
+        const path = `${targetPath}/${file}`
+        const content = source
+        if (shouldSetFile) await plugin.call('fileManager', 'setFile', path, content)
+        compilationTargets[path] = { content }
+      }
+    }
+  }
+
+  let runs = 0
+  try {
+    runs = parseInt(data.result[0].OptimizationRuns)
+  } catch (e) { }
+  const settings = {
+    version: data.result[0].CompilerVersion.replace(/^v/, ''),
+    language: 'Solidity',
+    evmVersion: data.result[0].EVMVersion.toLowerCase(),
+    optimize: data.result[0].OptimizationUsed === 'true',
+    runs
+  }
+  return {
+    settings,
+    compilationTargets
+  }
+}

libs/remix-ui/workspace/src/lib/actions/index.ts

@@ -6,7 +6,7 @@ import { displayNotification, displayPopUp, fetchDirectoryError, fetchDirectoryR
 import { listenOnPluginEvents, listenOnProviderEvents } from './events'
 import { createWorkspaceTemplate, getWorkspaces, loadWorkspacePreset, setPlugin, workspaceExists } from './workspace'
 import { QueryParams } from '@remix-project/remix-lib'
-import { fetchContractFromEtherscan } from '@remix-project/core-plugin' // eslint-disable-line
+import { fetchContractFromEtherscan, fetchContractFromBlockscout } from '@remix-project/core-plugin' // eslint-disable-line
 import JSZip from 'jszip'
 import isElectron  from 'is-electron'
 import { Actions, FileTree } from '../types'
@@ -23,7 +23,8 @@ export type UrlParametersType = {
   gist: string,
   code: string,
   url: string,
-  address: string
+  address: string,
+  blockscout: string
 }
 
 const basicWorkspaceInit = async (workspaces: { name: string; isGitRepo: boolean; }[], workspaceProvider) => {
@@ -65,6 +66,33 @@ export const initWorkspace = (filePanelPlugin) => async (reducerDispatch: React.
       dispatch(setCurrentWorkspace({ name: 'code-sample', isGitRepo: false }))
       const filePath = await loadWorkspacePreset('code-template')
       plugin.on('editor', 'editorMounted', async () => await plugin.fileManager.openFile(filePath))
+    } else if (params.address && params.blockscout) {
+      if (params.address.startsWith('0x') && params.address.length === 42 && params.blockscout.length > 0) {
+        const contractAddress = params.address
+        const blockscoutUrl = params.blockscout
+        plugin.call('notification', 'toast', `Looking for contract verified on ${blockscoutUrl} for contract address ${contractAddress} .....`)
+        let data
+        let count = 0
+        try {
+          const workspaceName = 'code-sample'
+          let filePath
+          const target = `/${blockscoutUrl}/${contractAddress}`
+
+          data = await fetchContractFromBlockscout(plugin, blockscoutUrl, contractAddress, target, false)
+          if (await workspaceExists(workspaceName)) workspaceProvider.setWorkspace(workspaceName)
+          else await createWorkspaceTemplate(workspaceName, 'code-template')
+          plugin.setWorkspace({ name: workspaceName, isLocalhost: false })
+          dispatch(setCurrentWorkspace({ name: workspaceName, isGitRepo: false }))
+          count = count + (Object.keys(data.compilationTargets)).length
+          for (filePath in data.compilationTargets)
+            await workspaceProvider.set(filePath, data.compilationTargets[filePath]['content'])
+
+          plugin.on('editor', 'editorMounted', async () => await plugin.fileManager.openFile(filePath))
+          plugin.call('notification', 'toast', `Added ${count} verified contract${count === 1 ? '': 's'} from ${blockscoutUrl} network for contract address ${contractAddress} !!`)
+        } catch (error) {
+          await basicWorkspaceInit(workspaces, workspaceProvider)
+        }
+      } else await basicWorkspaceInit(workspaces, workspaceProvider)
     } else if (params.address) {
       if (params.address.startsWith('0x') && params.address.length === 42) {
         const contractAddress = params.address