refactor: remove dependencies key and add Safe builds directly to repo

Author: fubuloubu

.github/workflows/test.yaml

@@ -79,11 +79,6 @@ jobs:
           with:
               python-version: ${{ matrix.python-version }}
 
-        - name: Build and Install Contract Dependencies
-          run: |
-            ape pm compile
-            ape run build
-
         - name: Install Package
           run: |
             python -m pip install --upgrade pip

.gitignore

@@ -1,6 +1,5 @@
 # Ape stuff
 .build/
-ape_safe/manifests/safe-v*.json
 
 # NPM Stuff
 node_modules/

CONTRIBUTING.md

@@ -18,6 +18,16 @@ python setup.py install
 pip install -e .'[dev]'
 ```
 
+If you need to add support for a new Safe version to the package,
+edit the `scripts/build.py` file to add the version to build, then run:
+
+```sh
+$ ape run build
+```
+
+This will compile the new dependency and install it under `ape_safe/mainfests/`.
+Be sure to add the new manifest to a PR and submit it, alongside updates to `tests/conftest.py`
+
 ## Pre-Commit Hooks
 
 We use [`pre-commit`](https://pre-commit.com/) hooks to simplify linting and ensure consistent formatting among contributors.

ape-config.yaml

@@ -9,64 +9,3 @@ plugins:
 ethereum:
   local:
     default_provider: foundry
-
-# NOTE: Build before release w/ `ape pm compile`
-dependencies:
-  - name: safe-contracts
-    github: safe-global/safe-smart-account
-    version: v1.1.1
-    config_override:
-      compile:
-        exclude:
-          - mocks
-          - interfaces
-
-      dependencies:
-        - name: openzeppelin
-          github: OpenZeppelin/openzeppelin-contracts
-          version: 2.2.0
-
-      solidity:
-        version: 0.5.14
-        import_remapping:
-          - "@openzeppelin/contracts=openzeppelin/v2.2.0"
-
-  - name: safe-contracts
-    github: safe-global/safe-smart-account
-    version: v1.3.0
-    config_override:
-      compile:
-        exclude:
-          - test
-          - examples
-          - interfaces
-
-      dependencies:
-        - name: openzeppelin
-          github: OpenZeppelin/openzeppelin-contracts
-          version: 3.4.0
-
-      solidity:
-        version: 0.7.6
-        import_remapping:
-          - "@openzeppelin/contracts=openzeppelin/v3.4.0"
-
-  - name: safe-contracts
-    github: safe-global/safe-smart-account
-    version: v1.4.1
-    config_override:
-      compile:
-        exclude:
-          - test
-          - examples
-          - interfaces
-
-      dependencies:
-        - name: openzeppelin
-          github: OpenZeppelin/openzeppelin-contracts
-          version: 3.4.0
-
-      solidity:
-        version: 0.7.6
-        import_remapping:
-          - "@openzeppelin/contracts=openzeppelin/v3.4.0"

ape_safe/manifests/safe-v1.1.1.json

@@ -1,28 +1,97 @@
-import shutil
 from pathlib import Path
 
 import click
+import yaml
 from ape import project
 
 PLUGIN_MANIFEST_FOLDER = project.path / "ape_safe" / "manifests"
 
+VERSIONS = {
+    "v1.1.1": """
+compile:
+  exclude:
+    - mocks
+    - interfaces
+
+dependencies:
+  - name: openzeppelin
+    github: OpenZeppelin/openzeppelin-contracts
+    version: 2.2.0
+
+solidity:
+  version: 0.5.14
+  import_remapping:
+    - "@openzeppelin/contracts=openzeppelin/v2.2.0"
+""",
+    "v1.3.0": """
+compile:
+  exclude:
+    - test
+    - examples
+    - interfaces
+
+dependencies:
+  - name: openzeppelin
+    github: OpenZeppelin/openzeppelin-contracts
+    version: 3.4.0
+
+solidity:
+  version: 0.7.6
+  import_remapping:
+    - "@openzeppelin/contracts=openzeppelin/v3.4.0"
+""",
+    "v1.4.1": """
+compile:
+  exclude:
+    - test
+    - examples
+    - interfaces
+
+dependencies:
+  - name: openzeppelin
+    github: OpenZeppelin/openzeppelin-contracts
+    version: 3.4.0
+
+solidity:
+  version: 0.7.6
+  import_remapping:
+    - "@openzeppelin/contracts=openzeppelin/v3.4.0"
+""",
+}
+
+
+def compile_version(version: str, override: bool):
+    dependency = project.dependencies.install(
+        name="safe-contracts",
+        github="safe-global/safe-smart-account",
+        version=version,
+        config_override=yaml.safe_load(VERSIONS[version]),
+    )
+    plugin_manifest_path = PLUGIN_MANIFEST_FOLDER / f"safe-{version}.json"
+    if not override and (plugin_manifest_path).is_file():
+        click.echo(f"Version '{version}' already exists, skipping.'")
+        return
+
+    if not dependency.compiled:
+        click.echo(f"Safe {version} not compiled, compiling...")
+        dependency.compile()
+
+    click.echo(
+        f"cp $HOME/{dependency.manifest_path.relative_to(Path.home())}"
+        f" ./{plugin_manifest_path.relative_to(Path.cwd())}"
+    )
+    plugin_manifest_path.write_text(dependency.manifest_path.read_text())
+
 
 @click.command()
 @click.option("--override", is_flag=True)
-def cli(override):
-    for version in project.dependencies["safe-contracts"]:
-        dependency = project.dependencies["safe-contracts"][version]
-        plugin_manifest_path = PLUGIN_MANIFEST_FOLDER / f"safe-{version}.json"
-
-        if plugin_manifest_path.is_file() and not override:
-            click.echo(f"Version '{version}' already exists, skipping.'")
-            continue
-
-        # OK to delete - either doesn't exist or override set.
-        plugin_manifest_path.unlink(missing_ok=True)
-
-        click.echo(
-            f"cp $HOME/{dependency.manifest_path.relative_to(Path.home())}"
-            f" ./{plugin_manifest_path.relative_to(Path.cwd())}"
-        )
-        shutil.copyfile(dependency.manifest_path, plugin_manifest_path)
+@click.argument(
+    "versions",
+    nargs=-1,
+    type=click.Choice(list(VERSIONS)),
+)
+def cli(override, versions):
+    """Build manifests for Safe protocol"""
+
+    for version in iter(versions or VERSIONS):
+        compile_version(version, override)