💥 Add Multi-Role-Based TimelockController Reference Implementation (#…

…195)

Signed-off-by: Pascal Marco Caversaccio <[email protected]>
Co-authored-by: Pascal Marco Caversaccio <[email protected]>

.gitignore

@@ -57,3 +57,6 @@ venv
 # Python build files
 dist
 *.egg-info
+
+# Ape build files
+.build

.solhint.json

@@ -4,6 +4,7 @@
     "func-visibility": ["warn", { "ignoreConstructors": true }],
     "func-name-mixedcase": "off",
     "private-vars-leading-underscore": "off",
-    "one-contract-per-file": "off"
+    "one-contract-per-file": "off",
+    "max-states-count": "off"
   }
 }

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [`0.0.5`](https://github.com/pcaversaccio/snekmate/releases/tag/v0.0.5) (Unreleased)
 
+### 💥 New Features
+
+- **Governance**
+  - [`TimelockController`](https://github.com/pcaversaccio/snekmate/blob/v0.0.5/src/governance/TimelockController.vy): A multi-role-based timelock controller reference implementation. ([#195](https://github.com/pcaversaccio/snekmate/pull/195))
+
 ### ♻️ Refactoring
 
 - **Utility Functions**

README.md

@@ -26,6 +26,8 @@ src
 │   ├── ERC4626 — "Modern and Gas-Efficient ERC-4626 Tokenised Vault Implementation"
 │   └── interfaces
 │       └── IERC2981 — "EIP-2981 Interface Definition"
+├── governance
+│   └── TimelockController — "Multi-Role-Based Timelock Controller Reference Implementation"
 ├── tokens
 │   ├── ERC20 — "Modern and Gas-Efficient ERC-20 + EIP-2612 Implementation"
 │   ├── ERC721 — "Modern and Gas-Efficient ERC-721 + EIP-4494 Implementation"
@@ -113,6 +115,7 @@ This repository contains [Foundry](https://github.com/foundry-rs/foundry)-based
 | `AccessControl`           |       ✅       |            ✅            |         ✅          |
 | `ERC2981`                 |       ✅       |            ✅            |         ✅          |
 | `ERC4626`                 |       ✅       |            ✅            |         ✅          |
+| `TimelockController`      |       ✅       |            ✅            |         ✅          |
 | `ERC20`                   |       ✅       |            ✅            |         ✅          |
 | `ERC721`                  |       ✅       |            ✅            |         ✅          |
 | `ERC1155`                 |       ✅       |            ✅            |         ✅          |

package.json

@@ -22,10 +22,10 @@
     "url": "https://github.com/pcaversaccio/snekmate/issues"
   },
   "scripts": {
-    "prettier:check": "npx prettier -c **/*.{md,sol,js,json,yml,yaml}",
-    "prettier:fix": "npx prettier -w **/*.{md,sol,js,json,yml,yaml}",
-    "solhint:check": "npx solhint '**/*.sol'",
-    "solhint:fix": "npx solhint '**/*.sol' --fix",
+    "prettier:check": "npx prettier -c \"**/*.{md,sol,js,json,yml,yaml}\"",
+    "prettier:fix": "npx prettier -w \"**/*.{md,sol,js,json,yml,yaml}\"",
+    "solhint:check": "npx solhint \"**/*.sol\"",
+    "solhint:fix": "npx solhint \"**/*.sol\" --fix",
     "lint:check": "pnpm prettier:check && pnpm solhint:check && npx eslint --ext .js .",
     "lint:fix": "pnpm prettier:fix && pnpm solhint:fix && npx eslint --ext .js . --fix"
   },

src/auth/AccessControl.vy

@@ -63,6 +63,9 @@ implements: IAccessControl
 
 
 # @dev The default 32-byte admin role.
+# @notice If you declare a variable as `public`,
+# Vyper automatically generates an `external`
+# getter function for the variable.
 DEFAULT_ADMIN_ROLE: public(constant(bytes32)) = empty(bytes32)
 
 
@@ -93,9 +96,6 @@ _SUPPORTED_INTERFACES: constant(bytes4[2]) = [
 
 
 # @dev Returns `True` if `account` has been granted `role`.
-# @notice If you declare a variable as `public`,
-# Vyper automatically generates an `external`
-# getter function for the variable.
 hasRole: public(HashMap[bytes32, HashMap[address, bool]])
 
 
@@ -226,6 +226,7 @@ def set_role_admin(role: bytes32, admin_role: bytes32):
 
 
 @internal
+@view
 def _check_role(role: bytes32, account: address):
     """
     @dev Reverts with a standard message if `account`

src/auth/Ownable.vy

@@ -17,6 +17,9 @@
 
 
 # @dev Returns the address of the current owner.
+# @notice If you declare a variable as `public`,
+# Vyper automatically generates an `external`
+# getter function for the variable.
 owner: public(address)
 
 

src/auth/Ownable2Step.vy

@@ -16,6 +16,9 @@
 
 
 # @dev Returns the address of the current owner.
+# @notice If you declare a variable as `public`,
+# Vyper automatically generates an `external`
+# getter function for the variable.
 owner: public(address)
 
 

src/extensions/ERC2981.vy

@@ -67,6 +67,9 @@ _SUPPORTED_INTERFACES: constant(bytes4[2]) = [
 
 
 # @dev Returns the address of the current owner.
+# @notice If you declare a variable as `public`,
+# Vyper automatically generates an `external`
+# getter function for the variable.
 owner: public(address)