Merge branch 'master' into create-versions-dropdown

Author: fergarrui

.gitignore

@@ -4,3 +4,4 @@ dist/*
 .DS_Store
 coverage/*
 .vscode/*
+contracts/*

Dockerfile

@@ -0,0 +1,18 @@
+FROM node:8-alpine
+
+RUN apk update && apk upgrade && \
+    apk add --no-cache bash git python g++ gcc libgcc libstdc++ linux-headers make
+
+RUN npm install --quiet node-gyp -g
+
+WORKDIR /opt/app
+
+COPY package.json ./
+
+RUN npm i -g npm@^6.1.0 && npm install
+
+COPY . .
+
+EXPOSE 9090
+
+CMD [ "npm", "run", "start" ]

README.md

@@ -20,7 +20,7 @@ There are already tools that allow you to debug Ethereum transactions (Solidity)
 
 Use release link:
 
-  * [v3.5.0](https://github.com/fergarrui/ethereum-graph-debugger/releases/tag/v3.5.0)
+  * [v3.6.0](https://github.com/fergarrui/ethereum-graph-debugger/releases/tag/v3.6.0)
 
 If you want to use master (it can be more unstable), clone and start the application
 
@@ -39,6 +39,14 @@ npm start
 
 Go to localhost:9090
 
+### With docker
+
+`docker-compose up`
+
+Go to localhost:9090
+
+Add contracts to `./contracts` (you will need to create the directory) and empty string at the 'Load contracts from URI' form.
+
 ### Use
 
   * Go to localhost:9090
@@ -53,33 +61,6 @@ Go to localhost:9090
   * Scan the directory as described above
   * You won't get source code mappings when clicking in operations of the CFG
 
-### [Temporal] - switch solc version
-
-Current `solc` version is `0.5.8`, if you want to use an earlier version, for now it can only be done via API (UI coming soon)
-
-  * List supported `solc` versions
-    * `curl http://localhost:9090/solc/list`
-    * Output will be like: 
-    ```
-    [
-    {
-        "version": "0.5.8",
-        "commit": "v0.5.8+commit.23d335f2"
-    },
-    {
-        "version": "0.5.7",
-        "commit": "v0.5.7+commit.6da8b019"
-    },
-    {
-        "version": "0.5.6",
-        "commit": "v0.5.6+commit.b259423e"
-    },
-    (... truncated ...)
-    ```
-  * Select a commit, for example: `v0.5.6+commit.b259423e`
-  * Set the version to that commit: `curl -X POST --data '{"version": "v0.5.8+commit.23d335f2"}' http://localhost:9090/solc -H 'Content-Type: application/json'`
-  * Check what version is loaded: `curl http://localhost:9090/solc`
-
 # Features
 
   * **Now interactive** :star2:: it has a sepparate frontend and API instead of building a static HTML file like in earlier versions

docker-compose.yml

@@ -0,0 +1,22 @@
+version: '3.4'
+
+services:
+  debugger:
+    image: ethereum-graph-debugger
+    build:
+      context: ./
+    environment:
+      - BLOCKCHAIN_HOST=ganache:8545
+    ports:
+      - 9090:9090
+    volumes:
+      - ./src:/opt/app/src:delegated
+      - ./contracts:/opt/app/contracts:delegated
+
+  ganache:
+    image: trufflesuite/ganache-cli:v6.1.6
+    container_name: ganache
+    restart: always
+    command: -l 804247552 -h 0.0.0.0 -d
+    ports:
+      - 8545:8545

package-lock.json

@@ -2,7 +2,7 @@
   "name": "ethereum-graph-debugger",
   "author": "Fernando Garcia",
   "license": "GPL",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "Ethereum graph debugger",
   "main": "dist/run-server.js",
   "scripts": {

package.json

@@ -8,10 +8,10 @@ export class Web3Instance implements IWeb3 {
   constructor(config: Web3Configuration) {
     const isEmpty = Object.values(config).every(x => (!x) || x === '')
     if (isEmpty) {
-      this.web3Instance = new Web3('http://127.0.0.1:8545')  
+      this.web3Instance = new Web3(process.env.BLOCKCHAIN_HOST? `http://${process.env.BLOCKCHAIN_HOST }`:'http://127.0.0.1:8545')  
     } else {
       const protocol = config.blockchainProtocol || 'http'
-      const url = config.blockchainHost || '127.0.0.1:8545'
+      const url = config.blockchainHost || process.env.BLOCKCHAIN_HOST || '127.0.0.1:8545'
       let blockchainUrl = `${protocol}://`
       if (config.blockchainBasicAuthUsername && config.blockchainBasicAuthPassword) {
         blockchainUrl += `${config.blockchainBasicAuthUsername}:${config.blockchainBasicAuthPassword}@`

src/api/blockchain/Web3Instance.ts

@@ -6,6 +6,7 @@ import { logger } from '../../../Logger';
 import { RunContractFunctionRequest } from '../request/RunContractFunctionRequest';
 import { Web3Configuration } from '../../blockchain/Web3Configuration';
 import { DeployContractRequest } from '../request/DeployContractRequest';
+import { StringBodyRequest } from '../request/StringBodyRequest';
 
 @Route('contract')
 @provideSingleton(ContractController)
@@ -17,14 +18,14 @@ export class ContractController extends Controller {
     super()
   }
 
-  @Get('abi')
+  @Post('abi')
   async getAbi(
-    @Query('source') source: string,
+    @Body() source: StringBodyRequest,
     @Query('name') name: string,
     @Query('path') path: string
   ){
     try {
-      const abi = this.contractService.getAbi(name, source, path)
+      const abi = this.contractService.getAbi(name, source.request, path)
       if (!abi) {
         throw new Error(`No abi found for contract ${name}`)
       }
@@ -35,6 +36,24 @@ export class ContractController extends Controller {
     }
   }
 
+  @Post('functions')
+  async getFunctions(
+    @Body() source: StringBodyRequest,
+    @Query('name') name: string,
+    @Query('path') path: string
+  ){
+    try {
+      const functions = this.contractService.getFunctions(name, source.request, path)
+      if (!functions) {
+        throw new Error(`No abi found for contract ${name}`)
+      }
+      return functions
+    } catch (err) {
+      logger.error(err)
+      throw new Error(err.message)
+    }
+  }
+
   @Post('deploy')
   async deploy(
     @Body() deployRequest: DeployContractRequest,

src/api/service/controller/ContractController.ts

@@ -8,7 +8,6 @@ import { GFCResponse } from '../response/CFGResponse'
 import { OperationResponse } from '../response/OperationResponse'
 import { logger } from '../../../Logger'
 import { StringBodyRequest } from '../request/StringBodyRequest';
-const fs = require('fs')
 
 @Route('cfg')
 @provideSingleton(ControlFlowGraphController)
@@ -33,7 +32,6 @@ export class ControlFlowGraphController extends Controller {
         throw new Error('Constructor is true but no constructor found in bytecode')
       }
       const cfg = this.createCFG(contractBlocks, constructor)
-      await fs.writeFileSync('cfg', cfg)
       return this.buildResponse(contractBlocks, constructor, cfg)
     } catch (err) {
       logger.error(err)

src/api/service/controller/ControlFlowGraphController.ts

@@ -16,7 +16,11 @@ export class FileController extends Controller {
   @Get('{dir}')
   async findContractsInDir(@Path() dir: string, @Query('extension') extension: string): Promise<ContractFile[]> {
     try {
-      const contracts = await this.fileService.findContractssWithExtension(dir, extension)
+      let directory = dir
+      if (!dir || dir === '' || dir === ' ') {
+        directory = './contracts'
+      }
+      const contracts = await this.fileService.findContractssWithExtension(directory, extension)
       if (contracts.length === 0) {
         throw new Error(`No contracts found at ${dir} with extension ${extension}`)
       }