Merge pull request #4529 from ethereum/vm-state

Save VM State and Blocks

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

@@ -82,21 +82,21 @@ module.exports = {
         instanceAddress = address
         console.log('instanceAddress', instanceAddress)
         browser
-        .waitForElementVisible(`#instance${instanceAddress} [data-id="instanceContractBal"]`)
+          .waitForElementVisible(`#instance${instanceAddress} [data-id="instanceContractBal"]`)
         //*[@id="instance0xbBF289D846208c16EDc8474705C748aff07732dB" and contains(.,"Balance") and contains(.,'0.000000000000000111')]
-        .waitForElementVisible({
-          locateStrategy: 'xpath',
-          selector: `//*[@id="instance${instanceAddress}" and contains(.,"Balance") and contains(.,'0.000000000000000111')]`,
-          timeout: 60000
-        })
+          .waitForElementVisible({
+            locateStrategy: 'xpath',
+            selector: `//*[@id="instance${instanceAddress}" and contains(.,"Balance") and contains(.,'0.000000000000000111')]`,
+            timeout: 60000
+          })
         //.waitForElementContainsText(`#instance${instanceAddress} [data-id="instanceContractBal"]`, 'Balance: 0.000000000000000111 ETH', 60000)
-        .clickFunction('sendSomeEther - transact (not payable)', { types: 'uint256 num', values: '2' })
-        .pause(1000)
-        .waitForElementVisible({
-          locateStrategy: 'xpath',
-          selector: `//*[@id="instance${instanceAddress}" and contains(.,"Balance") and contains(.,'0.000000000000000109')]`,
-          timeout: 60000
-        })
+          .clickFunction('sendSomeEther - transact (not payable)', { types: 'uint256 num', values: '2' })
+          .pause(1000)
+          .waitForElementVisible({
+            locateStrategy: 'xpath',
+            selector: `//*[@id="instance${instanceAddress}" and contains(.,"Balance") and contains(.,'0.000000000000000109')]`,
+            timeout: 60000
+          })
       })
   },
 
