Beaker & PyTeal deprecation

.gitignore

@@ -170,4 +170,4 @@ node_modules
 
 smart_contracts/coverage/
 
-examples/*/client_generated.py
+examples/smart_contracts/artifacts/*/client_generated.py

README.md

@@ -36,7 +36,7 @@ algokit generate client path/to/application.json --output path/to/output/client_
 
 ## Examples
 
-There are a range of [examples](./examples) that you can look at to see a source smart contract (e.g. `{contract.py}`), the generated client (`client_generated.py`) and some tests that demonstrate how you can use the client (`test_client.py`).
+There are a range of [examples](./examples) that you can look at to see a source smart contract (e.g. `{app_name}/contract.py`), the generated client (`artifacts/{app_name}/{app_name}_client.py`) and some tests that demonstrate how you can use the client (`tests/{app_name}_test_client.py`).
 
 ## Contributing
 
@@ -72,9 +72,11 @@ If you want to contribute to this project the following information will be help
 
 ### Building examples
 
-In the `examples` folder there is a series of example contracts along with their generated client. These contracts are written in various languages including [Algorand Python](https://github.com/algorandfoundation/puya), [TealScript](https://github.com/algorandfoundation/TEALScript) and [Beaker](https://github.com/algorandfoundation/beaker) (for backwards compatibility with ARC-32 and previous versions of the generator).
+In the `examples` folder there is a series of example contracts along with their generated client. These contracts are originally written in various languages including [Algorand Python](https://github.com/algorandfoundation/puya), [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts), and [TealScript](https://github.com/algorandfoundation/TEALScript).
 
-If you want to make changes to any of the smart contract examples and re-generate the ARC-32/56 application.json files then change the corresponding `examples/{contract}/{contract}.py` file and then run:
+Some contracts are directly imported through the ARC-32/56 app spec and not through contract source code.
+
+If you want to make changes to any of the smart contract examples and re-generate the ARC-32/56 JSON specs files then change the corresponding `examples/smart_contracts/{app_name}/contract.py` file and then run:
 
 ```
 poetry run python -m examples
@@ -84,6 +86,8 @@ Or in Visual Studio Code you can use the default build task (Ctrl+Shift+B).
 
 To regenerate the generated clients run `poetry run poe update-approvals`.
 
+This package currently depends on Python 3.10, however the development depends on Python 3.12. This is represented by the `pyproject.toml` file which requires 3.10 with additional requirements on dev dependencies.
+
 ### Continuous Integration / Continuous Deployment (CI/CD)
 
 This project uses [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) to define CI/CD workflows, which are located in the [`.github/workflows`](./.github/workflows) folder.

examples/__main__.py

@@ -1,63 +1,59 @@
-import importlib
-import json
 import logging
-import os
-from collections.abc import Generator
-from contextlib import contextmanager
+import pathlib
+import subprocess
+from itertools import chain, product
 from pathlib import Path
 
-import algokit_utils
-
-logging.basicConfig(
-    level=logging.DEBUG, format="%(asctime)s %(levelname)-10s: %(message)s"
-)
+logging.basicConfig(level=logging.DEBUG, format="%(asctime)s %(levelname)-10s: %(message)s")
 logger = logging.getLogger(__name__)
 root_path = Path(__file__).parent
 
 
-@contextmanager
-def cwd(path: Path) -> Generator[None, None, None]:
-    old_pwd = Path.cwd()
-    os.chdir(path)
-    try:
-        yield
-    finally:
-        os.chdir(old_pwd)
-
-
-def to_json(app_spec: algokit_utils.ApplicationSpecification) -> str:
-    app_spec_dict = app_spec.dictify()
-    # beaker always outputs an empty string by default for the schema "descr" field, however this field is optional
-    # so remove these keys if they are an empty string so optional descr fields are covered
-    for scope in ("global", "local"):
-        for reservation in ("declared", "reserved"):
-            state_dict = app_spec_dict["schema"][scope][reservation]
-            for _field, field_spec in state_dict.items():
-                if not field_spec.get("descr"):
-                    del field_spec["descr"]
-    return json.dumps(app_spec_dict, indent=4)
-
-
 def main() -> None:
-    example_dirs = filter(
-        lambda file: file.is_dir() and "__" not in file.name, root_path.glob("*")
-    )
-    for example in example_dirs:
+    smart_contracts = pathlib.Path(__file__).parent / "smart_contracts"
+    artifacts = smart_contracts / "artifacts"
+    output_options = {
+        "arc32": ["--output-arc32", "--no-output-arc56"],
+        "arc56": ["--output-arc56", "--no-output-arc32"],
+    }
+    arc32_apps = [
+        "duplicate_structs",
+        "hello_world",
+        "life_cycle",
+        "minimal",
+        "state",
+        "voting_round",
+    ]
+    arc56_apps = [
+        "structs",
+        "nested",
+    ]
+
+    for app, options in chain(
+        product(arc32_apps, [output_options["arc32"]]), product(arc56_apps, [output_options["arc56"]])
+    ):
+        app_path = smart_contracts / app / "contract.py"
+        app_artifacts = artifacts / app
         try:
-            logger.info(f"Building example {example.name}")
-            with cwd(root_path):
-                evaluated_file = importlib.import_module(
-                    f"examples.{example.name}.{example.name}"
-                )
-            app = evaluated_file.app
-            logger.info(f"  Building app {app.name}")
-            app_spec = app.build()
-            logger.info(f"  Writing {example.name}/application.json")
-            (example / "application.json").write_text(
-                to_json(app_spec), encoding="utf-8"
+            subprocess.run(
+                [
+                    "algokit",
+                    "--no-color",
+                    "compile",
+                    "python",
+                    app_path.absolute(),
+                    f"--out-dir={app_artifacts}",
+                    "--no-output-teal",
+                    "--no-output-source-map",
+                ]
+                + options,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.STDOUT,
+                text=True,
+                check=True,
             )
         except Exception as e:
-            logger.warning(f"Skipping example {example.name} due to error: {e}")
+            print(f"Error compiling contract for app {app}: {e}")
 
 
 if __name__ == "__main__":