debugger ans solidityLocals updated

libs/remix-debug/src/debugger/debugger.ts

@@ -7,154 +7,163 @@ const BreakpointManager = require('../code/breakpointManager')
 const StepManager = require('./stepManager')
 const VmDebuggerLogic = require('./VmDebugger')
 
-function Debugger (options) {
-  this.event = new EventManager()
-
-  this.offsetToLineColumnConverter = options.offsetToLineColumnConverter
-  /*
-    Returns a compilation result for a given address or the last one available if none are found
-  */
-  this.compilationResult = options.compilationResult || function (contractAddress) { return null }
-
-  this.debugger = new Ethdebugger({
-    web3: options.web3,
-    debugWithGeneratedSources: options.debugWithGeneratedSources,
-    compilationResult: this.compilationResult,
-  })
-
-  const {traceManager, callTree, solidityProxy} = this.debugger
-  this.breakPointManager = new BreakpointManager({traceManager, callTree, solidityProxy, locationToRowConverter: async (sourceLocation) => {
-    const compilationResult = await this.compilationResult()
-    if (!compilationResult) return { start: null, end: null }
-    return this.offsetToLineColumnConverter.offsetToLineColumn(sourceLocation, sourceLocation.file, compilationResult.source.sources, compilationResult.data.sources)
-  }})
-
-  this.breakPointManager.event.register('managersChanged', () => {
+export class Debugger {
+
+  event
+  offsetToLineColumnConverter
+  compilationResult
+  debugger
+  breakPointManager
+  step_manager
+  vmDebuggerLogic
+  
+  constructor (options) {
+    this.event = new EventManager()
+
+    this.offsetToLineColumnConverter = options.offsetToLineColumnConverter
+    /*
+      Returns a compilation result for a given address or the last one available if none are found
+    */
+    this.compilationResult = options.compilationResult || function (contractAddress) { return null }
+
+    this.debugger = new Ethdebugger({
+      web3: options.web3,
+      debugWithGeneratedSources: options.debugWithGeneratedSources,
+      compilationResult: this.compilationResult,
+    })
+
     const {traceManager, callTree, solidityProxy} = this.debugger
-    this.breakPointManager.setManagers({traceManager, callTree, solidityProxy})
-  })
+    this.breakPointManager = new BreakpointManager({traceManager, callTree, solidityProxy, locationToRowConverter: async (sourceLocation) => {
+      const compilationResult = await this.compilationResult()
+      if (!compilationResult) return { start: null, end: null }
+      return this.offsetToLineColumnConverter.offsetToLineColumn(sourceLocation, sourceLocation.file, compilationResult.source.sources, compilationResult.data.sources)
+    }})
+
+    this.breakPointManager.event.register('managersChanged', () => {
+      const {traceManager, callTree, solidityProxy} = this.debugger
+      this.breakPointManager.setManagers({traceManager, callTree, solidityProxy})
+    })
 
-  this.breakPointManager.event.register('breakpointStep', (step) => {
-    this.step_manager.jumpTo(step)
-  })
+    this.breakPointManager.event.register('breakpointStep', (step) => {
+      this.step_manager.jumpTo(step)
+    })
 
-  this.debugger.setBreakpointManager(this.breakPointManager)
+    this.debugger.setBreakpointManager(this.breakPointManager)
 
-  this.debugger.event.register('newTraceLoaded', this, () => {
-    this.event.trigger('debuggerStatus', [true])
-  })
+    this.debugger.event.register('newTraceLoaded', this, () => {
+      this.event.trigger('debuggerStatus', [true])
+    })
 
-  this.debugger.event.register('traceUnloaded', this, () => {
-    this.event.trigger('debuggerStatus', [false])
-  })
-}
+    this.debugger.event.register('traceUnloaded', this, () => {
+      this.event.trigger('debuggerStatus', [false])
+    })
+  }
+
+  async registerAndHighlightCodeItem (index) {
+    // register selected code item, highlight the corresponding source location
+    // this.debugger.traceManager.getCurrentCalledAddressAt(index, async (error, address) => {
 
-Debugger.prototype.registerAndHighlightCodeItem = async function (index) {
-  // register selected code item, highlight the corresponding source location
-  // this.debugger.traceManager.getCurrentCalledAddressAt(index, async (error, address) => {
-
-  try {
-    const address = this.debugger.traceManager.getCurrentCalledAddressAt(index)
-    const compilationResultForAddress = await this.compilationResult(address)
-    if (!compilationResultForAddress) return
-
-    this.debugger.callTree.sourceLocationTracker.getValidSourceLocationFromVMTraceIndex(address, index, compilationResultForAddress.data.contracts).then((rawLocation) => {
-      if (compilationResultForAddress && compilationResultForAddress.data) {
-        const generatedSources = this.debugger.callTree.sourceLocationTracker.getGeneratedSourcesFromAddress(address)
-        const astSources = Object.assign({}, compilationResultForAddress.data.sources)
-        const sources = Object.assign({}, compilationResultForAddress.source.sources)
-        if (generatedSources) {
-          for (const genSource of generatedSources) {
-            astSources[genSource.name] = { id: genSource.id, ast: genSource.ast }
-            sources[genSource.name] = { content: genSource.contents }
+    try {
+      const address = this.debugger.traceManager.getCurrentCalledAddressAt(index)
+      const compilationResultForAddress = await this.compilationResult(address)
+      if (!compilationResultForAddress) return
+
+      this.debugger.callTree.sourceLocationTracker.getValidSourceLocationFromVMTraceIndex(address, index, compilationResultForAddress.data.contracts).then((rawLocation) => {
+        if (compilationResultForAddress && compilationResultForAddress.data) {
+          const generatedSources = this.debugger.callTree.sourceLocationTracker.getGeneratedSourcesFromAddress(address)
+          const astSources = Object.assign({}, compilationResultForAddress.data.sources)
+          const sources = Object.assign({}, compilationResultForAddress.source.sources)
+          if (generatedSources) {
+            for (const genSource of generatedSources) {
+              astSources[genSource.name] = { id: genSource.id, ast: genSource.ast }
+              sources[genSource.name] = { content: genSource.contents }
+            }
           }
+          var lineColumnPos = this.offsetToLineColumnConverter.offsetToLineColumn(rawLocation, rawLocation.file, sources, astSources)
+          this.event.trigger('newSourceLocation', [lineColumnPos, rawLocation, generatedSources])
+        } else {
+          this.event.trigger('newSourceLocation', [null])
         }
-        var lineColumnPos = this.offsetToLineColumnConverter.offsetToLineColumn(rawLocation, rawLocation.file, sources, astSources)
-        this.event.trigger('newSourceLocation', [lineColumnPos, rawLocation, generatedSources])
-      } else {
+      }).catch((_error) => {
         this.event.trigger('newSourceLocation', [null])
-      }
-    }).catch((_error) => {
-      this.event.trigger('newSourceLocation', [null])
-    })
-    // })
-  } catch (error) {
-    return console.log(error)
+      })
+      // })
+    } catch (error) {
+      return console.log(error)
+    }
   }
-}
 
-Debugger.prototype.updateWeb3 = function (web3) {
-  this.debugger.web3 = web3
-}
+  updateWeb3 (web3) {
+    this.debugger.web3 = web3
+  }
 
-Debugger.prototype.debug = function (blockNumber, txNumber, tx, loadingCb) {
-  const web3 = this.debugger.web3
+  debug (blockNumber, txNumber, tx, loadingCb) {
+    const web3 = this.debugger.web3
 
-  return new Promise((resolve, reject) => {
-    if (this.debugger.traceManager.isLoading) {
-      return resolve()
-    }
+    return new Promise((resolve, reject) => {
+      if (this.debugger.traceManager.isLoading) {
+        return resolve()
+      }
 
-    if (tx) {
-      if (!tx.to) {
-        tx.to = traceHelper.contractCreationToken('0')
+      if (tx) {
+        if (!tx.to) {
+          tx.to = traceHelper.contractCreationToken('0')
+        }
+        this.debugTx(tx, loadingCb)
+        return resolve()
       }
-      this.debugTx(tx, loadingCb)
-      return resolve()
-    }
 
-    try {
-      if (txNumber.indexOf('0x') !== -1) {
-        return web3.eth.getTransaction(txNumber, (_error, tx) => {
+      try {
+        if (txNumber.indexOf('0x') !== -1) {
+          return web3.eth.getTransaction(txNumber, (_error, tx) => {
+            if (_error) return reject(_error)
+            if (!tx) return reject('cannot find transaction ' + txNumber)
+            this.debugTx(tx, loadingCb)
+            return resolve()
+          })
+        }
+        web3.eth.getTransactionFromBlock(blockNumber, txNumber, (_error, tx) => {
           if (_error) return reject(_error)
-          if (!tx) return reject('cannot find transaction ' + txNumber)
+          if (!tx) return reject('cannot find transaction ' + blockNumber + ' ' + txNumber)
           this.debugTx(tx, loadingCb)
           return resolve()
         })
+      } catch (e) {
+        return reject(e.message)
       }
-      web3.eth.getTransactionFromBlock(blockNumber, txNumber, (_error, tx) => {
-        if (_error) return reject(_error)
-        if (!tx) return reject('cannot find transaction ' + blockNumber + ' ' + txNumber)
-        this.debugTx(tx, loadingCb)
-        return resolve()
-      })
-    } catch (e) {
-      return reject(e.message)
-    }
-  })
-}
+    })
+  }
 
-Debugger.prototype.debugTx = function (tx, loadingCb) {
-  this.step_manager = new StepManager(this.debugger, this.debugger.traceManager)
+  debugTx (tx, loadingCb) {
+    this.step_manager = new StepManager(this.debugger, this.debugger.traceManager)
 
-  this.debugger.codeManager.event.register('changed', this, (code, address, instIndex) => {
-    this.debugger.callTree.sourceLocationTracker.getValidSourceLocationFromVMTraceIndex(address, this.step_manager.currentStepIndex, this.debugger.solidityProxy.contracts).then((sourceLocation) => {
-      this.vmDebuggerLogic.event.trigger('sourceLocationChanged', [sourceLocation])
+    this.debugger.codeManager.event.register('changed', this, (code, address, instIndex) => {
+      this.debugger.callTree.sourceLocationTracker.getValidSourceLocationFromVMTraceIndex(address, this.step_manager.currentStepIndex, this.debugger.solidityProxy.contracts).then((sourceLocation) => {
+        this.vmDebuggerLogic.event.trigger('sourceLocationChanged', [sourceLocation])
+      })
     })
-  })
 
-  this.vmDebuggerLogic = new VmDebuggerLogic(this.debugger, tx, this.step_manager, this.debugger.traceManager, this.debugger.codeManager, this.debugger.solidityProxy, this.debugger.callTree)
-  this.vmDebuggerLogic.start()
+    this.vmDebuggerLogic = new VmDebuggerLogic(this.debugger, tx, this.step_manager, this.debugger.traceManager, this.debugger.codeManager, this.debugger.solidityProxy, this.debugger.callTree)
+    this.vmDebuggerLogic.start()
 
-  this.step_manager.event.register('stepChanged', this, (stepIndex) => {
-    if (typeof stepIndex !== 'number' || stepIndex >= this.step_manager.traceLength) {
-      return this.event.trigger('endDebug')
-    }
+    this.step_manager.event.register('stepChanged', this, (stepIndex) => {
+      if (typeof stepIndex !== 'number' || stepIndex >= this.step_manager.traceLength) {
+        return this.event.trigger('endDebug')
+      }
 
-    this.debugger.codeManager.resolveStep(stepIndex, tx)
-    this.step_manager.event.trigger('indexChanged', [stepIndex])
-    this.vmDebuggerLogic.event.trigger('indexChanged', [stepIndex])
-    this.vmDebuggerLogic.debugger.event.trigger('indexChanged', [stepIndex])
-    this.registerAndHighlightCodeItem(stepIndex)
-  })
+      this.debugger.codeManager.resolveStep(stepIndex, tx)
+      this.step_manager.event.trigger('indexChanged', [stepIndex])
+      this.vmDebuggerLogic.event.trigger('indexChanged', [stepIndex])
+      this.vmDebuggerLogic.debugger.event.trigger('indexChanged', [stepIndex])
+      this.registerAndHighlightCodeItem(stepIndex)
+    })
 
-  loadingCb()
-  this.debugger.debug(tx)
-}
+    loadingCb()
+    this.debugger.debug(tx)
+  }
 
-Debugger.prototype.unload = function () {
-  this.debugger.unLoad()
-  this.event.trigger('debuggerUnloaded')
+  unload () {
+    this.debugger.unLoad()
+    this.event.trigger('debuggerUnloaded')
+  }
 }
-
-module.exports = Debugger

libs/remix-debug/src/debugger/solidityLocals.ts

@@ -1,9 +1,17 @@
 const EventManager = require('../eventManager')
-
 const localDecoder = require('../solidity-decoder/localDecoder')
 const StorageViewer = require('../storage/storageViewer')
 
-class DebuggerSolidityLocals {
+export class DebuggerSolidityLocals {
+
+  event
+  stepManager
+  internalTreeCall
+  storageResolver
+  traceManager
+  tx
+  _sourceLocation
+
   constructor (tx, _stepManager, _traceManager, _internalTreeCall) {
     this.event = new EventManager()
     this.stepManager = _stepManager
@@ -28,7 +36,7 @@ class DebuggerSolidityLocals {
     }, 500)
   }
 
-  decode (sourceLocation, cursor) {
+  decode (sourceLocation, cursor?) {
     const self = this
     this.event.trigger('solidityLocalsMessage', [''])
     this.traceManager.waterfall([
@@ -94,5 +102,3 @@ class DebuggerSolidityLocals {
     }, 500)
   }
 }
-
-module.exports = DebuggerSolidityLocals