add minimal API for plugin

package.json

@@ -22,6 +22,7 @@
     "csslint": "^1.0.2",
     "deep-equal": "^1.0.1",
     "ethereumjs-util": "^5.1.2",
+    "events": "^3.0.0",
     "execr": "^1.0.1",
     "exorcist": "^0.4.0",
     "fast-async": "6.3.1",

src/app.js

@@ -6,6 +6,7 @@ var async = require('async')
 var request = require('request')
 var remixLib = require('remix-lib')
 var EventManager = require('./lib/events')
+var EventEmitter = require('events')
 
 var registry = require('./global/registry')
 var UniversalDApp = require('./universal-dapp.js')
@@ -204,6 +205,13 @@ class App {
     run.apply(self)
   }
 
+  profile () {
+    return {
+      type: 'app',
+      methods: ['getExecutionContextProvider', 'getProviderEndpoint', 'detectNetWork', 'addProvider', 'removeProvider']
+    }
+  }
+  
   render () {
     var self = this
     if (self._view.el) return self._view.el
@@ -283,6 +291,34 @@ class App {
       if (callback) callback(error)
     })
   }
+
+  getExecutionContextProvider (cb) {
+    cb(null, executionContext.getProvider())
+  }
+
+  getProviderEndpoint (cb) {
+    if (executionContext.getProvider() === 'web3') {
+      cb(null, executionContext.web3().currentProvider.host)
+    } else {
+      cb('no endpoint: current provider is either injected or vm')
+    }
+  }
+
+  detectNetWork (cb) {
+    executionContext.detectNetwork((error, network) => {
+      cb(error, network)
+    })
+  }
+
+   addProvider (name, url, cb) {
+    executionContext.addProvider({ name, url })
+    cb()
+  }
+
+   removeProvider (name, cb) {
+    executionContext.removeProvider(name)
+    cb()
+  }
 }
 
 module.exports = App
@@ -359,33 +395,60 @@ Please make a backup of your contracts and start using http://remix.ethereum.org
   })
   registry.put({api: eventsDecoder, name: 'eventsdecoder'})
 
+  /*
+    that proxy is used by appManager to broadcast new transaction event
+  */
+  const txListenerModuleProxy = {
+    event: new EventEmitter(),
+    profile() {
+      return {
+        type: 'txListener',
+        events: ['newTransaction']
+      }
+    }
+  }
+  txlistener.event.register('newTransaction', (tx) => {
+    txListenerModule.event.emit('newTransaction', tx)
+  })
+
   txlistener.startListening()
 
   // TODO: There are still a lot of dep between editorpanel and filemanager
 
-  // ----------------- editor panel ----------------------
-  self._components.editorpanel = new EditorPanel()
-  registry.put({ api: self._components.editorpanel, name: 'editorpanel' })
-
   // ----------------- file manager ----------------------------
   self._components.fileManager = new FileManager()
   var fileManager = self._components.fileManager
   registry.put({api: fileManager, name: 'filemanager'})
 
+  // ----------------- editor panel ----------------------
+  self._components.editorpanel = new EditorPanel()
+  registry.put({ api: self._components.editorpanel, name: 'editorpanel' })
+
   // ----------------- Renderer -----------------
   var renderer = new Renderer()
   registry.put({api: renderer, name: 'renderer'})
   
   // ----------------- app manager ----------------------------
-  const PluginManagerProfile = {
-    type: 'pluginManager',
-    methods: []
-  }
+
+  /*
+    TODOs:
+      - for each activated plugin,
+        an internal module (associated only with the plugin) should be created for accessing specific part of the UI. detail to be discussed
+      - the current API is not optimal. For instance methods of `app` only refers to `executionContext`, wich does not make really sense. 
+  */
 
   const appManager = new AppManager({modules: [],plugins : []})
 
   const swapPanelComponent = new SwapPanelComponent()
-  const pluginManagerComponent = new PluginManagerComponent()
+  const pluginManagerComponent = new PluginManagerComponent(
+    { 
+      app: this,
+      udapp: udapp,
+      fileManager: fileManager,
+      sourceHighlighters: registry.get('editor').api.sourceHighlighters,
+      config: self._components.filesProviders['config'],
+      txListener: txListenerModuleProxy
+    })
   registry.put({api: pluginManagerComponent.proxy(), name: 'pluginmanager'})
 
   self._components.editorpanel.init()

src/app/components/swap-panel-api.js

