Skip to content

Commit ff8fe5e

Browse files
authored
Merge pull request #109 from bgd-labs/fix/make-ready-for-migration-to-aave-dao
fix: update readme with current networks
2 parents efaa21c + b658e7f commit ff8fe5e

37 files changed

+350
-414
lines changed

.github/workflows/CONTRIBUTING.ms

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to the Aave Delivery Infrastructure! Please take a moment to review this document **before submitting a pull request.**
4+
5+
## Rules
6+
7+
1. Significant changes to the Protocol must be reviewed before a Pull Request is created. Create a [Feature Request](https://github.com/aave-dao/aave-delivery-infrastructure/issues) first to discuss your ideas.
8+
2. Contributors must be humans, not bots.
9+
3. First time contributions must not contain only spelling or grammatical fixes.
10+
11+
## Basic guide
12+
13+
This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow.
14+
15+
1. [Forking the repository](#forking-the-repository)
16+
2. [Installing Foundry](#installing-foundry)
17+
4. [Installing dependencies](#installing-dependencies)
18+
5. [Running the test suite](#running-the-test-suite)
19+
7. [Submitting a pull request](#submitting-a-pull-request)
20+
8. [Versioning](#versioning)
21+
22+
---
23+
24+
### Forking the repository
25+
26+
To start contributing to the project, [fork it](https://github.com/aave-dao/aave-delivery-infrastructure/fork) to your private github account.
27+
28+
Once that is done, you can clone your forked repository to your local machine.
29+
```bash
30+
# https
31+
git clone https://github.com/<user>/aave-delivery-infrastructure.git
32+
# ssh
33+
git clone git@github.com:<user>/aave-delivery-infrastructure.git
34+
```
35+
36+
To stay up to date with the main repository, you can add it as a remote.
37+
```bash
38+
# https
39+
git remote add upstream https://github.com/aave-dao/aave-delivery-infrastructure.git
40+
# ssh
41+
git remote add upstream git@github.com:aave-dao/aave-delivery-infrastructure.git
42+
```
43+
44+
---
45+
46+
### Installing foundry
47+
48+
Aave Delivery Infrastructure is a [Foundry](https://github.com/foundry-rs/foundry) project.
49+
50+
Install foundry using the following command:
51+
52+
```bash
53+
curl -L https://foundry.paradigm.xyz | bash
54+
```
55+
56+
---
57+
58+
### Installing dependencies
59+
60+
For generating the changelog, linting and testing, we rely on some additional node packages. You can install them by running:
61+
62+
```bash
63+
npm install
64+
```
65+
66+
---
67+
68+
### Running the test suite
69+
70+
For running the default test suite you can use the following command:
71+
72+
```bash
73+
forge test
74+
```
75+
76+
---
77+
78+
### Submitting a pull request
79+
80+
When you're ready to submit a pull request, you can follow these naming conventions:
81+
82+
- Pull request titles use the [Imperative Mood](https://en.wikipedia.org/wiki/Imperative_mood) (e.g., `Add something`, `Fix something`).
83+
- [Changesets](#versioning) use past tense verbs (e.g., `Added something`, `Fixed something`).
84+
85+
When you submit a pull request, GitHub will automatically lint, build, and test your changes. If you see an ❌, it's most likely a bug in your code. Please, inspect the logs through the GitHub UI to find the cause.
86+
87+
- Pull requests must always cover all the changes made with tests. If you're adding a new feature, you must also add a test for it. If you're fixing a bug, you must add a test that reproduces the bug. Pull requests that cause a regression in test coverage will not be accepted.
88+
- Pull requests that touch code functionality should always include updated gas snapshots. Running `forge test` will update the snapshots for you.
89+
- Make sure that your updates are fitting within the existing code margin. You can check by running `forge build --sizes`
90+
91+
---

.github/workflows/certora-review-controller.yml

Lines changed: 0 additions & 56 deletions
This file was deleted.

.github/workflows/certora-review-forwarder.yml

Lines changed: 0 additions & 60 deletions
This file was deleted.

.github/workflows/certora-review-receiver.yml

Lines changed: 0 additions & 56 deletions
This file was deleted.
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: certora
2+
3+
concurrency:
4+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
5+
cancel-in-progress: true
6+
7+
on:
8+
pull_request:
9+
branches:
10+
- '*'
11+
push:
12+
branches:
13+
- main
14+
15+
workflow_dispatch:
16+
17+
jobs:
18+
verify:
19+
runs-on: ubuntu-latest
20+
if:
21+
github.event.pull_request.head.repo.full_name == github.repository || (github.event_name == 'push' &&
22+
github.ref == format('refs/heads/{0}', github.event.repository.default_branch))
23+
permissions:
24+
contents: read
25+
statuses: write
26+
pull-requests: write
27+
id-token: write
28+
steps:
29+
- uses: actions/checkout@v4
30+
with:
31+
submodules: recursive
32+
33+
- name: Munged
34+
run: |
35+
cd security/certora
36+
touch applyHarness.patch
37+
make munged
38+
39+
- uses: Certora/certora-run-action@v2
40+
with:
41+
cli-version: 7.31.2
42+
configurations: |-
43+
security/certora/confs/verifyCrossChainForwarder-envelopRetry.conf
44+
security/certora/confs/verifyCrossChainForwarder-invariants.conf
45+
security/certora/confs/verifyCrossChainForwarder-newEnvelope.conf
46+
security/certora/confs/verifyCrossChainForwarder-sanity.conf
47+
security/certora/confs/verifyCrossChainForwarder-simpleRules.conf
48+
security/certora/confs/verifyCrossChainForwarder-encode-decode-correct.conf --rule encode_decode_well_formed_TX
49+
security/certora/confs/verifyCrossChainForwarder-shuffle.conf
50+
security/certora/confs/verifyCrossChainReceiver.conf
51+
security/certora/confs/verifyCrossChainControllerWithEmergency.conf
52+
solc-versions: 0.8.20
53+
comment-fail-only: false
54+
solc-remove-version-prefix: "0."
55+
job-name: "Certora Prover Run"
56+
certora-key: ${{ secrets.CERTORAKEY }}
57+
install-java: true
58+
env:
59+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
60+

.github/workflows/comment.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: PR Comment
2+
3+
on:
4+
workflow_run:
5+
# The workflow generating the artifacts
6+
workflows: [Test]
7+
types:
8+
- completed
9+
10+
permissions:
11+
actions: read
12+
issues: write
13+
checks: read
14+
statuses: read
15+
pull-requests: write
16+
17+
jobs:
18+
comment:
19+
uses: bgd-labs/github-workflows/.github/workflows/comment.yml@main
20+
secrets:
21+
# the provided PAT needs write and write permissions on issues and pull requests
22+
# the PAT is only really needed when commenting of prs from forks
23+
READ_ONLY_PAT: ${{ secrets.READ_ONLY_PAT }}

0 commit comments

Comments
 (0)