chore(ci): add certora CI integration (#40)

This commit is contained in:
r4bbit 2023-12-11 15:10:41 +01:00 committed by GitHub
parent d9a64559a2
commit cf7a8b6574
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 70 additions and 1 deletions

View File

@ -10,3 +10,4 @@ Ensure you completed **all of the steps** below before submitting your pull requ
- [ ] Ran `forge snapshot`? - [ ] Ran `forge snapshot`?
- [ ] Ran `pnpm lint`? - [ ] Ran `pnpm lint`?
- [ ] Ran `forge test`? - [ ] Ran `forge test`?
- [ ] Ran `pnpm verify`?

View File

@ -10,6 +10,7 @@ on:
push: push:
branches: branches:
- "main" - "main"
- "develop"
jobs: jobs:
lint: lint:
@ -117,3 +118,51 @@ jobs:
run: | run: |
echo "## Coverage result" >> $GITHUB_STEP_SUMMARY echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY
verify:
needs: ["lint", "build"]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
- name: Install Python
uses: actions/setup-python@v2
with: { python-version: 3.9 }
- name: Install Java
uses: actions/setup-java@v1
with: { java-version: "11", java-package: jre }
- name: Install Certora CLI
run: pip3 install certora-cli==5.0.5
- name: Install Solidity
run: |
wget https://github.com/ethereum/solidity/releases/download/v0.8.19/solc-static-linux
chmod +x solc-static-linux
sudo mv solc-static-linux /usr/local/bin/solc
- name: "Install Pnpm"
uses: "pnpm/action-setup@v2"
with:
version: "8"
- name: "Install Node.js"
uses: "actions/setup-node@v3"
with:
cache: "pnpm"
node-version: "lts/*"
- name: "Install the Node.js dependencies"
run: "pnpm install"
- name: Verify rules
run: "pnpm verify"
env:
CERTORAKEY: ${{ secrets.CERTORAKEY }}
strategy:
fail-fast: false
max-parallel: 16

2
.gitignore vendored
View File

@ -22,3 +22,5 @@ artifacts
typechain typechain
typechain-types typechain-types
gmx-contracts gmx-contracts
.certora_internal

12
certora/certora.conf Normal file
View File

@ -0,0 +1,12 @@
{
"files": ["contracts/StakeManager.sol"],
"msg": "Verifying StakeManager.sol",
"rule_sanity": "basic",
"verify": "StakeManager:certora/specs/StakeManager.spec",
"wait_for_results": "all",
"packages": [
"@openzeppelin=lib/openzeppelin-contracts"
]
}

View File

@ -0,0 +1,4 @@
rule shouldPass {
assert true;
}

View File

@ -20,7 +20,8 @@
"scripts": { "scripts": {
"clean": "rm -rf cache out", "clean": "rm -rf cache out",
"lint": "pnpm lint:sol && pnpm prettier:check", "lint": "pnpm lint:sol && pnpm prettier:check",
"lint:sol": "forge fmt --check && pnpm solhint {script,src,test}/**/*.sol", "verify": "certoraRun certora/certora.conf",
"lint:sol": "forge fmt --check && pnpm solhint {script,src,test,certora}/**/*.sol",
"prettier:check": "prettier --check **/*.{json,md,yml} --ignore-path=.prettierignore", "prettier:check": "prettier --check **/*.{json,md,yml} --ignore-path=.prettierignore",
"prettier:write": "prettier --write **/*.{json,md,yml} --ignore-path=.prettierignore" "prettier:write": "prettier --write **/*.{json,md,yml} --ignore-path=.prettierignore"
} }