Configuration Guide

This document provides the guide to write a correct configuration file for HighGuard. For a fully written configuration file look at this config file.

Organization

Configuration YAML file consists of three parts:

• contracts
• tests
• environments

Contracts Configuration Section

contracts:
  - name: "MultiStageAuction"
    constructorParamSpecs: # A list of constructor parameters for this contract
      - name: "_sender"
        type: "address"
        sourceType: "dynamic" # Whether this value should be set statically based what we pass from configs or dynamically retrieved during monitor runtime.
        source: # The dynamic source information
          type: "EOA"
      - name: "_receiver"
        type: "address"
        sourceType: "dynamic"
        source:
          type: "EOA"
      - name: "_delayUntilRelease"
        type: "uint"
        sourceType: "static"
        value: 0 # If the source is static, value should be passed.

    models:
      - name: "ModelName"
        id: "1701049" # The id of the model from DCRGraphs.net service
    tests: 
      - "ExploitIdentifier" # The id of test/exploit used to retrieve from the `tests` part of config