Merge branch 'main' of github.com:safe-global/safe-core-protocol into…

… feat/remove-isafe-from-function-parameters
5afe · Sep 20, 2023 · 7cb0f0b · 7cb0f0b
2 parents 6b3a22b + 9f0c499
commit 7cb0f0b
Show file tree

Hide file tree

Showing 5 changed files with 115 additions and 87 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,20 @@
 
 This changelog contains changes starting from version v0.1.0
 
+# Version 0.2.1 Alpha
+
+## Safe{Core} Protocol contracts
+
+### Changes
+
+- Implement fine grained permissions [#98](https://github.com/safe-global/safe-core-protocol/pull/98)
+
+  Implement more granular permissions for plugins
+
+- Remove ISafe interface in the function handler [#99](https://github.com/safe-global/safe-core-protocol/pull/99)
+
+  Replace ISafe interface in the function handler parameters with an account address
+
 # Version 0.2.0
 
 ## Safe{Core} Protocol contracts

diff --git a/deployments.ts b/deployments.ts
@@ -5,7 +5,7 @@ export default {
       "chainId": "5",
       "contracts": {
         "SafeProtocolManager": {
-          "address": "0x21c857DdbAfD4D55b75bb53E897083a8Ad023043",
+          "address": "0x58C7e65f08FB26220BA3A124C021db04F1Fa987B",
           "abi": [
             {
               "inputs": [
@@ -138,17 +138,22 @@ export default {
                   "type": "address"
                 },
                 {
-                  "internalType": "uint64",
-                  "name": "listedAt",
-                  "type": "uint64"
+                  "internalType": "uint8",
+                  "name": "pluginRequires",
+                  "type": "uint8"
                 },
                 {
-                  "internalType": "uint64",
-                  "name": "flaggedAt",
-                  "type": "uint64"
+                  "internalType": "uint8",
+                  "name": "requiredPermission",
+                  "type": "uint8"
+                },
+                {
+                  "internalType": "uint8",
+                  "name": "givenPermission",
+                  "type": "uint8"
                 }
               ],
-              "name": "ModuleNotPermitted",
+              "name": "MissingPluginPermission",
               "type": "error"
             },
             {
@@ -159,17 +164,17 @@ export default {
                   "type": "address"
                 },
                 {
-                  "internalType": "bool",
-                  "name": "requiresRootAccess",
-                  "type": "bool"
+                  "internalType": "uint64",
+                  "name": "listedAt",
+                  "type": "uint64"
                 },
                 {
-                  "internalType": "bool",
-                  "name": "providedValue",
-                  "type": "bool"
+                  "internalType": "uint64",
+                  "name": "flaggedAt",
+                  "type": "uint64"
                 }
               ],
-              "name": "PluginAccessMismatch",
+              "name": "ModuleNotPermitted",
               "type": "error"
             },
             {
@@ -196,7 +201,7 @@ export default {
                   "type": "address"
                 }
               ],
-              "name": "PluginEnabledOnlyForRootAccess",
+              "name": "PluginNotEnabled",
               "type": "error"
             },
             {
@@ -205,20 +210,19 @@ export default {
                   "internalType": "address",
                   "name": "plugin",
                   "type": "address"
-                }
-              ],
-              "name": "PluginNotEnabled",
-              "type": "error"
-            },
-            {
-              "inputs": [
+                },
                 {
-                  "internalType": "address",
-                  "name": "sender",
-                  "type": "address"
+                  "internalType": "uint8",
+                  "name": "requiredPermissions",
+                  "type": "uint8"
+                },
+                {
+                  "internalType": "uint8",
+                  "name": "givenPermissions",
+                  "type": "uint8"
                 }
               ],
-              "name": "PluginRequiresRootAccess",
+              "name": "PluginPermissionsMismatch",
               "type": "error"
             },
             {
@@ -385,9 +389,9 @@ export default {
                 },
                 {
                   "indexed": false,
-                  "internalType": "bool",
-                  "name": "allowRootAccess",
-                  "type": "bool"
+                  "internalType": "uint8",
+                  "name": "permissions",
+                  "type": "uint8"
                 }
               ],
               "name": "PluginEnabled",
@@ -588,9 +592,9 @@ export default {
                   "type": "address"
                 },
                 {
-                  "internalType": "bool",
-                  "name": "allowRootAccess",
-                  "type": "bool"
+                  "internalType": "uint8",
+                  "name": "permissions",
+                  "type": "uint8"
                 }
               ],
               "name": "enablePlugin",
@@ -633,9 +637,9 @@ export default {
               "name": "enabledPlugins",
               "outputs": [
                 {
-                  "internalType": "bool",
-                  "name": "rootAddressGranted",
-                  "type": "bool"
+                  "internalType": "uint8",
+                  "name": "permissions",
+                  "type": "uint8"
                 },
                 {
                   "internalType": "address",
@@ -847,9 +851,9 @@ export default {
                 {
                   "components": [
                     {
-                      "internalType": "bool",
-                      "name": "rootAddressGranted",
-                      "type": "bool"
+                      "internalType": "uint8",
+                      "name": "permissions",
+                      "type": "uint8"
                     },
                     {
                       "internalType": "address",
@@ -1072,7 +1076,7 @@ export default {
           ]
         },
         "SafeProtocolRegistry": {
-          "address": "0xa86d16b615B6Eb5F55dD3ab458f491ff76d783aD",
+          "address": "0x8a0867Ea064634D5DDACe9c0b771c94BBbbA45E5",
           "abi": [
             {
               "inputs": [
@@ -1346,7 +1350,7 @@ export default {
           ]
         },
         "TestSafeProtocolManager": {
-          "address": "0xf7d2AEC4bd5bAF8c032a2c9ee9D3a71c79Fe92E0",
+          "address": "0xe66Df174ba0C3b8D876c0b4e7224e3Ec951590A2",
           "abi": [
             {
               "inputs": [
@@ -1479,17 +1483,22 @@ export default {
                   "type": "address"
                 },
                 {
-                  "internalType": "uint64",
-                  "name": "listedAt",
-                  "type": "uint64"
+                  "internalType": "uint8",
+                  "name": "pluginRequires",
+                  "type": "uint8"
                 },
                 {
-                  "internalType": "uint64",
-                  "name": "flaggedAt",
-                  "type": "uint64"
+                  "internalType": "uint8",
+                  "name": "requiredPermission",
+                  "type": "uint8"
+                },
+                {
+                  "internalType": "uint8",
+                  "name": "givenPermission",
+                  "type": "uint8"
                 }
               ],
-              "name": "ModuleNotPermitted",
+              "name": "MissingPluginPermission",
               "type": "error"
             },
             {
@@ -1500,17 +1509,17 @@ export default {
                   "type": "address"
                 },
                 {
-                  "internalType": "bool",
-                  "name": "requiresRootAccess",
-                  "type": "bool"
+                  "internalType": "uint64",
+                  "name": "listedAt",
+                  "type": "uint64"
                 },
                 {
-                  "internalType": "bool",
-                  "name": "providedValue",
-                  "type": "bool"
+                  "internalType": "uint64",
+                  "name": "flaggedAt",
+                  "type": "uint64"
                 }
               ],
-              "name": "PluginAccessMismatch",
+              "name": "ModuleNotPermitted",
               "type": "error"
             },
             {
@@ -1537,7 +1546,7 @@ export default {
                   "type": "address"
                 }
               ],
-              "name": "PluginEnabledOnlyForRootAccess",
+              "name": "PluginNotEnabled",
               "type": "error"
             },
             {
@@ -1546,20 +1555,19 @@ export default {
                   "internalType": "address",
                   "name": "plugin",
                   "type": "address"
-                }
-              ],
-              "name": "PluginNotEnabled",
-              "type": "error"
-            },
-            {
-              "inputs": [
+                },
                 {
-                  "internalType": "address",
-                  "name": "sender",
-                  "type": "address"
+                  "internalType": "uint8",
+                  "name": "requiredPermissions",
+                  "type": "uint8"
+                },
+                {
+                  "internalType": "uint8",
+                  "name": "givenPermissions",
+                  "type": "uint8"
                 }
               ],
-              "name": "PluginRequiresRootAccess",
+              "name": "PluginPermissionsMismatch",
               "type": "error"
             },
             {
@@ -1726,9 +1734,9 @@ export default {
                 },
                 {
                   "indexed": false,
-                  "internalType": "bool",
-                  "name": "allowRootAccess",
-                  "type": "bool"
+                  "internalType": "uint8",
+                  "name": "permissions",
+                  "type": "uint8"
                 }
               ],
               "name": "PluginEnabled",
@@ -1929,9 +1937,9 @@ export default {
                   "type": "address"
                 },
                 {
-                  "internalType": "bool",
-                  "name": "allowRootAccess",
-                  "type": "bool"
+                  "internalType": "uint8",
+                  "name": "permissions",
+                  "type": "uint8"
                 }
               ],
               "name": "enablePlugin",
@@ -1974,9 +1982,9 @@ export default {
               "name": "enabledPlugins",
               "outputs": [
                 {
-                  "internalType": "bool",
-                  "name": "rootAddressGranted",
-                  "type": "bool"
+                  "internalType": "uint8",
+                  "name": "permissions",
+                  "type": "uint8"
                 },
                 {
                   "internalType": "address",
@@ -2188,9 +2196,9 @@ export default {
                 {
                   "components": [
                     {
-                      "internalType": "bool",
-                      "name": "rootAddressGranted",
-                      "type": "bool"
+                      "internalType": "uint8",
+                      "name": "permissions",
+                      "type": "uint8"
                     },
                     {
                       "internalType": "address",
@@ -2420,7 +2428,7 @@ export default {
           ]
         },
         "TestSafeProtocolRegistryUnrestricted": {
-          "address": "0x770e690c7B1063AdF4E29a610Bba207999c41708",
+          "address": "0xd6623271F1ecC70c37CADc78AB0ECcF972Ab6A01",
           "abi": [
             {
               "inputs": [

diff --git a/docs/deployments.md b/docs/deployments.md
@@ -4,8 +4,8 @@
 
 | Contract Name | Address (click to view on Etherscan) |
 | -------------- | -------------------------------- |
-| SafeProtocolManager | <a href="https://goerli.etherscan.io/address/0x21c857DdbAfD4D55b75bb53E897083a8Ad023043" target="_blank">0x21c857DdbAfD4D55b75bb53E897083a8Ad023043</a> |
-| SafeProtocolRegistry | <a href="https://goerli.etherscan.io/address/0xa86d16b615B6Eb5F55dD3ab458f491ff76d783aD" target="_blank">0xa86d16b615B6Eb5F55dD3ab458f491ff76d783aD</a> |
-| TestSafeProtocolManager | <a href="https://goerli.etherscan.io/address/0xf7d2AEC4bd5bAF8c032a2c9ee9D3a71c79Fe92E0" target="_blank">0xf7d2AEC4bd5bAF8c032a2c9ee9D3a71c79Fe92E0</a> |
-| TestSafeProtocolRegistryUnrestricted | <a href="https://goerli.etherscan.io/address/0x770e690c7B1063AdF4E29a610Bba207999c41708" target="_blank">0x770e690c7B1063AdF4E29a610Bba207999c41708</a> |
+| SafeProtocolManager | <a href="https://goerli.etherscan.io/address/0x58C7e65f08FB26220BA3A124C021db04F1Fa987B" target="_blank">0x58C7e65f08FB26220BA3A124C021db04F1Fa987B</a> |
+| SafeProtocolRegistry | <a href="https://goerli.etherscan.io/address/0x8a0867Ea064634D5DDACe9c0b771c94BBbbA45E5" target="_blank">0x8a0867Ea064634D5DDACe9c0b771c94BBbbA45E5</a> |
+| TestSafeProtocolManager | <a href="https://goerli.etherscan.io/address/0xe66Df174ba0C3b8D876c0b4e7224e3Ec951590A2" target="_blank">0xe66Df174ba0C3b8D876c0b4e7224e3Ec951590A2</a> |
+| TestSafeProtocolRegistryUnrestricted | <a href="https://goerli.etherscan.io/address/0xd6623271F1ecC70c37CADc78AB0ECcF972Ab6A01" target="_blank">0xd6623271F1ecC70c37CADc78AB0ECcF972Ab6A01</a> |
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@safe-global/safe-core-protocol",
-  "version": "0.2.0-alpha.2",
+  "version": "0.2.1-alpha.0",
   "description": "Safe{Core} Protocol contracts",
   "main": "dist/deployments.js",
   "repository": {
@@ -74,4 +74,4 @@
     "typescript": "~5.0.0",
     "yargs": "^17.7.2"
   }
-}
+}
diff --git a/src/tasks/generate_deployments_markdown.ts b/src/tasks/generate_deployments_markdown.ts
@@ -1,12 +1,18 @@
 // hardhat.config.js
 import "hardhat-deploy";
 import fs from "fs";
+import path from 'path';
 import { task } from "hardhat/config";
-import deployments from "../../deployments";
 import {NETWORK_ID_URL_MAPPING} from "../utils/etherscan_urls";
 
 task("generate:deployments", "Generate markdown file with deployed contract addresses")
   .setAction(async () => {
+    if (!fs.existsSync(path.join(__dirname, "../../deployments.ts"))) {
+      console.error("No deployments file found. Please run the deployment script first.");
+      return;
+    }
+
+    const {default: deployments} = await import("../../deployments");
     const markdownFile = "./docs/deployments.md";
 
     const networks = Object.keys(deployments);