improved CFG and added legend

Author: fergarrui

src/api/bytecode/EVMDisassembler.ts

@@ -112,7 +112,10 @@ export class EVMDisassembler implements Disassembler {
   }
 
   static removeMetadata(bytecode: string): string {
-    const splittedBytecode: string[] = bytecode.split(EVMDisassembler.metadataPrefix)
+    let splittedBytecode: string[] = bytecode.split(EVMDisassembler.metadataPrefix)
+    if (splittedBytecode.length < 2) {
+      splittedBytecode = bytecode.split(EVMDisassembler.metadataPrefix.toUpperCase())
+    }
     if (splittedBytecode.length < 2) {
       return bytecode
     }

src/api/bytecode/Opcodes.ts

@@ -153,7 +153,7 @@ export class Opcodes {
   }
 
   static isJump(op: Opcode) {
-    return op.name.startsWith('JUMP')
+    return op.name.startsWith('JUMP') && op.name !== 'JUMPDEST'
   }
 
   static isJumpOp(op: string) {

src/api/cfg/CFGBlocks.ts

@@ -22,7 +22,7 @@ export class CFGBlocks {
   }
 
   keys(): number[] {
-    return Object.keys(this.blocks).map(e => parseInt(e))
+    return Object.keys(this.blocks).map(e => parseFloat(e))
   }
 
   values(): OperationBlock[][] {

src/api/cfg/GraphVizService.ts

@@ -11,10 +11,22 @@ export class GraphVizService {
       graph [splines=ortho ranksep="2" nodesep="2"]
       rankdir=LR
       node [shape=plain fillcolor="#2A2A2A" style=filled fontname="Courier"]
+      ${this.createLegend()}
       ${this.buildBody(blocks, trace)}
     }`
   }
 
+  private createLegend() {
+    return `
+    subgraph cluster_legend {
+      label="Legend";
+      legend1 [label=< <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4"><TR><TD COLSPAN="3"><font color="#ffffff">Not run in transaction</font></TD></TR><TR><TD><font color="#12cc12">0x3f</font></TD><TD ID="3f" HREF=" "><font color="#12cc12">JUMPDEST</font></TD></TR></TABLE> >]
+      legend2 [label=< <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4"><TR><TD COLSPAN="3"><font color="#ffffff">Run in transaction</font></TD></TR><TR><TD><font color="#ff1020">0x0</font></TD><TD><font color="#ff1020">PUSH1</font></TD><TD><font color="#ff1020">0x80</font></TD></TR></TABLE> >]
+      legend3 [label=< <TABLE BORDER="0" CELLBORDER="1" CELLSPACING="0" CELLPADDING="4"><TR><TD COLSPAN="3"><font color="#ffffff">Run in transaction</font></TD></TR><TR><TD COLSPAN="3"><font color="#ffffff">Belongs to a loop</font></TD></TR><TR><TD><font color="#CD950C">0x3f</font></TD><TD ID="3f" HREF=" "><font color="#CD950C">JUMPDEST</font></TD></TR></TABLE> >]
+    }
+    `
+  }
+
   private buildBody(blocks: CFGBlocks, trace: DebugTrace): string {
     let body: string = ''
     blocks.keys().forEach(key => {

src/api/cfg/OperationBlock.ts

@@ -4,5 +4,6 @@ export interface OperationBlock {
   offset: number
   operations: Operation[]
   childA?: number
-  childB?: number
+  childB?: number,
+  repeated?: number
 }

src/api/service/controller/DebuggerController.ts

@@ -58,6 +58,7 @@ export class DebuggerController extends Controller {
       blocks = contractBlocks.contractConstructor.blocks
     }
     this.cfgService.completeCFGWithTrace(blocks, trace)
+    this.cfgService.checkTraceLoops(blocks, trace)
     return this.graphVizService.createDotFromBlocks(blocks, trace)
   }
 

src/api/service/service/CFGService.ts

@@ -48,6 +48,26 @@ export class CFGService {
     }
   }
 
+  checkTraceLoops(blocks: CFGBlocks, trace: DebugTrace) {
+    const logs = trace.result.structLogs
+    const count = this.count(logs.map(l => l.pc))
+    const repeated: any = Object.keys(count).filter(key => count[key] > 1).map( key=> { return {offset: key, repeated: count[key]}})
+    for (const repeatedOffset of repeated) {
+      console.log(`trying to find block ${repeatedOffset.offset}`)
+      const block = blocks.get(repeatedOffset.offset)
+      if (block) {
+        console.log('block found')
+        block.repeated = repeatedOffset.repeated
+      }
+    }
+  }
+
+  private count(logs): any[] {
+    return logs.reduce((a, b) => ({ ...a,
+      [b]: (a[b] || 0) + 1
+    }), {})
+  }
+
   private populateMissingBranch(block: OperationBlock, blocks: CFGBlocks, stack: string[], op: string) {
     if (op === 'JUMP') {
       const dest = stack[stack.length-1]

src/api/service/service/TransactionServiceImpl.ts

@@ -90,7 +90,7 @@ export class TransactionServiceImpl implements TransactionService {
     if (cleanDeployedBytecode.length % 2 !== 0) {
       cleanDeployedBytecode = cleanDeployedBytecode.substr(0, cleanDeployedBytecode.length-1)
     }
-    if (cleanBytecode === cleanDeployedBytecode) {
+    if (cleanBytecode.toUpperCase() === cleanDeployedBytecode.toUpperCase() || (!cleanDeployedBytecode || cleanDeployedBytecode === '0x')) {
       return this.buildTrace(trace, trace.result.structLogs.filter(log => log.depth === 0))
     }
     const allCalls = trace.result.structLogs.filter(log => this.isCall(log.op))