feat(SDK): add Ruffsack class to simplify working with wallet (#13)

Author: fubuloubu

contracts/Ruffsack.vy

@@ -38,7 +38,7 @@ IMPLEMENTATION: public(address)
 
 # Signer properties
 # @dev All current signers (unordered)
-signers: public(DynArray[address, 11])
+_signers: DynArray[address, 11]
 
 # @dev Number of signers required to execute an action
 threshold: public(uint256)
@@ -156,19 +156,25 @@ def initialize(signers: DynArray[address, 11], threshold: uint256):
     assert self.threshold == 0  # dev: can only initialize once
     assert threshold > 0 and threshold <= len(signers)
 
-    self.signers = signers
+    self._signers = signers
     self.threshold = threshold
 
 
+@view
+@external
+def signers() -> DynArray[address, 11]:
+    return self._signers
+
+
 @external
 def set_approval(msghash: bytes32, approved: bool = True):
-    assert msg.sender in self.signers, "Not a signer"
+    assert msg.sender in self._signers, "Not a signer"
     self.approved[msghash][msg.sender] = approved
 
 
 def _verify_signatures(msghash: bytes32, signatures: DynArray[Bytes[65], 11]):
     approvals_needed: uint256 = self.threshold
-    signers: DynArray[address, 11] = self.signers
+    signers: DynArray[address, 11] = self._signers
     already_approved: DynArray[address, 11] = []
 
     for signer: address in signers:
@@ -219,7 +225,7 @@ def _rotate_signers(
     signers_to_rm: DynArray[address, 11],
     threshold: uint256,
 ):
-    current_signers: DynArray[address, 11] = self.signers
+    current_signers: DynArray[address, 11] = self._signers
     new_signers: DynArray[address, 11] = []
 
     for signer: address in current_signers:
@@ -237,7 +243,7 @@ def _rotate_signers(
         assert threshold <= len(new_signers), "Invalid threshold"
         self.threshold = threshold
 
-    self.signers = new_signers
+    self._signers = new_signers
 
     log SignersRotated(
         executor=msg.sender,

ruffsack/__init__.py

@@ -1,7 +1,9 @@
 from .factory import Factory
+from .main import Ruffsack
 from .packages import PackageType
 
 __all__ = [
     Factory.__name__,
     PackageType.__name__,
+    Ruffsack.__name__,
 ]

ruffsack/factory.py

@@ -4,6 +4,7 @@
 from ape.utils import ManagerAccessMixin, cached_property
 from packaging.version import Version
 
+from .main import Ruffsack
 from .packages import MANIFESTS, PackageType
 
 if TYPE_CHECKING:
@@ -37,14 +38,16 @@ def releases(self) -> dict[Version, "ContractInstance"]:
             for log in self.contract.NewRelease.range(
                 self._last_cached, latest_block + 1
             ):
+                # NOTE: Handle dev testing by stripping `+...`
+                cleaned_version = Version(Version(log.version).public)
                 self._cached_releases[Version(log.version)] = (
                     self.chain_manager.contracts.instance_at(
                         log.implementation,
-                        contract_type=PackageType.SINGLETON(log.version),
+                        contract_type=PackageType.SINGLETON(cleaned_version),
                     )
                 )
 
-        self._last_cached = latest_block
+            self._last_cached = latest_block
         return self._cached_releases
 
     def new(
@@ -54,7 +57,7 @@ def new(
         version: Version | str | None = None,
         tag: str | None = None,
         **txn_args,
-    ) -> "ContractInstance":
+    ) -> Ruffsack:
         if threshold is None:
             threshold = len(signers) // 2
 
@@ -73,9 +76,6 @@ def new(
 
         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),
+        return Ruffsack(
+            address=receipt.events[0].new_sack, version=version, factory=self
         )