@@ -13,7 +13,7 @@ class SwapPanelApi {
     verticalIconsComponent.event.on('showContent', (moduleName) => {
       this.component.showContent(moduleName)
     })
-    pluginManagerComponent.event.on('internalActivated', (mod, content) => {
+    pluginManagerComponent.event.on('requestContainer', (mod, content) => {
       this.add(mod.name, content)
     })
   }

src/app/components/vertical-icons-api.js

@@ -10,7 +10,7 @@ class VerticalIconsApi {
 
   constructor(verticalIconsComponent, pluginManagerComponent) {
     this.component = verticalIconsComponent
-    pluginManagerComponent.event.on('internalActivated', (mod, content) => verticalIconsComponent.addIcon(mod) )
+    pluginManagerComponent.event.on('requestContainer', (mod, content) => verticalIconsComponent.addIcon(mod) )
   }  
 }
 module.exports = VerticalIconsApi

src/app/editor/SourceHighlighters.js

+'use strict'
+var SourceHighlighter = require('./sourceHighlighter')
+
+module.exports = class SourceHighlighters {
+
+    constructor () {
+      this.highlighters = {}
+    }
+
+     profile () {
+      return {
+        type: 'sourcehighlighter',
+        methods: ['highlight', 'discardHighlight']
+      }
+    }
+
+     // TODO what to do with mod?
+    highlight (mod, lineColumnPos, filePath, hexColor, cb) {
+      var position
+      try {
+        position = JSON.parse(lineColumnPos)
+      } catch (e) {
+        return cb(e.message)
+      }
+      if (!highlighters[mod]) highlighters[mod] = new SourceHighlighter()
+      highlighters[mod].currentSourceLocation(null)
+      highlighters[mod].currentSourceLocationFromfileName(position, filePath, hexColor)
+      cb()
+    }
+
+     discardHighlight (mod, cb) {
+      if (highlighters[mod]) highlighters[mod].currentSourceLocation(null)
+      cb()
+    }
+}
\ No newline at end of file

src/app/editor/editor.js

@@ -7,6 +7,7 @@ var ace = require('brace')
 require('brace/theme/tomorrow_night_blue')
 
 var globalRegistry = require('../../global/registry')
+const SourceHighlighters = require('./SourceHighlighters')
 
 var Range = ace.acequire('ace/range').Range
 require('brace/ext/language_tools')
@@ -317,6 +318,8 @@ function Editor (opts = {}, localRegistry) {
   editor.commands.bindKeys({ 'ctrl-t': null })
   editor.setShowPrintMargin(false)
   editor.resize(true)
+
+  this.sourceHighlighters = new SourceHighlighters()
 }
 
 function editorOnChange (self) {

src/app/files/browser-files-tree.js

@@ -130,6 +130,13 @@ function FilesTree (name, storage) {
     if (path[0] === '/') return path.substring(1)
     return path
   }
+
+  this.profile = function () {
+    return {
+      type: this.type,
+      methods: ['get', 'set', 'remove']
+    }
+  }
 }
 
 module.exports = FilesTree

src/app/files/fileManager.js

@@ -2,6 +2,7 @@
 
 var $ = require('jquery')
 var yo = require('yo-yo')
+var EventEmitter = require ('events')
 var EventManager = require('../../lib/events')
 var globalRegistry = require('../../global/registry')
 var CompilerImport = require('../compiler/compiler-imports')
@@ -15,6 +16,7 @@ class FileManager {
   constructor (localRegistry) {
     this.tabbedFiles = {}
     this.event = new EventManager()
+    this.nodeEvent = new EventEmitter()
     this._components = {}
     this._components.compilerImport = new CompilerImport()
     this._components.registry = localRegistry || globalRegistry
@@ -42,6 +44,18 @@ class FileManager {
     self._deps.gistExplorer.event.register('fileRemoved', (path) => { this.fileRemovedEvent(path) })
     self._deps.localhostExplorer.event.register('errored', (event) => { this.removeTabsOf(self._deps.localhostExplorer) })
     self._deps.localhostExplorer.event.register('closed', (event) => { this.removeTabsOf(self._deps.localhostExplorer) })
+
+    self.event.register('currentFileChanged', (file, provider) => {
+      this.nodeEvent.emit('currentFileChanged', file)
+    })
+  }
+
+  profile () {
+    return {
+      type: 'fileManager',
+      methods: ['getFilesFromPath', 'getCurrentFile', 'getFile', 'setFile'],
+      events: ['currentFileChanged']
+    }
   }
 
   fileRenamedEvent (oldName, newName, isFolder) {
@@ -94,6 +108,41 @@ class FileManager {
     return path ? path[1] : null
   }
 
+  getCurrentFile (cb) {
+    var path = this.currentFile()
+    if (!path) {
+      cb('no file selected')
+    } else {
+      cb(null, path)
+    }
+  }
+  
+  getFile (path, cb) {
+    var provider = this.fileProviderOf(path)
+    if (provider) {
+      // TODO add approval to user for external plugin to get the content of the given `path`
+      provider.get(path, (error, content) => {
+        cb(error, content)
+      })
+    } else {
+      cb(path + ' not available')
+    }
+  }
+
+  setFile (path, content, cb) {
+    var provider = this.fileProviderOf(path)
+    if (provider) {
+      // TODO add approval to user for external plugin to set the content of the given `path`
+      provider.set(path, content, (error) => {
+        if (error) return cb(error)
+        this.syncEditor(path)
+        cb()
+      })
+    } else {
+      cb(path + ' not available')
+    }
+  }
+
   removeTabsOf (provider) {
     for (var tab in this.tabbedFiles) {
       if (this.fileProviderOf(tab).type === provider.type) {

src/app/panels/editor-panel.js

@@ -15,9 +15,11 @@ var css = styles.css
 class EditorPanel {
   constructor (localRegistry) {
     var self = this
+    self.event = new EventManager()
     self._components = {}
     self._components.registry = localRegistry || globalRegistry
-    self.event = new EventManager()
+    self._components.editor = new Editor({})
+    self._components.registry.put({api: self._components.editor, name: 'editor'})
   }
   init () {
     var self = this
@@ -38,18 +40,13 @@ class EditorPanel {
       }
     }
     self._view = {}
-    var editor = new Editor({})
-    self._components.registry.put({api: editor, name: 'editor'})
     
-    var contextualListener = new ContextualListener({editor, pluginManager: self._deps.pluginManager})
-    var contextView = new ContextView({contextualListener, editor})
+    var contextualListener = new ContextualListener({editor: self._components.editor, pluginManager: self._deps.pluginManager})
+    var contextView = new ContextView({contextualListener, editor: self._components.editor})
 
-    self._components = {
-      editor: editor,
-      contextualListener: contextualListener,
-      contextView: contextView,
-      // TODO list of compilers is always empty; should find a path to add plugin compiler here
-      terminal: new Terminal({
+    self._components.contextualListener = contextualListener
+    self._components.contextView = contextView
+    self._components.terminal = new Terminal({
       udapp: self._deps.udapp,
       compilers: {}
     },
@@ -63,7 +60,6 @@ class EditorPanel {
           return newpos
         }
       })
-    }
 
     self._components.terminal.event.register('filterChanged', (type, value) => {
       this.event.trigger('terminalFilterChanged', [type, value])

src/app/tabs/compile-tab.js

@@ -182,10 +182,13 @@ module.exports = class CompileTab {
       }
     })
   }
+  getCompilationResult (cb) {
+    cb(null, self._components.compiler.lastCompilationResult)
+  }
   profile () {
     return {
       type: 'solidityCompile',
-      methods: {},
+      methods: ['getCompilationResult'],
       events: ['compilationFinished']
     }
   }

src/universal-dapp.js

@@ -51,6 +51,13 @@ function UniversalDApp (opts, localRegistry) {
   self.resetEnvironment()
 }
 
+UniversalDApp.prototype.profile = function () {
+  return {
+    type: 'udapp',
+    methods: ['runTestTx', 'getAccounts', 'createVMAccount']
+  }
+}
+
 UniversalDApp.prototype.resetEnvironment = function () {
   this.accounts = {}
   if (executionContext.isVM()) {
@@ -77,6 +84,7 @@ UniversalDApp.prototype.resetAPI = function (transactionContextAPI) {
 }
 
 UniversalDApp.prototype.createVMAccount = function (privateKey, balance, cb) {
+  if (executionContext.getProvider() !== 'vm') return cb('plugin API does not allow creating a new account through web3 connection. Only vm mode is allowed')
   this._addAccount(privateKey, balance)
   executionContext.vm().stateManager.cache.flush(function () {})
   privateKey = Buffer.from(privateKey, 'hex')
@@ -287,6 +295,34 @@ UniversalDApp.prototype.getInputs = function (funABI) {
 }
 
 /**
+ * This function send a tx only to javascript VM or testnet, will return an error for the mainnet
+ * SHOULD BE TAKEN CAREFULLY!
+ *
+ * @param {Object} tx    - transaction.
+ * @param {Function} callback    - callback.
+ */
+UniversalDApp.prototype.runTestTx = function (tx, cb) {
+  executionContext.detectNetwork((error, network) => {
+    if (error) return cb(error)
+    if (network.name === 'Main' && network.id === '1') {
+      return cb('It is not allowed to make this action against mainnet')
+    }
+    udapp.silentRunTx(tx, (error, result) => {
+      if (error) return cb(error)
+      cb(null, {
+        transactionHash: result.transactionHash,
+        status: result.result.status,
+        gasUsed: '0x' + result.result.gasUsed.toString('hex'),
+        error: result.result.vm.exceptionError,
+        return: result.result.vm.return ? '0x' + result.result.vm.return.toString('hex') : '0x',
+        createdAddress: result.result.createdAddress ? '0x' + result.result.createdAddress.toString('hex') : undefined
+      })
+    })
+  })
+}
+
+
+/**
  * This function send a tx without alerting the user (if mainnet or if gas estimation too high).
  * SHOULD BE TAKEN CAREFULLY!
  *