Merge remote-tracking branch 'origin/main' into certora

.env.example

@@ -22,6 +22,7 @@ RPC_ZKEVM=https://zkevm-rpc.com
 RPC_GNOSIS=https://rpc.ankr.com/gnosis
 RPC_BNB=https://binance.llamarpc.com
 RPC_SCROLL=https://rpc.scroll.io
+RPC_AMOY="https://rpc-amoy.polygon.technology"
 
 # Etherscan api keys for verification & download utils
 ETHERSCAN_API_KEY_MAINNET=
@@ -35,6 +36,7 @@ ETHERSCAN_API_KEY_ZKEVM=
 ETHERSCAN_API_KEY_GNOSIS=
 ETHERSCAN_API_KEY_BNB=
 ETHERSCAN_API_KEY_SCROLL=
+ETHERSCAN_API_KEY_CELO=
 
 # Simulation/fork creation
 TENDERLY_ACCESS_TOKEN=

.github/workflows/certora.yml

@@ -18,6 +18,9 @@ on:
 jobs:
   verify:
     runs-on: ubuntu-latest
+    if:
+      github.event.pull_request.head.repo.full_name == github.repository || (github.event_name == 'push' &&
+      github.ref == format('refs/heads/{0}', github.event.repository.default_branch))
 
     steps:
       - uses: actions/checkout@v4

.github/workflows/comment.yml

@@ -17,6 +17,9 @@ jobs:
   comment:
     name: Comment Bot
     runs-on: ubuntu-latest
+    # workflow run triggeres on all types of "completed" including "cancelled" and similar
+    # we want this action to only run on a success & failure though
+    if: ${{ github.event.workflow_run.conclusion == 'success' || github.event.workflow_run.conclusion == 'failure' }}
     steps:
       - uses: actions/download-artifact@v4
         with:

.gitignore

@@ -5,6 +5,9 @@ out/
 # general
 .env
 .env.bk
+.assets
+
+# artifacts
 reports/
 diffs/
 downloads/

LICENSE

@@ -21,7 +21,7 @@ Additional Use Grant: You are permitted to use, copy, and modify the Licensed Wo
                         software protocols and applications approved by the Aave governance, including all
                         those produced within compensated service provider engagements with the Aave DAO.
                         The Aave DAO is able to waive this requirement for one or more third-parties, if and
-                        only if explicitly indicating it on a record 'authorizations' on govv3.aavelicense.eth.
+                        only if explicitly indicating it on a record 'authorizations' on v31.aavelicense.eth.
                       - You are neither an individual nor a direct or indirect participant in any incorporated
                         organization, DAO, or identifiable group, that has deployed in production any original
                         or derived software ("fork") of the Aave ecosystem for purposes competitive to Aave,

README.md

@@ -1,6 +1,6 @@
 # Aave V3.1 Origin
 
-![Aave v3.1 Origin_banner](./v3-1-banner.jpeg)
+![Aave v3.1 Origin_banner](./resources/v3-1-banner.jpeg)
 
 Aave v3.1 complete codebase, Foundry-based.
 
@@ -39,9 +39,10 @@ bun install
 
 ## Documentation
 
-- [Aave v3 technical Paper](./techpaper/Aave_V3_Technical_Paper.pdf)
+- [Aave v3 technical Paper](./docs/Aave_V3_Technical_Paper.pdf)
 - [v3 to v3.0.2 production upgrade](https://github.com/bgd-labs/proposal-3.0.2-upgrade/blob/main/README.md)
 - [Aave v3.1 features](./docs/Aave-v3.1-features.md)
+- [Set Ltv to 0 on Freeze Feature State diagram](./docs/freeze-ltv0-states.png)
 
 <br>
 
@@ -83,6 +84,7 @@ The following are the security procedures historically applied to Aave v3.X vers
 - [Certora](./audits/30-04-2024_Certora_AaveV3.1.pdf)
 - [MixBytes](./audits/02-05-2024_MixBytes_AaveV3.1.pdf)
 - An internal review by [SterMi](https://twitter.com/stermi) on the virtual accounting feature was conducted on an initial phase of the codebase.
+- [Cantina competition report](./audits/02-06-2024-Cantina-contest-AaveV3.1.pdf)
 - Additionally, Certora properties have been improved over time since the Aave v3 release. More details [HERE](./certora/README.md).
 
 <br>

foundry.toml

@@ -31,6 +31,7 @@ fantom_testnet = "${RPC_FANTOM_TESTNET}"
 harmony = "${RPC_HARMONY}"
 sepolia = "${RPC_SEPOLIA}"
 mumbai = "${RPC_MUMBAI}"
+amoy = "${RPC_AMOY}"
 bnb_testnet = "${RPC_BNB_TESTNET}"
 bnb = "${RPC_BNB}"
 gnosis = "${RPC_GNOSIS}"
@@ -45,8 +46,9 @@ arbitrum={key="${ETHERSCAN_API_KEY_ARBITRUM}",chainId=42161}
 fantom={key="${ETHERSCAN_API_KEY_FANTOM}",chainId=250}
 scroll={key="${ETHERSCAN_API_KEY_SCROLL}",chainId=534352, url='https://api.scrollscan.com/api\?'}
 celo={key="${ETHERSCAN_API_KEY_CELO}",chainId=42220}
-sepolia={key="${ETHERSCAN_API_KEY_SEPOLIA}",chainId=11155111}
-mumbai={key="${ETHERSCAN_API_KEY_MUMBAI}",chainId=11155111}
+sepolia={key="${ETHERSCAN_API_KEY_MAINNET}",chainId=11155111}
+mumbai={key="${ETHERSCAN_API_KEY_POLYGON}",chainId=80001}
+amoy={key="${ETHERSCAN_API_KEY_POLYGON}",chainId=80002}
 bnb_testnet={key="${ETHERSCAN_API_KEY_BNB}",chainId=97,url='https://api-testnet.bscscan.com/api'}
 bnb={key="${ETHERSCAN_API_KEY_BNB}",chainId=56,url='https://api.bscscan.com/api'}
 base={key="${ETHERSCAN_API_KEY_BASE}",chain=8453}