Class CompilationUnit

constructor

• new CompilationUnit(projectName, ast, imports, functions, contracts, callGraph): CompilationUnit

• Creates an instance of CompilationUnit.

  Parameters

  • projectName: ProjectName

    The name of the project this Compilation Unit belongs to.
  • ast: TactASTStore

    The AST of the project.
  • imports: ImportGraph

    A graph showing the connections between project files.
  • functions: Map<CFGIdx, CFG>

    A mapping from unique IDs of free functions to their CFGs.
  • contracts: Map<ContractIdx, Contract>

    A mapping from unique IDs of contract entries to contracts.
  • callGraph: CallGraph

  Returns CompilationUnit

ast

callGraph

contracts

functions

imports

projectName

findCFGByIdx

• findCFGByIdx(idx): undefined | CFG

• Looks for a CFG with a specific index.

  Parameters

  • idx: CFGIdx

  Returns undefined | CFG

  Found CFG or undefined if not found.

findFunctionCFGByName

• findFunctionCFGByName(name): undefined | CFG

• Looks for a CFG for a function node with a specific name.

  Parameters

  • name: FunctionName

  Returns undefined | CFG

  Found CFG or undefined if not found.

findMethodCFGByName

• findMethodCFGByName(contractName, methodName): undefined | CFG

• Looks for a CFG for a method node with a specific name.

  Parameters

  • contractName: ContractName
  • methodName: FunctionName

  Returns undefined | CFG

  Found CFG or undefined if not found.

foldCFGs

• foldCFGs<T>(init, callback): T

• Performs a fold operation over all CFGs in the Compilation Unit.

  Type Parameters

  • T

  Parameters

  • init: T

    The initial value of the accumulator.
  • callback: ((acc: T, cfg: CFG) => T)

    A function that takes the current accumulator and a CFG, and returns a new accumulator value.

    • • (acc, cfg): T

      • Parameters

        • acc: T
        • cfg: CFG

        Returns T

  Returns T

  The final accumulated value.

forEachBasicBlock

• forEachBasicBlock(astStore, callback): void

• Iterates over all CFGs in a Compilation Unit, and applies a callback to each basic block in every CFG.

  Parameters

  • astStore: TactASTStore

    The store containing the AST nodes.
  • callback: ((cfg: CFG, node: BasicBlock, stmt: AstStatement) => void)

    The function to apply to each BB within each CFG.

    • • (cfg, node, stmt): void

      • Parameters

        • cfg: CFG
        • node: BasicBlock
        • stmt: AstStatement

        Returns void

  Returns void

forEachCFG

• forEachCFG(callback, __namedParameters?): void

• Iterates over all CFGs in a Compilation Unit, and applies a callback to CFG.

  Parameters

  • callback: ((cfg: CFG) => void)

    The function to apply to each CFG.

    • • (cfg): void

      • Parameters

        • cfg: CFG

        Returns void

  • __namedParameters: Partial<{
        includeStdlib: boolean;
    }> = {}

  Returns void