dorucioclea / aave-permissions-book

Tool to index and visualise all the permissions on the whole Aave smart contracts ecosystem

Aave Permissions Book

Tool to index and visualise all the permissions on the whole Aave smart contracts ecosystem.

Table of contents

• Description
• Permissions
• Usage
• License

Description

The Aave Protocol smart contracts require different permissions to execute its different methods. These permissions are also hold by different addresses, being other smart contracts, EOAs or multi-sigs. This repository contains and easy directory of tables showing which permissions are needed to execute the functions of the different contracts conforming the Aave Protocol, and the owners of said permissions.

Permissions

A permissions document has been created for every pool of every network where the Aave Protocol has been deployed. These documents contain tables with the following information:

• Contracts: This table has information about the contracts of the Aave protocol.
  • contract: Name of the contract.
  • proxyAdmin: If the contract follows the Proxy Pattern, it will show the proxyAdmin address. The proxyAdmin has permissions to upgrade the implementation.
  • modifier: Name of the gate method that controls who can call a function. There is an entry for every modifier that a contract has.
  • permission owner: Name of the contract that holds the permission to call the modifier.
  • functions: Name of the functions of the contract that are gated by the modifier.
• Guardians: This table holds the list of addresses with permissions to call certain methods, excluding those of the Aave governance. Normally a Guardian is a multi-sig with permission to call some methods, following a mandate from the Aave governance.
• Roles: This table enumerates the different roles that a protocol can have, and the contracts who have that role. A role has permissions to call certain functions gated by modifiers.

Permissions directory

Network	System type	Tables
MAINNET	V3	Permissions
MAINNET	GHO	Permissions
MAINNET	GOV_V2	Permissions
MAINNET	V2	Permissions
MAINNET	V2_ARC	Permissions
MAINNET	V2_AMM	Permissions
MAINNET	SAFETY_MODULE	Permissions
MAINNET	V2_MISC	Permissions
OPTIMISM	V3	Permissions
BINANCE	V3	Permissions
GNOSIS	V3	Permissions
POLYGON	V3	Permissions
POLYGON	V2	Permissions
FANTOM_OPERA	V3	Permissions
METIS_ANDROMEDA	V3	Permissions
BASE	V3	Permissions
ARBITRUM_ONE	V3	Permissions
AVALANCHE	V3	Permissions
AVALANCHE	V2	Permissions
SCROLL	V3	Permissions

Usage

To generate the permissions json, and the subsequent permissions tables:

Installation

  npm install
  cp .env.example .env // this will copy the example .env to the actual .env

Scripts

To generate the permissions json, execute:

  npm run modifiers:generate

To generate the permissions tables, execute:

  npm run tables:create

License

This repository is under MIT License