@@ -238,6 +238,95 @@ module.exports = {
       .executeScriptInTerminal('web3.eth.getAccounts()')
       .journalLastChildIncludes('[ "0x76a3ABb5a12dcd603B52Ed22195dED17ee82708f" ]')
       .end()
+  },
+
+  'Should ensure that save environment state is checked by default #group4 #group5': function (browser: NightwatchBrowser) {
+    browser.waitForElementPresent('*[data-id="remixIdeSidePanel"]')
+      .clickLaunchIcon('settings')
+      .waitForElementPresent('[data-id="settingsEnableSaveEnvStateLabel"]')
+      .scrollInto('[data-id="settingsEnableSaveEnvStateLabel"]')
+      .verify.elementPresent('[data-id="settingsEnableSaveEnvState"]:checked')
+  },
+
+  'Should deploy default storage contract; store value and ensure that state is saved. #group4 #group5': function (browser: NightwatchBrowser) {
+    browser
+      .clickLaunchIcon('filePanel')
+      .click('*[data-id="treeViewLitreeViewItemcontracts"]')
+      .openFile('contracts/1_Storage.sol')
+      .pause(5000)
+      .clickLaunchIcon('udapp')
+      .waitForElementPresent('*[data-id="Deploy - transact (not payable)"]')
+      .click('*[data-id="Deploy - transact (not payable)"]')
+      .waitForElementPresent('#instance0xd9145CCE52D386f254917e481eB44e9943F39138')
+      .clickInstance(0)
+      .clickFunction('store - transact (not payable)', { types: 'uint256 num', values: '10' })
+      .clickFunction('retrieve - call')
+      .waitForElementContainsText('[data-id="treeViewLi0"]', 'uint256: 10')
+      .clickLaunchIcon('filePanel')
+      .openFile('.states/vm-shanghai/state.json')
+      .getEditorValue((content) => {
+        browser
+          .assert.ok(content.includes('"latestBlockNumber": "0x02"'), 'State is saved')
+      })
+  },
+
+  'Should load state after page refresh #group4': function (browser: NightwatchBrowser) {
+    browser.refreshPage()
+      .waitForElementVisible('*[data-id="remixIdeSidePanel"]')
+      .click('*[data-id="treeViewLitreeViewItemcontracts"]')
+      .openFile('contracts/1_Storage.sol')
+      .addAtAddressInstance('0xd9145CCE52D386f254917e481eB44e9943F39138', true, true, false)
+      .clickInstance(0)
+      .clickFunction('retrieve - call')
+      .waitForElementContainsText('[data-id="treeViewLi0"]', 'uint256: 10')
+  },
+
+  'Should save state after running web3 script #group4': function (browser: NightwatchBrowser) {
+    browser
+      .clickLaunchIcon('settings')
+      .waitForElementPresent('[data-id="settingsTabGenerateContractMetadataLabel"]')
+      .click('[data-id="settingsTabGenerateContractMetadataLabel"]')
+      .verify.elementPresent('[data-id="settingsTabGenerateContractMetadata"]:checked')
+      .clickLaunchIcon('solidity')
+      .click('.remixui_compilerConfigSection')
+      .setValue('#evmVersionSelector', 'london')
+      .click('*[data-id="compilerContainerCompileBtn"]')
+      .pause(5000)
+      .clickLaunchIcon('udapp')
+      .switchEnvironment('vm-london')
+      .clickLaunchIcon('filePanel')
+      .click('*[data-id="treeViewLitreeViewItemscripts"]')
+      .openFile('scripts/deploy_with_web3.ts')
+      .click('[data-id="play-editor"]')
+      .waitForElementPresent('[data-id="treeViewDivDraggableItem.states/vm-london/state.json"]')
+      .click('[data-id="treeViewDivDraggableItem.states/vm-london/state.json"]')
+      .pause(100000)
+      .getEditorValue((content) => {
+        browser
+          .assert.ok(content.includes('"latestBlockNumber": "0x01"'), 'State is saved')
+      })
+  },
+
+  'Should ensure that .states is not updated when save env option is unchecked #group5': function (browser: NightwatchBrowser) {
+    browser
+      .clickLaunchIcon('settings')
+      .waitForElementPresent('[data-id="settingsEnableSaveEnvStateLabel"]')
+      .click('[data-id="settingsEnableSaveEnvStateLabel"]')
+      .verify.elementNotPresent('[data-id="settingsEnableSaveEnvState"]:checked')
+      .clickLaunchIcon('filePanel')
+      .openFile('contracts/1_Storage.sol')
+      .pause(5000)
+      .clickLaunchIcon('udapp')
+      .waitForElementPresent('*[data-id="Deploy - transact (not payable)"]')
+      .click('*[data-id="Deploy - transact (not payable)"]')
+      .pause(5000)
+      .clickLaunchIcon('filePanel')
+      .openFile('.states/vm-shanghai/state.json')
+      .getEditorValue((content) => {
+        browser
+          .assert.ok(content.includes('"latestBlockNumber": "0x02"'), 'State is unchanged')
+      })
+      .end()
   }
 }
 

apps/remix-ide/src/app/tabs/locales/en/settings.json

@@ -43,5 +43,6 @@
   "settings.copilot": "Solidity copilot - Alpha",
   "settings.copilot.activate": "Load & Activate copilot",
   "settings.copilot.max_new_tokens": "Maximum number of words to generate",
-  "settings.copilot.temperature": "Temperature"
+  "settings.copilot.temperature": "Temperature",
+  "settings.enableSaveEnvState": "Save environment state"
 }

apps/remix-ide/src/app/tabs/locales/es/settings.json

@@ -36,5 +36,6 @@
   "settings.port": "PUERTO",
   "settings.projectID": "ID DEL PROYECTO",
   "settings.projectSecret": "SECRETO DE PROYECTO",
-  "settings.analyticsInRemix": "Analíticas en IDE Remix"
+  "settings.analyticsInRemix": "Analíticas en IDE Remix",
+  "settings.enableSaveEnvState": "Save environment state"
 }

apps/remix-ide/src/app/tabs/locales/fr/settings.json

@@ -36,5 +36,6 @@
   "settings.port": "PORT",
   "settings.projectID": "ID du projet",
   "settings.projectSecret": "SECRET DU PROJET",
