Skip to content

Certora/euler-vault-cantina-fv

Repository files navigation

Formal Verification Details

Introduction

The Formal Verification (FV) component of the contest is about using the Certora Prover to formally verify properties in the Solidity smart contracts in scope. Participants are incentivized to implement and verify high coverage properties. Submissions, incentives, and judging are different from the main contest so please read this document in its entirety.

Scope

Contract SLOC
Borrowing.sol 102
Governance.sol 216
Liquidation.sol 116
RiskManager.sol 55
Vault.sol 158

Overview

  • 100,000 USDC of this contest will be allocated for FV.
  • Conventional bug submission, issue judgment, and all reward distribution will be managed by Cantina.
  • FV component is unique as participants are incentivized to implement and verify high coverage properties using the Certora Prover.
  • The judging of FV is conducted by Certora, with different submissions, incentives, and judging processes compared to the standard contest. These processes are explained in this document.

Getting Started

  • Get access to the Prover:
    • First time participants, Register to automatically receive an access key.
  • Update expired key:
  • Tool Installation:
    • Follow installation instructions to download certora-cli. Use the latest version of the tool available at the start of the contest, throughout the whole contest.
  • Learning Resources:
    • Complete the tutorials.
    • Search the docs for any additional information.
    • Check out some of our examples.
  • Contest Participation:
    • Import this repository into a new private repository at the contest's commencement.
    • Conduct verifications on the master branch.
      • You can work in a separate branch and merge changes at the end if you prefer.
    • Grant access to teryanarmen and nd-certora for judging.
  • Support Channels:
    • For tool-related issues, send a detailed message with a job link in help-desk channel in Discord. Remove the anonymousKey component from the link if you wish to limit viewing to Certora employees.
    • For FV contest questions, use the relevant community verification channel in Discord.
  • Certora folder:
    • Certora folder is made up of 5 folders:
      • confs: configuration files for the tool. There is one per contract. More can be added if needed.
      • harnesses: contracts that inherit base contracts to add extra functionality.
      • helpers: additional contracts/mocks needed for verification.
      • mutations: mutants folder which will be used to evaluate specs.
      • specs: specification used to verify the smart contracts.

Incentives

  • 100,000k of the total pool is allocated for FV.
  • FV pool is split into three categories
    • Participation: 10% of pool awarded for properties identifying public mutants.
    • Real Bugs: 20% of pool awarded for properties uncovering actual bugs.
    • Coverage: 70% of pool awarded for properties identifying private mutants.
  • If no properties are accepted for real bugs, the pool will be rebalanced to 90% coverage and 10% participation.
  • Mutants are mutated versions of the original code which create vulnerabilities. These mutants are used to gauge verified properties' coverage of the original code.
    • Public mutants used for evaluating participation rewards can be found in certora/mutations.
  • Participation and coverage reward can be calculated as follows
    • Each mutant is worth $0.9^{n-1}$ points where $n$ is the number of participants that caught the mutant.
    • If we let $P$ be the total FV pool and $T$ be the sum of all mutants' points, we can define each participant's reward as $ \frac{P}{T} \cdot \frac{0.9^{n-1}}{n} $
  • Real bug rewards will be awarded for properties that are violated because of the bug. Only the bug submitter can submit a spec for that bug. 10, 3, or 1 points will be allocated based on the severity of the bug (H/M/L).

Submission Guidelines

  • Submission:

    • Submit your work by sharing the private repo you cloned with teryanarmen and nd-certora on github.
    • Properties for real bugs will be submitted as github issues on the same private repo and must contain a link to the normal bug submission through Cantina marked with relevant severity (L/M/H).
    • Submissions will not be public and will only be shared with the committee by sharing your private repo on github.
  • Development Constraints:

    • Participants are allowed to create and modify configuration, harnesses, and specification files.
      • Some conf files have commented out settings which can be used to help with running time.
    • All coverage and participation submissions must pass on the unaltered original codebase.
    • Source code modifications are prohibited.
      • Evaluations are based on the original code; configurations reliant on code changes will be disregarded.
    • Utilize the latest version of certoraRun available at contest start.
      • Avoid updates during the contest, even if new versions are released.
      • Only update if explicitly told to by Certora team.
    • Submissions with tool errors, compilation errors, or timing-out rules will not be considered.
      • Ensure configurations do not time out; retest to confirm consistency.
  • Configuration Naming:

    • For coverage and participation: Name configuration files as ContractName_[identifier]_verified.conf. The identifier is optional and should be used when multiple configurations are created for one contract.
      • Example: ERC20_minting_rules_verified.conf.
    • For real bugs: Replace _verified with _violated in the configuration file name.
  • Real bug submissions:

    • Real bug submissions must include:
      • A link to the accepted underlying issue submitted through Cantina.
      • Explaination of the property that finds the bug.
      • A link to a violated run of the property must be included.
      • A proposed solution as a diff between the buggy and fixed code.
      • A verified run of the property on the fixed version must be included.

Evaluation Process

  • Preliminary Results: Initial findings will be announced along with the mutations used for evaluation. A google sheet showing which mutants were caught by which participants will be shared. Participants will have a 72-hour period for review and submit corrections in case a certain mutant is marked as not caught but they actually caught it.
  • Correction Submissions: Corrections must include a verified run on the source code and a violated run on the mutant. Any changes other than the mutation will result in exclusion of the correction.
  • Check your work: Use certoraMutate to evaluate your work on public mutations and random mutations created by gambit.
    • mutation configuration is part of the main config file. To run mutation testing, you can do certoraMutate certora/confs/contract_verified.conf from root of the directory, same as certoraRun.
    • You can change the number of bugs that are injected by adding manual mutations in the mutations folder in a similar fashion to the public mutations or by changing the value of automatic mutation in the contract's conf.

Report Compilation

  • Public Disclosure: The report, encompassing top submissions and mutation descriptions, will be made public post-analysis.
    • Not all top properties focus on the quantity of mutations caught; high-level invariants are highly valued.
      • Future mutations will be adjusted to properly value high quality properties.
    • Guidelines for superior specifications:
      • Avoid code duplication.
      • Eschew simplistic unit tests.
      • Limit excessive assertions.
      • Focus on concise, high-level properties.
      • Reduce overuse of require statements.
      • Ensure clear documentation, proper naming, and formatting.
  • Participant Contributions: The top participants' certora folders will be included in the public repository.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages