feat(CLI): create new (#11)

Author: fubuloubu

ruffsack/__main__.py

@@ -1,6 +1,61 @@
+import math
+
 import click
+from ape.cli import ConnectedProviderCommand, account_option
+from ape.types import AddressType
+
+from ruffsack import Factory
+from ruffsack.packages import MANIFESTS
 
 
 @click.group()
 def cli():
     """Manage Ruffsack wallets (https://ruffsack.xyz)"""
+
+
+@cli.command(cls=ConnectedProviderCommand)
+@account_option()
+@click.option(
+    "--version",
+    default=str(max(MANIFESTS)),
+    help="Version to use when creating the multisig. Defaults to latest in SDK.",
+)
+@click.option(
+    "--threshold",
+    type=int,
+    default=0,
+    help="The value to use for the wallet's threshold. "
+    "Defaults to half the number of signers (rounding up)",
+)
+@click.option("--tag", default=None)
+@click.argument("signers", nargs=-1)
+def new(version, threshold, tag, signers, account):
+    """Create a new Ruffsack multisig wallet on the given network"""
+    from ape import accounts, convert
+
+    signers = [
+        accounts.load(s) if s in accounts.aliases else convert(s, AddressType)
+        for s in signers
+    ]
+
+    if len(signers) == 0:
+        raise click.UsageError("Must provider at least one signer")
+
+    elif len(signers) > 11:
+        raise click.UsageError("Cannot use Ruffsack with more than 11 signers")
+
+    if not threshold:
+        threshold = math.ceil(len(signers) / 2)
+
+    elif 0 > threshold or threshold > len(signers):
+        raise click.UsageError("Cannot use a value higher than number of signers")
+
+    factory = Factory()
+    sack = factory.new(
+        signers,
+        threshold=threshold,
+        version=version,
+        tag=tag,
+        sender=account,
+    )
+    click.secho(f"New Ruffsack deployed: {sack.address}", fg="yellow")

ruffsack/factory.py

@@ -12,8 +12,13 @@
 
 class Factory(ManagerAccessMixin):
     def __init__(self, address: AddressType | None = None):
-        # TODO: Refactor to use deterministic deployment address
-        self.address = address or self.local_project.RuffsackFactory.deployments[0]
+        if address:
+            self.address = address
+
+        else:
+            # TODO: Refactor to use deterministic deployment address
+            self.address = self.local_project.RuffsackFactory.deployments[0].address
+
         self._cached_releases: dict[Version, "ContractInstance"] = dict()
         self._last_cached: int = 0
 
@@ -29,7 +34,9 @@ def contract(self) -> "ContractInstance":
     @property
     def releases(self) -> dict[Version, "ContractInstance"]:
         if (latest_block := self.chain_manager.blocks.head.number) > self._last_cached:
-            for log in self.contract.NewRelease.range(self._last_cached, latest_block):
+            for log in self.contract.NewRelease.range(
+                self._last_cached, latest_block + 1
+            ):
                 self._cached_releases[Version(log.version)] = (
                     self.chain_manager.contracts.instance_at(
                         log.implementation,
@@ -45,7 +52,7 @@ def new(
         signers: list[AddressType],
         threshold: int | None = None,
         version: Version | str | None = None,
-        salt: str | bytes | None = None,
+        tag: str | None = None,
         **txn_args,
     ) -> "ContractInstance":
         if threshold is None:
@@ -54,35 +61,20 @@ def new(
         if isinstance(version, str):
             version = Version(version)
 
-        if salt is not None:
-            if version is None:
-                version = Version(self.contract.last_version())
-
-            receipt = self.contract.new(
-                signers,
-                threshold,
-                str(version),
-                salt,
-                **txn_args,
-            )
+        args = [signers, threshold]
+        if tag is not None:
+            args.extend([str(version) if version else "stable", tag])
 
         elif version is not None:
-            receipt = self.contract.new(
-                signers,
-                threshold,
-                str(version),
-                **txn_args,
-            )
+            args.append(str(version))
 
-        else:
-            receipt = self.contract.new(
-                signers,
-                threshold,
-                **txn_args,
-            )
-            version = Version(self.contract.last_version())
+        if version is None:
+            version = Version(self.contract.last_release())
+
+        receipt = self.contract.new(*args, **txn_args)
 
         new_ruffsack_address = receipt.events[0].new_sack
+        # TODO: Refactor to use SDK internal type? (subclassing `AccountAPI`)
         return self.chain_manager.contracts.instance_at(
             new_ruffsack_address,
             contract_type=PackageType.SINGLETON(version),