refactor(Modules,CLI): add propose kwargs/flag for modules

Author: fubuloubu

ape_safe/_cli/modules.py

@@ -44,25 +44,27 @@ def guard(safe: "SafeAccount"):
 @network_option()
 @account_option()
 @safe_argument
+@click.option("--propose", is_flag=True, default=False)
 @click.argument("module", type=AddressType)
-def enable(safe: "SafeAccount", account: "AccountAPI", module: AddressType):
+def enable(safe: "SafeAccount", account: "AccountAPI", module: AddressType, propose: bool):
     """
     Enable MODULE for SAFE
 
     **WARNING**: This is a potentially destructive action, and may make your safe vulnerable.
     """
-    safe.modules.enable(module, submitter=account)
+    safe.modules.enable(module, submitter=account, propose=propose)
 
 
 @modules.command(cls=ConnectedProviderCommand)
 @network_option()
 @account_option()
 @safe_argument
+@click.option("--propose", is_flag=True, default=False)
 @click.argument("module", type=AddressType)
-def disable(safe: "SafeAccount", account: "AccountAPI", module: AddressType):
+def disable(safe: "SafeAccount", account: "AccountAPI", module: AddressType, propose: bool):
     """
     Disable MODULE for SAFE
 
     **WARNING**: This is a potentially destructive action, and may impact operations of your safe.
     """
-    safe.modules.disable(module, submitter=account)
+    safe.modules.disable(module, submitter=account, propose=propose)

ape_safe/modules.py

@@ -7,10 +7,11 @@
 if TYPE_CHECKING:
     from collections.abc import Iterator
 
-    from ape.api import ReceiptAPI
+    from ape.api import AccountAPI, ReceiptAPI
     from ape.contracts import ContractInstance
 
     from ape_safe.accounts import SafeAccount
+    from ape_safe.client import SafeTxID
 
 
 class SafeModuleManager(ManagerAccessMixin):
@@ -27,9 +28,23 @@ def __contains__(self, module: Union[str, AddressType, "ContractInstance"]) -> b
         return self._safe.contract.isModuleEnabled(module)
 
     def enable(
-        self, module: Union[str, AddressType, "ContractInstance"], **txn_kwargs
-    ) -> "ReceiptAPI":
-        return self._safe.contract.enableModule(module, sender=self._safe, **txn_kwargs)
+        self,
+        module: Union[str, AddressType, "ContractInstance"],
+        submitter: Union["AccountAPI", AddressType, str, None] = None,
+        propose: bool = False,
+        **txn_kwargs,
+    ) -> Union["ReceiptAPI", "SafeTxID"]:
+        if propose:
+            txn = self._safe.contract.enableModule.as_transaction(module, **txn_kwargs)
+            return self._safe.propose(txn=txn, submitter=submitter)
+
+        else:
+            return self._safe.contract.enableModule(
+                module,
+                sender=self._safe,
+                submitter=submitter,
+                **txn_kwargs,
+            )
 
     def __iter__(self) -> "Iterator[ContractInstance]":
         start_module = self.SENTINEL
@@ -56,14 +71,27 @@ def _get_previous_module(
         raise AssertionError(f"Module {module} not in Safe modules for {self._safe}")
 
     def disable(
-        self, module: Union[str, AddressType, "ContractInstance"], **txn_kwargs
-    ) -> "ReceiptAPI":
-        return self._safe.contract.disableModule(
-            self._get_previous_module(module),
-            module,
-            sender=self._safe,
-            **txn_kwargs,
-        )
+        self,
+        module: Union[str, AddressType, "ContractInstance"],
+        submitter: Union["AccountAPI", AddressType, str, None] = None,
+        propose: bool = False,
+        **txn_kwargs,
+    ) -> Union["ReceiptAPI", "SafeTxID"]:
+        if propose:
+            txn = self._safe.contract.disableModule.as_transaction(
+                self._get_previous_module(module),
+                module,
+                **txn_kwargs,
+            )
+            return self._safe.propose(txn=txn, submitter=submitter)
+
+        else:
+            return self._safe.contract.disableModule(
+                self._get_previous_module(module),
+                module,
+                sender=self._safe,
+                **txn_kwargs,
+            )
 
     @property
     def guard(self) -> Optional["ContractInstance"]:
@@ -81,6 +109,15 @@ def guard(self) -> Optional["ContractInstance"]:
         return self.chain_manager.contracts.instance_at(module_guard_address)
 
     def set_guard(
-        self, guard: Union[str, AddressType, "ContractInstance"], **txn_kwargs
-    ) -> "ReceiptAPI":
-        return self._safe.contract.setModuleGuard(guard, sender=self._safe, **txn_kwargs)
+        self,
+        guard: Union[str, AddressType, "ContractInstance"],
+        submitter: Union["AccountAPI", AddressType, str, None] = None,
+        propose: bool = False,
+        **txn_kwargs,
+    ) -> Union["ReceiptAPI", "SafeTxID"]:
+        if propose:
+            txn = self._safe.contract.setModuleGuard.as_transaction(guard, **txn_kwargs)
+            return self._safe.propose(txn=txn, submitter=submitter)
+
+        else:
+            return self._safe.contract.setModuleGuard(guard, sender=self._safe, **txn_kwargs)