feat: first steps towards immutability

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/utils"]
+	path = lib/utils
+	url = https://github.com/AngleProtocol/utils

CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@angle.money.
+<contact@merkl.xyz>.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -116,13 +116,13 @@ the community.
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
 
 Community Impact Guidelines were inspired by [Mozilla's code of conduct
 enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

LICENSE

@@ -10,7 +10,7 @@ Parameters
 Licensor: Angle Labs, Inc.
 
 Licensed Work: Merkl Smart Contracts
-The Licensed Work is (c) 2023 Angle Labs, Inc.
+The Licensed Work is (c) 2024 Angle Labs, Inc.
 
 Additional Use Grant: Any uses listed and defined at
 merkl-license-grants.angle-labs.eth

README.md

@@ -3,14 +3,14 @@
 [![CI](https://github.com/AngleProtocol/merkl-contracts/actions/workflows/ci.yml/badge.svg)](https://github.com/AngleProtocol/merkl-contracts/actions)
 [![Coverage](https://codecov.io/gh/AngleProtocol/merkl-contracts/branch/main/graph/badge.svg)](https://codecov.io/gh/AngleProtocol/merkl-contracts)
 
-This repository contains the smart contracts of the Merkl product developed by Angle.
+This repository contains the smart contracts of Merkl.
 
 It basically contains two contracts:
 
-- `DistributionCreator`: to which DAOs and individuals can deposit their rewards to incentivize a pool
+- `DistributionCreator`: to which DAOs and individuals can deposit their rewards to incentivize onchain actions
 - `Distributor`: the contract where users can claim their rewards
 
-You can learn more about the Merkl system in the [documentation](https://docs.angle.money/side-products/merkl).
+You can learn more about the Merkl system in the [documentation](https://docs.merkl.xyz).
 
 ## Setup
 
@@ -25,7 +25,7 @@ forge i
 
 ### Create `.env` file
 
-In order to interact with non local networks, you must create an `.env` that has, for all supported networks (Ethereum, Polygon and Arbitrum):
+In order to interact with non local networks, you must create an `.env` that has, for all supported networks:
 
 - `MNEMONIC`
 - `ETH_NODE_URI`
@@ -84,18 +84,52 @@ forge update
 
 ## Verifying
 
-Blast: `yarn etherscan blast --api-url https://api.blastscan.io --solc-input --license BUSL-1.1`
-Mantle: `yarn etherscan mantle --api-url https://api.routescan.io/v2/network/mainnet/evm/43114/etherscan/api --solc-input --license BUSL-1.1`
-Mode: `yarn etherscan mode --api-url https://api.routescan.io/v2/network/mainnet/evm/34443/etherscan/api --solc-input --license BUSL-1.1`
-ImmutableZKEVM: `yarn etherscan immutablezkevm --api-url https://explorer.immutable.com/api --solc-input --license BUSL-1.1`
-Scroll:`yarn etherscan scroll --api-url https://api.scrollscan.com --solc-input --license BUSL-1.1`
-Gnosis:`yarn etherscan gnosis --api-url https://api.gnosisscan.io --solc-input --license BUSL-1.1`
-Linea:`yarn etherscan linea --api-url https://api.lineascan.build --solc-input --license BUSL-1.1`
+Blast:
+
+```
+yarn etherscan blast --api-url https://api.blastscan.io --solc-input --license BUSL-1.1
+```
+
+Mantle:
+
+```
+yarn etherscan mantle --api-url https://api.routescan.io/v2/network/mainnet/evm/43114/etherscan/api --solc-input --license BUSL-1.1
+```
+
+Mode:
+
+```
+yarn etherscan mode --api-url https://api.routescan.io/v2/network/mainnet/evm/34443/etherscan/api --solc-input --license BUSL-1.1
+```
+
+ImmutableZKEVM:
+
+```
+yarn etherscan immutablezkevm --api-url https://explorer.immutable.com/api --solc-input --license BUSL-1.1
+```
+
+Scroll:
+
+```
+yarn etherscan scroll --api-url https://api.scrollscan.com --solc-input --license BUSL-1.1
+```
+
+Gnosis:
+
+```
+yarn etherscan gnosis --api-url https://api.gnosisscan.io --solc-input --license BUSL-1.1
+```
+
+Linea:
+
+```
+yarn etherscan linea --api-url https://api.lineascan.build --solc-input --license BUSL-1.1
+```
 
 ## Audits
 
 The Merkl smart contracts have been audited by Code4rena, find the audit report [here](https://code4rena.com/reports/2023-06-angle).
 
 ## Media
 
-Don't hesitate to reach out on [Twitter](https://twitter.com/AngleProtocol) 🐦
+Don't hesitate to reach out on [Twitter](https://x.com/merkl_xyz) 🐦