-  "settings.analyticsInRemix": "Analytics dans l'IDE de Remix"
+  "settings.analyticsInRemix": "Analytics dans l'IDE de Remix",
+  "settings.enableSaveEnvState": "Save environment state"
 }

apps/remix-ide/src/app/tabs/locales/it/settings.json

@@ -36,5 +36,6 @@
   "settings.port": "PORTA",
   "settings.projectID": "ID PROGETTO",
   "settings.projectSecret": "SEGRETO DEL PROGETTO",
-  "settings.analyticsInRemix": "Analytics nella Remix IDE"
+  "settings.analyticsInRemix": "Analytics nella Remix IDE",
+  "settings.enableSaveEnvState": "Save environment state"
 }

apps/remix-ide/src/app/tabs/locales/zh/settings.json

@@ -36,5 +36,6 @@
   "settings.port": "端口",
   "settings.projectID": "项目 ID",
   "settings.projectSecret": "项目密钥",
-  "settings.analyticsInRemix": "Remix IDE 中的分析功能"
+  "settings.analyticsInRemix": "Remix IDE 中的分析功能",
+  "settings.enableSaveEnvState": "Save environment state"
 }

apps/remix-ide/src/app/tabs/web3-provider.js

@@ -63,6 +63,13 @@ export class Web3ProviderModule extends Plugin {
                       await this.call('compilerArtefacts', 'addResolvedContract', contractAddressStr, data)
                     }
                   }, 50)
+                  const isVM = this.blockchain.executionContext.isVM()
+
+                  if (isVM && this.blockchain.config.get('settings/save-evm-state')) {
+                    await this.blockchain.executionContext.getStateDetails().then((state) => {
+                      this.call('fileManager', 'writeFile', `.states/${this.blockchain.executionContext.getProvider()}/state.json`, state)
+                    })
+                  }
                 }
               }
               resolve(message)

apps/remix-ide/src/blockchain/blockchain.tsx

@@ -135,7 +135,8 @@ export class Blockchain extends Plugin {
 
   setupEvents() {
     this.executionContext.event.register('contextChanged', async (context) => {
-      await this.resetEnvironment()
+      // reset environment to last known state of the context
+      await this.loadContext(context)
       this._triggerEvent('contextChanged', [context])
       this.detectNetwork((error, network) => {
         this.networkStatus = {network, error}
@@ -643,8 +644,23 @@ export class Blockchain extends Plugin {
     })
   }
 
-  async resetEnvironment() {
-    await this.getCurrentProvider().resetEnvironment()
+  async loadContext(context: string) {
+    const saveEvmState = this.config.get('settings/save-evm-state')
+
+    if (saveEvmState) {
+      const contextExists = await this.call('fileManager', 'exists', `.states/${context}/state.json`)
+
+      if (contextExists) {
+        const stateDb = await this.call('fileManager', 'readFile', `.states/${context}/state.json`)
+
+        await this.getCurrentProvider().resetEnvironment(stateDb)
+      } else {
+        await this.getCurrentProvider().resetEnvironment()
+      }
+    } else {
+      await this.getCurrentProvider().resetEnvironment()
+    }
+
     // TODO: most params here can be refactored away in txRunner
     const web3Runner = new TxRunnerWeb3(
       {
@@ -677,7 +693,7 @@ export class Blockchain extends Plugin {
               view on etherscan
             </a>
           )
-        }
+        } 
       })
     })
     this.txRunner = new TxRunner(web3Runner, {})
@@ -889,8 +905,13 @@ export class Blockchain extends Plugin {
       let execResult
       let returnValue = null
       if (isVM) {
-        const hhlogs = await this.web3().remix.getHHLogsForTx(txResult.transactionHash)
+        if (!tx.useCall && this.config.get('settings/save-evm-state')) {
+          await this.executionContext.getStateDetails().then((state) => {
+            this.call('fileManager', 'writeFile', `.states/${this.executionContext.getProvider()}/state.json`, state)
+          })
+        }
 
+        const hhlogs = await this.web3().remix.getHHLogsForTx(txResult.transactionHash)
         if (hhlogs && hhlogs.length) {
           const finalLogs = (
             <div>

apps/remix-ide/src/blockchain/execution-context.js

@@ -3,6 +3,7 @@
 import Web3 from 'web3'
 import { execution } from '@remix-project/remix-lib'
 import EventManager from '../lib/events'
+import {bufferToHex} from '@ethereumjs/util'
 const _paq = window._paq = window._paq || []
 
 let web3
@@ -71,35 +72,44 @@ export class ExecutionContext {
   }
 
   detectNetwork (callback) {
-    if (this.isVM()) {
-      callback(null, { id: '-', name: 'VM' })
-    } else {
-      if (!web3.currentProvider) {
-        return callback('No provider set')
-      }
-      const cb = (err, id) => {
-        let name = null
-        if (err) name = 'Unknown'
-        // https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md
-        else if (id === 1) name = 'Main'
-        else if (id === 3) name = 'Ropsten'
-        else if (id === 4) name = 'Rinkeby'
-        else if (id === 5) name = 'Goerli'
-        else if (id === 42) name = 'Kovan'
-        else if (id === 11155111) name = 'Sepolia'
-        else name = 'Custom'
-
-        if (id === 1) {
-          web3.eth.getBlock(0).then((block) => {
-            if (block && block.hash !== this.mainNetGenesisHash) name = 'Custom'
-            callback(err, { id, name, lastBlock: this.lastBlock, currentFork: this.currentFork })
-          }).catch((error) => callback(error))
-        } else {
-          callback(err, { id, name, lastBlock: this.lastBlock, currentFork: this.currentFork })
+    return new Promise((resolve, reject) => {
+      if (this.isVM()) {
+        callback && callback(null, { id: '-', name: 'VM' })
+        return resolve({ id: '-', name: 'VM' })
+      } else {
+        if (!web3.currentProvider) {
+          callback && callback('No provider set')
+          return reject('No provider set')
+        }
+        const cb = (err, id) => {
+          let name = null
+          if (err) name = 'Unknown'
+          // https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md
+          else if (id === 1) name = 'Main'
+          else if (id === 3) name = 'Ropsten'
+          else if (id === 4) name = 'Rinkeby'
+          else if (id === 5) name = 'Goerli'
+          else if (id === 42) name = 'Kovan'
+          else if (id === 11155111) name = 'Sepolia'
+          else name = 'Custom'
+
+          if (id === 1) {
+            web3.eth.getBlock(0).then((block) => {
+              if (block && block.hash !== this.mainNetGenesisHash) name = 'Custom'
+              callback && callback(err, { id, name, lastBlock: this.lastBlock, currentFork: this.currentFork })
+              return resolve({ id, name, lastBlock: this.lastBlock, currentFork: this.currentFork })
+            }).catch((error) => {
+              callback && callback(error)
+              return reject(error)
+            })
+          } else {
+            callback && callback(err, { id, name, lastBlock: this.lastBlock, currentFork: this.currentFork })
+            return resolve({ id, name, lastBlock: this.lastBlock, currentFork: this.currentFork })
+          }
         }
+        web3.eth.net.getId().then(id=>cb(null,parseInt(id))).catch(err=>cb(err))
       }
-      web3.eth.net.getId().then(id=>cb(null,parseInt(id))).catch(err=>cb(err))
-    }
+    })
   }
 
   removeProvider (name) {
@@ -195,4 +205,26 @@ export class ExecutionContext {
       return transactionDetailsLinks[network] + hash
     }
   }
+
+  async getStateDetails() {
+    const db = await this.web3().remix.getStateDb()
+    const blocksData = await this.web3().remix.getBlocksData()
+    const state = {
+      db: Object.fromEntries(db._database),
+      blocks: blocksData.blocks,
+      latestBlockNumber: blocksData.latestBlockNumber
+    }
+    const stringifyed = JSON.stringify(state, (key, value) => {
+      if (key === 'db') {
+        return value
+      } else if (key === 'blocks') {
+        return value.map(block => bufferToHex(block))
+      }else if (key === '') {
+        return value           
+      }
+      return bufferToHex(value)
+    }, '\t')
+
+    return stringifyed
+  }
 }