chore: update template to use puya-ts with binary puya backend (#30)

neilcampbell · web-flow · commit 429970da7814 · 2025-03-19T15:02:21.000+08:00
* chore: update template to use puya-ts with binary puya backend
diff --git a/README.md b/README.md
@@ -13,12 +13,7 @@
 
 This template provides a beta template for developing and deploying [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts) smart contracts.
 
-~~To use it [install AlgoKit](https://github.com/algorandfoundation/algokit-cli#readme) and then either pass in `-t typescript` to `algokit init` or select the `typescript` template.~~
-
-To use it run:
-```
-algokit init --template-url https://github.com/algorandfoundation/algokit-typescript-template --UNSAFE-SECURITY-accept-template-url
-```
+To use it [install AlgoKit](https://github.com/algorandfoundation/algokit-cli#readme) and then either pass in `-t typescript` to `algokit init` or select the `typescript` template.
 
 This is one of the official templates used by AlgoKit to initialize an Algorand smart contract project. It's a [Copier template](https://copier.readthedocs.io/en/stable/).
 
diff --git a/examples/production/.algokit.toml b/examples/production/.algokit.toml
@@ -1,5 +1,5 @@
 [algokit]
-min_version = "v2.0.0"
+min_version = "v2.6.0"
 
 [generate.smart-contract]
 description = "Generate a new smart contract for existing project"
diff --git a/examples/production/.github/workflows/production-ci.yaml b/examples/production/.github/workflows/production-ci.yaml
@@ -26,9 +26,6 @@ jobs:
       - name: Install algokit
         run: pipx install algokit
 
-      - name: Install Puya compiler
-        run: pipx install puyapy
-
       - name: Start LocalNet
         run: algokit localnet start
 
diff --git a/examples/production/README.md b/examples/production/README.md
@@ -25,7 +25,6 @@ Ensure the following pre-requisites are installed and properly configured:
 
 - **Docker**: Required for running a local Algorand network.
 - **AlgoKit CLI**: Essential for project setup and operations. Verify installation with `algokit --version`, expecting `2.5.0` or later.
-- **Puya Compiler**: Can be installed from PyPi by running `pipx install puyapy`. Verify installation with `puyapy --version`, expecting `4.4.4` or later.
 
 #### 3. Bootstrap Your Local Environment
 
diff --git a/examples/production/package.json b/examples/production/package.json
@@ -4,7 +4,7 @@
   "description": "Smart contract deployer",
   "main": "smart_contracts/index.ts",
   "scripts": {
-    "build": "puya-ts build smart_contracts --output-source-map --out-dir artifacts && algokit generate client smart_contracts/artifacts --output {app_spec_dir}/{contract_name}Client.ts",
+    "build": "algokit compile ts smart_contracts --output-source-map --out-dir artifacts && algokit generate client smart_contracts/artifacts --output {app_spec_dir}/{contract_name}Client.ts",
     "deploy": "ts-node-dev --transpile-only --watch .env -r dotenv/config smart_contracts/index.ts",
     "deploy:ci": "ts-node --transpile-only -r dotenv/config smart_contracts/index.ts",
     "lint": "eslint smart_contracts",
@@ -20,13 +20,13 @@
     "npm": ">=9.0"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.20"
+    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.25"
   },
   "devDependencies": {
-    "@algorandfoundation/algokit-client-generator": "^4.0.8",
-    "@algorandfoundation/algokit-utils": "^8.2.1",
+    "@algorandfoundation/algokit-client-generator": "^4.0.9",
+    "@algorandfoundation/algokit-utils": "^8.2.2",
     "@algorandfoundation/algokit-utils-debug": "^1.0.3",
-    "@algorandfoundation/puya-ts": "^1.0.0-beta.34",
+    "@algorandfoundation/puya-ts": "^1.0.0-beta.50",
     "@rollup/plugin-typescript": "^12.1.2",
     "@tsconfig/node22": "^22.0.0",
     "algosdk": "^3.0.0",
@@ -37,7 +37,7 @@
     "typescript-eslint": "^8.19.1",
     "prettier": "^3.4.2",
     "ts-node-dev": "^2.0.0",
-    "@algorandfoundation/algorand-typescript-testing": "^1.0.0-beta.27",
+    "@algorandfoundation/algorand-typescript-testing": "^1.0.0-beta.30",
     "vitest": "^2.1.8",
     "@vitest/coverage-v8": "^2.1.8",
     "typescript": "^5.7.3"
diff --git a/examples/starter/.algokit.toml b/examples/starter/.algokit.toml
@@ -1,5 +1,5 @@
 [algokit]
-min_version = "v2.0.0"
+min_version = "v2.6.0"
 
 [generate.smart-contract]
 description = "Generate a new smart contract for existing project"
diff --git a/examples/starter/README.md b/examples/starter/README.md
@@ -23,7 +23,6 @@ Ensure the following pre-requisites are installed and properly configured:
 
 - **Docker**: Required for running a local Algorand network.
 - **AlgoKit CLI**: Essential for project setup and operations. Verify installation with `algokit --version`, expecting `2.5.0` or later.
-- **Puya Compiler**: Can be installed from PyPi by running `pipx install puyapy`. Verify installation with `puyapy --version`, expecting `4.4.4` or later.
 
 #### 3. Bootstrap Your Local Environment
 Run the following commands within the project folder:
diff --git a/examples/starter/package.json b/examples/starter/package.json
@@ -4,7 +4,7 @@
   "description": "Smart contract deployer",
   "main": "smart_contracts/index.ts",
   "scripts": {
-    "build": "puya-ts build smart_contracts --output-source-map --out-dir artifacts && algokit generate client smart_contracts/artifacts --output {app_spec_dir}/{contract_name}Client.ts",
+    "build": "algokit compile ts smart_contracts --output-source-map --out-dir artifacts && algokit generate client smart_contracts/artifacts --output {app_spec_dir}/{contract_name}Client.ts",
     "deploy": "ts-node-dev --transpile-only --watch .env -r dotenv/config smart_contracts/index.ts",
     "deploy:ci": "ts-node --transpile-only -r dotenv/config smart_contracts/index.ts",
     "check-types": "tsc --noEmit"
@@ -14,13 +14,13 @@
     "npm": ">=9.0"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.20"
+    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.25"
   },
   "devDependencies": {
-    "@algorandfoundation/algokit-client-generator": "^4.0.8",
-    "@algorandfoundation/algokit-utils": "^8.2.1",
+    "@algorandfoundation/algokit-client-generator": "^4.0.9",
+    "@algorandfoundation/algokit-utils": "^8.2.2",
     "@algorandfoundation/algokit-utils-debug": "^1.0.3",
-    "@algorandfoundation/puya-ts": "^1.0.0-beta.34",
+    "@algorandfoundation/puya-ts": "^1.0.0-beta.50",
     "@rollup/plugin-typescript": "^12.1.2",
     "@tsconfig/node22": "^22.0.0",
     "algosdk": "^3.0.0",
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,7 +19,6 @@ mypy = "^1.15.0"
 pre-commit = "^4.0.1"
 types-pyyaml = "^6.0.12.9"
 pytest-xdist = "^3.3.1"
-puyapy = "^4.4.4"
 
 [build-system]
 requires = ["poetry-core"]
diff --git a/template_content/.algokit.toml.jinja b/template_content/.algokit.toml.jinja
@@ -1,5 +1,5 @@
 [algokit]
-min_version = "v2.0.0"
+min_version = "v2.6.0"
 
 [generate.smart-contract]
 description = "Generate a new smart contract for existing project"
diff --git a/template_content/README.md.jinja b/template_content/README.md.jinja
@@ -23,7 +23,6 @@ Ensure the following pre-requisites are installed and properly configured:
 
 - **Docker**: Required for running a local Algorand network.
 - **AlgoKit CLI**: Essential for project setup and operations. Verify installation with `algokit --version`, expecting `2.5.0` or later.
-- **Puya Compiler**: Can be installed from PyPi by running `pipx install puyapy`. Verify installation with `puyapy --version`, expecting `4.4.4` or later.
 
 #### 3. Bootstrap Your Local Environment
 Run the following commands within the project folder:
diff --git a/template_content/package.json.jinja b/template_content/package.json.jinja
@@ -4,7 +4,7 @@
   "description": "Smart contract deployer",
   "main": "smart_contracts/index.ts",
   "scripts": {
-    "build": "puya-ts build smart_contracts --output-source-map --out-dir artifacts && algokit generate client smart_contracts/artifacts --output {app_spec_dir}/{contract_name}Client.ts",
+    "build": "algokit compile ts smart_contracts --output-source-map --out-dir artifacts && algokit generate client smart_contracts/artifacts --output {app_spec_dir}/{contract_name}Client.ts",
     "deploy": "ts-node-dev --transpile-only --watch .env -r dotenv/config smart_contracts/index.ts",
     "deploy:ci": "ts-node --transpile-only -r dotenv/config smart_contracts/index.ts",
     {%- if use_linter  %}
@@ -28,13 +28,13 @@
     "npm": ">=9.0"
   },
   "dependencies": {
-    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.20"
+    "@algorandfoundation/algorand-typescript": "^1.0.0-beta.25"
   },
   "devDependencies": {
-    "@algorandfoundation/algokit-client-generator": "^4.0.8",
-    "@algorandfoundation/algokit-utils": "^8.2.1",
+    "@algorandfoundation/algokit-client-generator": "^4.0.9",
+    "@algorandfoundation/algokit-utils": "^8.2.2",
     "@algorandfoundation/algokit-utils-debug": "^1.0.3",
-    "@algorandfoundation/puya-ts": "^1.0.0-beta.34",
+    "@algorandfoundation/puya-ts": "^1.0.0-beta.50",
     "@rollup/plugin-typescript": "^12.1.2",
     "@tsconfig/node22": "^22.0.0",
     "algosdk": "^3.0.0",
@@ -52,7 +52,7 @@
     {%- endif %}
     "ts-node-dev": "^2.0.0",
     {%- if use_vitest  %}
-    "@algorandfoundation/algorand-typescript-testing": "^1.0.0-beta.27",
+    "@algorandfoundation/algorand-typescript-testing": "^1.0.0-beta.30",
     "vitest": "^2.1.8",
     "@vitest/coverage-v8": "^2.1.8",
     {%- endif %}
diff --git a/template_content/{% if use_github_actions %}.github{% endif %}/workflows/{% include pathjoin('includes', 'project_name_kebab.jinja') %}-ci.yaml.jinja b/template_content/{% if use_github_actions %}.github{% endif %}/workflows/{% include pathjoin('includes', 'project_name_kebab.jinja') %}-ci.yaml.jinja
@@ -29,9 +29,6 @@ jobs:
       - name: Install algokit
         run: pipx install algokit
 
-      - name: Install Puya compiler
-        run: pipx install puyapy
-
       - name: Start LocalNet
         run: algokit localnet start
 
diff --git a/tests/test_templates.py b/tests/test_templates.py
