feat(SDK): refactor folder structure; add Purse/Accessory classes (#17)

Author: fubuloubu

.github/workflows/publish.yaml

@@ -0,0 +1,20 @@
+name: Release
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/checkout@v5
+    - uses: astral-sh/setup-uv@v7
+
+    - name: Build
+    - run: uv venv && uv sync --group build && uv build
+
+    - name: Publish
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test.yaml

@@ -13,8 +13,9 @@ jobs:
   functional:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: ApeWorX/github-action@v3
-    - run: ape compile --size
+    - uses: actions/checkout@v5
+    - uses: astral-sh/setup-uv@v7
+    - run: uv venv && uv sync --group test
+    - run: uv run ape compile --size
     - uses: foundry-rs/foundry-toolchain@v1
-    - run: ape test -s --gas --coverage
+    - run: uv run --group test ape test -s --gas --coverage

purse/__init__.py

@@ -3,21 +3,39 @@ requires = ["setuptools", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "purse"
-dynamic = ["version"]
-description = "Purse: A Simple(r) Smart Wallet"
+name = "purse-py"
+dynamic = [ "version" ]
+description = "Purse: Personalize your Wallet"
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.11"
 dependencies = [
-    "eth-ape>=0.8.32",
-    "snekmate>=0.0.1",
+    "createx>=0.1.1",
+    "eth-ape>=0.8.43",
+    "snekmate>=0.1.2",
+]
+
+[dependency-groups]
+build = [
+    "ape-vyper>=0.8.10",
+]
+test = [
+    "ape-foundry>=0.8.10",
+    {include-group = "build"},
+]
+dev = [
+    "ape-etherscan>=0.8.5",
+    {include-group = "test"},
 ]
 
 [[project.authors]]
 name = "ApeWorX LTD"
 
-[tool.setuptools]
-packages = ["purse"]
+[project.scripts]
+purse = "purse.__main__:cli"
+
+[tool.setuptools.packages.find]
+where = [ "sdk/py" ]
+include = [ "purse" ]
 
 [tool.setuptools_scm]
 # NOTE: Required for `setuptools-scm` to function

purse/package.json

@@ -0,0 +1,7 @@
+from .accessory import Accessory
+from .main import Purse
+
+__all__ = [
+    Accessory.__name__,
+    Purse.__name__,
+]

pyproject.toml

@@ -0,0 +1,182 @@
+from typing import TYPE_CHECKING
+from ape.api.address import Address
+import click
+
+from ape.cli import (
+    ApeCliContextObject,
+    ConnectedProviderCommand,
+    account_option,
+    ape_cli_context,
+)
+from ape.contracts import ContractContainer
+from ape.types import AddressType
+from createx import CreateX
+from eth_utils.crypto import keccak
+from purse import Purse, Accessory
+
+from .package import ACCESSORIES, DEPLOYMENTS, MANIFEST
+
+if TYPE_CHECKING:
+    from ape.api import AccountAPI
+
+
+@click.group()
+def cli():
+    """Commands for managing a Purse-enabled wallet"""
+
+
+@cli.command(cls=ConnectedProviderCommand)
+@ape_cli_context()
+@click.argument("address")
+def check(cli_ctx: ApeCliContextObject, address: str):
+    """Check if ADDRESS has Purse delegate enabled, then check version of accessories."""
+
+    if address in cli_ctx.account_manager.aliases:
+        account = cli_ctx.account_manager.load(address)
+
+    else:
+        account = Address(cli_ctx.conversion_manager.convert(address, AddressType))
+
+    if not (delegate := account.delegate):
+        click.secho("No delegate detected", fg="yellow")
+        return 1
+
+    elif not (singleton := DEPLOYMENTS.get(keccak(delegate.code).hex())):
+        click.secho("Account is not delegated to Purse", fg="red")
+        return 1
+
+    elif singleton != (latest := list(DEPLOYMENTS.values())[-1]):
+        click.secho(
+            f"Not using the latest version of Purse, please upgrade to {latest}",
+            fg="yellow",
+        )
+
+    else:
+        click.secho("Delegated to latest version of Purse!", fg="green")
+
+    purse = Purse(account)
+
+    if not (accessory_deployments := ACCESSORIES.get(singleton, {})):
+        click.secho(f"No known accessories for version at {singleton}", fg="yellow")
+        return 1
+
+    for accessory_name, accessory_addresses in accessory_deployments.items():
+        for address in accessory_addresses:
+            if purse.has_accessory(accessory := Accessory(address)):
+                if address == (latest := accessory_addresses[-1]):
+                    click.secho(
+                        f"Account has latest accessory '{accessory_name}' for Purse version",
+                        fg="green",
+                    )
+                else:
+                    click.secho(
+                        f"Account has an older accessory '{accessory_name}'"
+                        f" and should be upgraded to {latest}",
+                        fg="yellow",
+                    )
+
+                if not all(
+                    purse.contract.accessoryByMethodId(method.method)
+                    == accessory.address
+                    for method in accessory.methods
+                ):
+                    click.secho(
+                        "Account has not installed all neccessary methods for accessory!",
+                        fg="red",
+                    )
+
+                break
+
+        else:
+            click.secho(
+                f"Account doesn't have accessory '{accessory_name}'", fg="green"
+            )
+
+
+@cli.command(cls=ConnectedProviderCommand)
+@ape_cli_context()
+@account_option()
+@click.argument("accessories", nargs=-1)
+def enable(cli_ctx, account: "AccountAPI", accessories: list[str]):
+    """Enable Purse w/ 1 or more Accessories added"""
+
+    singleton = cli_ctx.chain_manager.contracts.instance_at(
+        list(DEPLOYMENTS.values())[-1],
+        contract_type=MANIFEST.Purse,
+    )
+    valid_choices = ACCESSORIES.get(singleton.address, {})
+    accessories: list[Accessory] = [
+        Accessory(valid_choices.get(name, [])[-1]) for name in accessories
+    ]
+
+    # TODO: Why doesn't `KeyfileAccount.sign_authorization` display warning?
+    accessories_str = "\n- " + "\n- ".join(a.address for a in accessories)
+    if click.confirm(f"Enable {singleton} with accessories:{accessories_str}\n\n"):
+        Purse.initialize(account, *accessories, singleton=singleton)
+
+
+@cli.command(cls=ConnectedProviderCommand)
+@account_option()
+def disable(account: "AccountAPI"):
+    """Remove Purse from your account"""
+
+    purse = Purse(account)
+    purse.disable()
+
+
+@cli.group()
+def sudo():
+    """Manage System Contracts"""
+
+
+@sudo.group()
+def deploy():
+    """Deploy the Purse system contracts and accessories using CreateX"""
+
+
+@deploy.command(cls=ConnectedProviderCommand)
+@account_option()
+def singleton(account):
+    """Deploy the Purse singleton contract using CreateX"""
+
+    try:
+        createx = CreateX()
+    except RuntimeError:
+        createx = CreateX.inject()
+
+    deployment = createx.deploy(
+        ContractContainer(MANIFEST.Purse),
+        redeploy_protection=False,
+        sender_protection=False,
+        sender=account,
+        salt="Purse",
+    )
+    click.secho(f"Purse singleton deployed to {deployment}", fg="green")
+
+
+@deploy.command(cls=ConnectedProviderCommand)
+@account_option()
+@click.argument("accessory")
+def accessory(account, accessory):
+    """Deploy a Purse accessory from this project"""
+
+    if not (Accessory := ContractContainer(MANIFEST.get_contract_type(accessory))):
+        raise click.UsageError(f"'{accessory}' is not a valid accessory.")
+
+    try:
+        createx = CreateX()
+    except RuntimeError:
+        createx = CreateX.inject()
+
+    deployment = createx.deploy(
+        Accessory,
+        redeploy_protection=False,
+        sender_protection=False,
+        sender=account,
+        salt=f"Purse {accessory}",
+    )
+    click.secho(f"Accessory '{accessory}' deployed to {deployment}", fg="green")
+
+
+if __name__ == "__main__":
+    cli()