Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Smart Vault: Implement prover rules #103

Merged
merged 17 commits into from
Oct 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/prover-authorizer.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Prover
name: Prover Authorizer

env:
CI: true
Expand Down
23 changes: 23 additions & 0 deletions .github/workflows/prover-smart-vault.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Prover Smart Vault

env:
CI: true

on:
pull_request:
branches: "*"
paths:
- packages/smart-vault/**

jobs:
prove:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Prove
uses: ./.github/actions/certora
with:
workspace: '@mimic-fi/v3-smart-vault'
certora-key: ${{ secrets.CERTORA_KEY }}
github-token: ${{ secrets.GITHUB_TOKEN }}
38 changes: 38 additions & 0 deletions packages/smart-vault/certora/conf/smart-vault.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"files": [
"contracts/SmartVault.sol",
"../../packages/authorizer/contracts/Authorizer.sol",
"../../packages/fee-controller/contracts/FeeController.sol",
"../../packages/helpers/contracts/mocks/WrappedNativeTokenMock.sol",
"../../packages/registry/contracts/Registry.sol",
"certora/helpers/Helpers.sol"
],
"verify": "SmartVault:certora/specs/SmartVault.spec",
"link": [
"SmartVault:authorizer=Authorizer",
"SmartVault:registry=Registry",
"SmartVault:feeController=FeeController",
"SmartVault:wrappedNativeToken=WrappedNativeTokenMock"
],
"loop_iter": "4",
"rule_sanity": "basic",
"send_only": true,
"optimistic_hashing": true,
"prover_args": [
"-copyLoopUnroll 8",
"-optimisticFallback true"
],
"optimistic_loop": true,
"packages": [
"@mimic-fi/v3-authorizer=../../node_modules/@mimic-fi/v3-authorizer",
"@mimic-fi/v3-fee-controller=../../node_modules/@mimic-fi/v3-fee-controller",
"@mimic-fi/v3-helpers=../../node_modules/@mimic-fi/v3-helpers",
"@mimic-fi/v3-price-oracle=../../node_modules/@mimic-fi/v3-price-oracle",
"@mimic-fi/v3-registry=../../node_modules/@mimic-fi/v3-registry",
"@openzeppelin=../../node_modules/@openzeppelin",
"solmate=../../node_modules/solmate"
],
"solc_allow_path": ".",
"process": "emv",
"msg": "SmartVault"
}
38 changes: 38 additions & 0 deletions packages/smart-vault/certora/helpers/Helpers.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// SPDX-License-Identifier: GPL-3.0-or-later

pragma solidity ^0.8.0;

import '@mimic-fi/v3-authorizer/contracts/interfaces/IAuthorizer.sol';
import '@mimic-fi/v3-helpers/contracts/utils/Denominations.sol';
import '@mimic-fi/v3-helpers/contracts/utils/ERC20Helpers.sol';

contract Helpers {
function NATIVE_TOKEN() external pure returns (address) {
return Denominations.NATIVE_TOKEN;
}

function balanceOf(address token, address account) external view returns (uint256) {
return ERC20Helpers.balanceOf(token, account);
}

function authParams(address p1, address p2, uint256 p3) external pure returns (uint256[] memory r) {
r = new uint256[](3);
r[0] = uint256(uint160(p1));
r[1] = uint256(uint160(p2));
r[2] = p3;
}

function authParams(address p1) external pure returns (uint256[] memory r) {
r = new uint256[](1);
r[0] = uint256(uint160(p1));
}
lgalende marked this conversation as resolved.
Show resolved Hide resolved

function getPermissionParamsLength(address authorizer, address who, address where, bytes4 what)
external
view
returns (uint256)
{
IAuthorizer.Param[] memory permissionParams = IAuthorizer(authorizer).getPermissionParams(who, where, what);
return permissionParams.length;
}
}
34 changes: 34 additions & 0 deletions packages/smart-vault/certora/specs/General.spec
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// SANITY

rule sanity(method f) good_description "Sanity" {
env e;
calldataarg args;
f(e, args);
assert false;
}

// REENTRANCY GUARD

ghost uint256 ghostReentrancyStatus;

ghost mathint ghostReentrancyChangedTimes;

hook Sload uint256 status currentContract._status STORAGE {
require ghostReentrancyStatus == status;
}

hook Sstore currentContract._status uint256 newStatus STORAGE {
ghostReentrancyChangedTimes = ghostReentrancyChangedTimes + 1;
}

rule
reentrancyGuard(env e, method f, calldataarg args) filtered { f -> !f.isView }
good_description "Ensure external methods cannot be reentered"
{
require ghostReentrancyChangedTimes == 0;

f(e, args);

bool hasChangedTwice = ghostReentrancyChangedTimes == 2;
assert hasChangedTwice;
}
Loading
Loading