-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
213 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,5 @@ | ||
| RPC_URL= | ||
| PRIVATE_KEY= | ||
| ETHERSCAN_API_KEY= | ||
| INFURA_KEY= | ||
| ETHERSCAN_API_KEY= | ||
| POLYGONSCAN_API_KEY= | ||
| POLYGONSCAN_ZKEVM_API_KEY= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,142 @@ | ||
| # Contributing | ||
|
|
||
| - [Install](#install) | ||
| - [Pre-commit Hooks](#pre-commit-hooks) | ||
| - [Branching](#branching) | ||
| - [Versioning](#versioning) | ||
| - [Code Practices](#code-practices) | ||
| - [Testing](#testing) | ||
| - [Deployment](#deployment) | ||
| - [Deployment Info Generation](#deployment-info-generation) | ||
| - [Deployment Template Script](#deployment-template-script) | ||
| - [Releases](#releases) | ||
|
|
||
| ## Install | ||
|
|
||
| To ensure consistency in our formatting we use `pre-commit` to check whether code was formatted properly and the documentation is up to date. On pull requests the CI checks whether all pre-commit hooks were run correctly. | ||
| Follow these steps to set up your local environment for development: | ||
|
|
||
| - [Install foundry](https://book.getfoundry.sh/getting-started/installation) | ||
| - Install dependencies: `forge install` | ||
| - [Install pre-commit](https://pre-commit.com/#post-commit) | ||
| - Install pre commit hooks: `pre-commit install` | ||
|
|
||
| ## Pre-commit Hooks | ||
|
|
||
| Follow the [installation steps](#install) to enable pre-commit hooks. To ensure consistency in our formatting we use `pre-commit` to check whether code was formatted properly and the documentation is up to date. Whenever a commit does not meet the checks implemented by pre-commit, the commit will fail and the pre-commit checks will modify the files to make the commits pass. Include these changes in your commit for the next commit attempt to succeed. On pull requests the CI checks whether all pre-commit hooks were run correctly. | ||
| This repo includes the following pre-commit hooks that are defined in the `.pre-commit-config.yaml`: | ||
|
|
||
| - `mixed-line-ending`: This hook ensures that all files have the same line endings (LF). | ||
| - `format`: This hook uses `forge fmt` to format all Solidity files. | ||
| - `doc`: This hook uses `forge doc` to automatically generate documentation for all Solidity files whenever the NatSpec documentation changes. The `script/util/doc_gen.sh` script is used to generate documentation. Forge updates the commit hash in the documentation automatically. To only generate new documentation when the documentation has actually changed, the script checks whether more than just the hash has changed in the documentation and discard all changes if only the hash has changed. | ||
| - `prettier`: All remaining files are formatted using prettier. | ||
|
|
||
| ## Branching | ||
|
|
||
| This section outlines the branching strategy of this repo. | ||
|
|
||
| ### Main | ||
|
|
||
| The main branch is supposed to reflect the deployed state on all networks. Any pull requests into this branch MUST come from the staging branch. The main branch is protected and requires a separate code review by the security team. Whenever the main branch is updated, a new release is created with the latest version. For more information on versioning, check [here](#versioning). | ||
|
|
||
| ### Staging | ||
|
|
||
| The staging branch reflects new code complete deployments or upgrades containing fixes and/or features. Any pull requests into this branch MUST come from the dev branch. The staging branch is used for security audits and deployments. Once the deployment is complete and deployment log files are generated, the branch can be merged into main. For more information on the deployment and log file generation check [here](#deployment--versioning). | ||
|
|
||
| ### Dev | ||
|
|
||
| This is the active development branch. All pull requests into this branch MUST come from fix or feature branches. Upon code completion this branch is merged into staging for auditing and deployment. | ||
|
|
||
| ### Feature | ||
|
|
||
| Any new feature should be developed on a separate branch. The naming convention for these branches is `feat/*`. Once the feature is complete, a pull request into the dev branch can be created. | ||
|
|
||
| ### Fix | ||
|
|
||
| Any bug fixes should be developed on a separate branch. The naming convention for these branches is `fix/*`. Once the fix is complete, a pull request into the dev branch can be created. | ||
|
|
||
| ## Code Practices | ||
|
|
||
| ### Interfaces | ||
|
|
||
| Every contract MUST implement their corresponding interface that includes all externally callable functions, errors and events. | ||
|
|
||
| ### NatSpec & Comments | ||
|
|
||
| Interfaces should be the entrypoint for all contracts. When exploring the a contract within the repository, the interface MUST contain all relevant information to understand the functionality of the contract in the form of NatSpec comments. This includes all externally callable functions, errors and events. The NatSpec documentation MUST be added to the functions, errors and events within the interface. This allows a reader to understand the functionality of a function before moving on to the implementation. The implementing functions MUST point to the NatSpec documentation in the interface using `@inheritdoc`. Internal and private functions shouldn't have NatSpec documentation except for `@dev` comments, whenever more context is needed. Additional comments within a function should only be used to give more context to more complex operations, otherwise the code should be kept readable and self-explanatory. | ||
|
|
||
| ## Versioning | ||
|
|
||
| This repo utilizes [semantic versioning](https://semver.org/). An `IVersioned` interface is included in the [interfaces directory](src/interface/IVersioned.sol) exposing a unified versioning interface for all contracts. This version MUST be included in all contracts, whether they are upgradeable or not, to be able to easily match deployed versions. For example, in the case of a non-upgradeable contract one version could be deployed to a network and later a new version might be deployed to another network. The exposed `version()` function is also used by the [Deployment Info Generator](#deployment-info-generation) to extract information about the version. | ||
|
|
||
| Whenever contracts are modified, only the version of the changed contracts should be updated. Unmodified contracts should remain on the version of their last change. | ||
|
|
||
| ## Testing | ||
|
|
||
| ### Deployment Template | ||
|
|
||
| This repo provides a deployment script template for consistency between scripts and unit tests. For more information on how to use the template, check [here](#deployment-script-template). | ||
|
|
||
| ## Deployment | ||
|
|
||
| This repo utilizes versioned deployments. Any changes to a contract should update the version of this specific contract. To deploy a new version of a contract, create a new deployment script in a directory named after the new version of the modified contracts (e.g., `1.0.0`). A script is provided that extracts deployment information from the `run-latest.json` file within the `broadcast` directory generated while the forge script runs. From this information a JSON and markdown file is generated containing various information about the deployment itself as well as past deployments. | ||
|
|
||
| ### Deployment Template | ||
|
|
||
| This repo provides a deployment script template for consistency between scripts and unit tests. For more information on how to use the template, check [here](#deployment-script-template). | ||
|
|
||
| ### Deployment | ||
|
|
||
| This repo set up the following RPCs in the `foundry.toml` file: | ||
|
|
||
| - mainnet: Ethereum Mainnet | ||
| - goerli: Ethereum Goerli | ||
| - sepolia: Ethereum Sepolia | ||
| - polygon_pos: Polygon PoS | ||
| - mumbai: Polygon Mumbai | ||
| - polygon_zkevm: Polygon zkEVM | ||
| - polygon_zkevm_testnet: Polygon zkEVM Testnet | ||
|
|
||
| To deploy the contracts, provide the `--broadcast` flag to the forge script command. Should the etherscan verification time out, it can be picked up again by replacing the `--broadcast` flag with `--resume`. | ||
| Deploy the contracts to one of the predefined networks by providing the according key with the `--rpc-url` flag. Most of the predefined networks require the `INFURA_KEY` environment variable to be set in the `.env` file. | ||
| Including the `--verify` flag will verify deployed contracts on Etherscan. Define the appropriate environment variable in the `.env` file. | ||
|
|
||
| ```shell | ||
| $ forge script script/1.0.0/Deploy.s.sol --broadcast --rpc-url <rpc_url> --verify | ||
| ``` | ||
|
|
||
| ### Deployment Info Generation | ||
|
|
||
| A JSON and Markdown file can be generated in the `deployments` directory containing various information about the deployment itself as well as past deployments using the following command. To find out more about versioning of contracts within this repo, check [here](CONTRIBUTING.md#versioning). | ||
|
|
||
| ```shell | ||
| $ node script/util/extract.js <chainId> <version> <scriptName> | ||
| ``` | ||
|
|
||
| As the `chainId`, provide the chainId of the network the contracts were deployed to as a number. The supplied `version` should be the version of the modified contracts and the sub directory the deployment script is located in (e.g., `1.0.0`). The `scriptName` should be the file name of the script used in the deployment (e.g., `Deploy.s.sol`). | ||
|
|
||
| When upgrading a contract, most of the times just the new implementation is deployed and the actual upgrade is triggered by a governance process or a multisig. The script will check whether the implementation of the upgraded contract was updated to the deployed version and if not, it will fail and not generate any files. | ||
|
|
||
| ## Deployment Template Script | ||
|
|
||
| This repo provides a deployment script template for consistency between scripts and unit tests. | ||
|
|
||
| TODO more documentation | ||
|
|
||
| ## Releases | ||
|
|
||
| Releases should be created whenever the code on the main branch is updated to reflect a deployment or an upgrade on a network. The release should be named after the version of the contracts deployed or upgraded. | ||
| The release should include the following: | ||
|
|
||
| 1. Install [pre-commit](https://pre-commit.com/#post-commit) | ||
| 2. Run `pre-commit install` | ||
| - In case of a MAJOR version | ||
| - changelog | ||
| - summary of new features | ||
| - summary of breaking changes | ||
| - In case of a MINOR version | ||
| - changelog | ||
| - summary of new features | ||
| - summary of fixes | ||
| - In case of a PATCH version | ||
| - changelog | ||
| - summary of fixes | ||
| - Deployment information | ||
| - TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # Documentation | ||
|
|
||
| TODO |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters