Move Remixd To Monorepo

.env

@@ -1,3 +1,4 @@
 gist_token=<token>
 account_passphrase=<passphrase>
-account_password=<password>
+account_password=<password>
+NODE_OPTIONS=--max-old-space-size=2048

apps/remix-ide-e2e/seleniumConfig.js

@@ -1,3 +1,4 @@
+/* eslint-disable */
 module.exports = {
   version: '3.8.1',
   baseURL: 'https://selenium-release.storage.googleapis.com',

apps/remix-ide/ci/browser_tests_chrome.sh

@@ -2,22 +2,14 @@
 
 set -e
 
-setupRemixd () {
-  mkdir remixdSharedfolder
-  cd apps/remix-ide/contracts
-  echo 'sharing folder: '
-  echo $PWD
-  ../../../node_modules/.bin/remixd -s $PWD --remix-ide http://127.0.0.1:8080 &
-  cd ../../..
-}
-
 BUILD_ID=${CIRCLE_BUILD_NUM:-${TRAVIS_JOB_NUMBER}}
 echo "$BUILD_ID"
 TEST_EXITCODE=0
 
 npm run ganache-cli &
 npm run serve &
-setupRemixd
+echo 'sharing folder: ' $PWD '/apps/remix-ide/contracts' &
+npm run remixd &
 
 sleep 5
 

apps/remix-ide/ci/browser_tests_firefox.sh

@@ -2,22 +2,14 @@
 
 set -e
 
-setupRemixd () {
-  mkdir remixdSharedfolder
-  cd apps/remix-ide/contracts
-  echo 'sharing folder: '
-  echo $PWD
-  ../../../node_modules/.bin/remixd -s $PWD --remix-ide http://127.0.0.1:8080 &
-  cd ../../..
-}
-
 BUILD_ID=${CIRCLE_BUILD_NUM:-${TRAVIS_JOB_NUMBER}}
 echo "$BUILD_ID"
 TEST_EXITCODE=0
 
 npm run ganache-cli &
 npm run serve &
-setupRemixd
+echo 'sharing folder: ' $PWD '/apps/remix-ide/contracts' &
+npm run remixd &
 
 sleep 5
 

apps/remix-ide/ci/browser_tests_run_deploy.sh

@@ -2,22 +2,12 @@
 
 set -e
 
-setupRemixd () {
-  mkdir remixdSharedfolder
-  cd apps/remix-ide/contracts
-  echo 'sharing folder: '
-  echo $PWD
-  ../../../node_modules/.bin/remixd -s $PWD --remix-ide http://127.0.0.1:8080 &
-  cd ../../..
-}
-
 BUILD_ID=${CIRCLE_BUILD_NUM:-${TRAVIS_JOB_NUMBER}}
 echo "$BUILD_ID"
 TEST_EXITCODE=0
 
 npm run ganache-cli &
 npm run serve &
-setupRemixd
 
 sleep 5
 

libs/README.md

@@ -22,7 +22,7 @@ Remix is built out of several different modules. Here is the brief description.
 + [`remix-lib`](remix-lib/README.md): Common place for libraries being used across multiple modules
 + [`remix-tests`](remix-tests/README.md): Unit test Solidity smart contracts. It works as a plugin & as CLI both
 + [`remix-url-resolver`](remix-url-resolver/README.md): Provide helpers for resolving the content from external URL ( including github, swarm, ipfs etc.).
-+ [`remixd`](https://github.com/ethereum/remixd/tree/master): Allow accessing local filesystem from Remix IDE by running a daemon
++ [`remixd`](remixd/README.md): Allow accessing local filesystem from Remix IDE by running a daemon
 
 Each module generally has their own npm package and test suite, as well as basic documentation in their respective `README`s. Usage of modules as plugin is well documented **[here](https://remix-ide.readthedocs.io/en/latest/index.html)**.
 

libs/remix-astwalker/.eslintrc

@@ -1,7 +1,8 @@
 { 
     "extends": "../../.eslintrc", 
     "rules": {
-        "@typescript-eslint/no-explicit-any": "off"
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/prefer-namespace-keyword": "off"
     }, 
     "ignorePatterns": ["!**/*"] 
 }

libs/remix-astwalker/src/@types/remix-lib/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitiosn for the things we need from remix-lib
+// Type definitions for the things we need from remix-lib
 
 declare module "remix-lib" {
   export module util {

libs/remixd/.eslintrc

@@ -0,0 +1 @@
+{ "extends": "../../.eslintrc", "rules": {}, "ignorePatterns": ["!**/*"] }

libs/remixd/README.md

@@ -0,0 +1,49 @@
+# Remixd
+
+`remixd` is a tool that intend to be used with [Remix IDE](https://github.com/ethereum/remix-project) (aka. Browser-Solidity). It allows a websocket connection between
+`Remix IDE` (web application) and the local computer.
+
+Practically Remix IDE makes available a folder shared by `remixd`.
+
+More details are explained in this [tutorial](https://remix-ide.readthedocs.io/en/latest/remixd.html).
+
+Alternatively `remixd` can be used to setup a development environment that can be used with other popular frameworks like Embark, Truffle, Ganache, etc..
+
+`remixd` needs `npm` and `node`
+
+## INSTALLATION
+
+`npm install -g @remix-project/remixd`
+
+## HELP SECTION
+
+```
+  Usage: remixd -s <shared folder> --remix-ide https://remix.ethereum.org
+
+  Provide a two-way connection between the local computer and Remix IDE.
+
+
+  Options:
+
+  --remix-ide  <url>                    URL of remix instance allowed to connect to this 
+                                        web sockect connection
+  -s, --shared-folder <path>            Folder to share with Remix IDE
+  --read-only                           Treat shared folder as read-only (experimental)
+  -h, --help                            output usage information
+
+```
+
+## SHARE A FOLDER
+
+`remixd -s <absolute-path> --remix-ide https://remix.ethereum.org`
+
+The current user should have `read/write` access to the folder (at least `read` access).
+
+It is important to notice that changes made to the current file in `Remix IDE` are automatically saved to the local computer every 5000 ms. There is no `Save` action. But the `Ctrl-Z` (undo) can be used.
+
+Furthermore :
+ - No copy of the shared folder are kept in the browser storage.
+ - It is not possible to create a file from `Remix IDE` (that might change).
+ - If a folder does not contain any file, the folder will not be displayed in the explorer (that might change).
+ - Symbolic links are not forwarded to Remix IDE.
+

libs/remixd/jest.config.js

@@ -0,0 +1,15 @@
+/* eslint-disable */
+module.exports = {
+  name: 'remixd',
+  preset: '../../jest.config.js',
+  globals: {
+    'ts-jest': {
+      tsConfig: '<rootDir>/tsconfig.spec.json'
+    }
+  },
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest'
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'html'],
+  coverageDirectory: '../../coverage/libs/remixd'
+};

libs/remixd/nodemon.json

@@ -0,0 +1,5 @@
+{
+    "watch": ["./src", "./bin"],
+    "ext": "ts",
+    "exec": "npm run build && npm run start"
+}

libs/remixd/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@remix-project/remixd",
+  "version": "0.2.4-alpha.0",
+  "description": "remix server: allow accessing file system from remix.ethereum.org and start a dev environment (see help section)",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "bin": {
+    "remixd": "./bin/remixd.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\"",
+    "start": "./bin/remixd.js",
+    "npip": "npip",
+    "lint": "eslint ./src ./bin --ext .ts",
+    "build": "tsc -p ./ && chmod +x ./bin/remixd.js",
+    "dev": "nodemon"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ethereum/remix-project.git"
+  },
+  "keywords": [
+    "remix",
+    "ide",
+    "ethereum",
+    "solidity"
+  ],
+  "author": "Remix Team",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ethereum/remix-project/issues"
+  },
+  "homepage": "https://github.com/ethereum/remix-project#readme",
+  "dependencies": {
+    "@remixproject/plugin": "0.3.0-beta.5",
+    "@remixproject/plugin-api": "0.3.0-beta.5",
+    "@remixproject/plugin-utils": "0.3.0-beta.5",
+    "@remixproject/plugin-ws": "^0.3.0-beta.8",
+    "axios": "^0.20.0",
+    "chokidar": "^2.1.8",
+    "commander": "^2.20.3",
+    "fs-extra": "^3.0.1",
+    "isbinaryfile": "^3.0.2",
+    "ws": "^7.3.0"
+  },
+  "python": {
+    "execPath": "python3",
+    "dependencies": {
+      "vyper": ">=0.1.0b3"
+    }
+  },
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@types/fs-extra": "^9.0.1",
+    "@types/node": "^14.0.5",
+    "@types/ws": "^7.2.4",
+    "@typescript-eslint/eslint-plugin": "^3.2.0",
+    "@typescript-eslint/parser": "^3.2.0",
+    "eslint": "6.8.0",
+    "eslint-config-standard": "14.1.1",
+    "eslint-plugin-import": "2.20.2",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "4.2.1",
+    "eslint-plugin-standard": "4.0.1",
+    "nodemon": "^2.0.4",
+    "ts-node": "^8.10.1",
+    "typescript": "^3.9.3"
+  }
+}

libs/remixd/src/bin/remixd.ts

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+import WebSocket from '../websocket'
+import * as servicesList from '../serviceList'
+import * as WS from 'ws'
+import { getDomain } from '../utils'
+import Axios from 'axios'
+import * as fs from 'fs-extra'
+import * as path from 'path'
+import * as program from 'commander'
+
+(async () => {
+  program
+  .usage('-s <shared folder>')
+  .description('Provide a two-way connection between the local computer and Remix IDE')
+  .option('--remix-ide  <url>', 'URL of remix instance allowed to connect to this web sockect connection')
+  .option('-s, --shared-folder <path>', 'Folder to share with Remix IDE')
+  .option('--read-only', 'Treat shared folder as read-only (experimental)')
+  .on('--help', function(){
+    console.log('\nExample:\n\n    remixd -s ./ --remix-ide http://localhost:8080')
+  }).parse(process.argv)
+  // eslint-disable-next-line
+  const killCallBack: Array<Function> = []
+
+  if (!program.remixIde) {
+    console.log('\x1b[33m%s\x1b[0m', '[WARN] You can only connect to remixd from one of the supported origins.')
+  } else {
+    const isValid = await isValidOrigin(program.remixIde)
+    /* Allow unsupported origins and display warning. */
+    if (!isValid) {
+      console.log('\x1b[33m%s\x1b[0m', '[WARN] You are using IDE from an unsupported origin.')
+      console.log('\x1b[33m%s\x1b[0m', 'Check https://gist.github.com/EthereumRemix/091ccc57986452bbb33f57abfb13d173 for list of all supported origins.\n')
+      // return
+    }
+    console.log('\x1b[33m%s\x1b[0m', '[WARN] You may now only use IDE at ' + program.remixIde + ' to connect to that instance')
+  }
+
+  if (program.sharedFolder) {
+    console.log('\x1b[33m%s\x1b[0m', '[WARN] Any application that runs on your computer can potentially read from and write to all files in the directory.')
+    console.log('\x1b[33m%s\x1b[0m', '[WARN] Symbolic links are not forwarded to Remix IDE\n')
+    try {
+      const sharedFolderClient = new servicesList['sharedfolder']()
+      const websocketHandler = new WebSocket(65520, { remixIdeUrl: program.remixIde }, sharedFolderClient)
+
+      websocketHandler.start((ws: WS) => {
+        sharedFolderClient.setWebSocket(ws)
+        sharedFolderClient.setupNotifications(program.sharedFolder)
+        sharedFolderClient.sharedFolder(program.sharedFolder, program.readOnly || false)
+      })
+      killCallBack.push(websocketHandler.close.bind(websocketHandler))
+    } catch(error) {
+      throw new Error(error)
+    }
+  } else {
+    console.log('\x1b[31m%s\x1b[0m', '[ERR] No valid shared folder provided.')
+  }
+
+  // kill
+  function kill () {
+    for (const k in killCallBack) {
+      try {
+        killCallBack[k]()
+      } catch (e) {
+        console.log(e)
+      }
+    }
+  }
+
+  process.on('SIGINT', kill) // catch ctrl-c
+  process.on('SIGTERM', kill) // catch kill
+  process.on('exit', kill)
+
+  async function isValidOrigin (origin: string): Promise<any> {
+    if (!origin) return false
+    const domain = getDomain(origin)
+    const gistUrl = 'https://gist.githubusercontent.com/EthereumRemix/091ccc57986452bbb33f57abfb13d173/raw/3367e019335746b73288e3710af2922d4c8ef5a3/origins.json'
+
+    try {
+      const { data } = await Axios.get(gistUrl)
+
+      try {
+        await fs.writeJSON(path.resolve(__dirname + '/../origins.json'), { data })
+      } catch (e) {
+        console.error(e)
+      }
+
+      return data.includes(origin) ? data.includes(origin) : data.includes(domain)
+    } catch (e) {
+      try {
+        // eslint-disable-next-line
+        const origins = require('../origins.json')
+        const { data } = origins
+
+        return data.includes(origin) ? data.includes(origin) : data.includes(domain)
+      } catch (e) {
+        return false
+      }
+    }
+  }
+})()

libs/remixd/src/index.ts

@@ -0,0 +1,12 @@
+'use strict'
+import { RemixdClient as sharedFolder } from './services/remixdClient'
+import Websocket from './websocket'
+import * as utils from './utils'
+
+module.exports = {
+  Websocket,
+  utils,
+  services: {
+    sharedFolder
+  }
+}

libs/remixd/src/origins.json

@@ -0,0 +1,11 @@
+{
+    "data":[
+        "http://remix-alpha.ethereum.org",
+        "http://remix.ethereum.org",
+        "https://remix-alpha.ethereum.org",
+        "https://remix.ethereum.org",
+        "package://a7df6d3c223593f3550b35e90d7b0b1f.mod",
+        "package://6fd22d6fe5549ad4c4d8fd3ca0b7816b.mod",
+        "https://ipfsgw.komputing.org"
+    ]
+}

libs/remixd/src/serviceList.ts

@@ -0,0 +1,3 @@
+import { RemixdClient as sharedfolder } from './services/remixdClient'
+
+export { sharedfolder }