feat: improve testnet and mainnet deployment experience (#31)

algorandfoundation · Jun 26, 2023 · 2a5085b · 2a5085b
1 parent 2189b53
commit 2a5085b
Show file tree

Hide file tree

Showing 73 changed files with 651 additions and 771 deletions.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 beaker-pyteal = "^1.0.0"
-algokit-utils = {version = "^1.2.0b8", allow-prereleases = true}
+algokit-utils = "^1.3"
 python-dotenv = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]

diff --git a/template_content/pyproject.toml.jinja b/template_content/pyproject.toml.jinja
@@ -8,7 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 beaker-pyteal = "^1.0.0"
-algokit-utils = "^1.2"
+algokit-utils = "^1.3"
 python-dotenv = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]

diff --git a/...late_content/smart_contracts/{% if deployment_language == 'python' %}config.py{% endif %} b/...late_content/smart_contracts/{% if deployment_language == 'python' %}config.py{% endif %}
@@ -1,15 +1,6 @@
 import logging
 
-from algokit_utils import (
-    Account,
-    ApplicationSpecification,
-    OnSchemaBreak,
-    OnUpdate,
-    OperationPerformed,
-    TransferParameters,
-    is_localnet,
-    transfer,
-)
+import algokit_utils
 from algosdk.util import algos_to_microalgos
 from algosdk.v2client.algod import AlgodClient
 from algosdk.v2client.indexer import IndexerClient
@@ -21,14 +12,15 @@ logger = logging.getLogger(__name__)
 # define contracts to build and/or deploy
 contracts = [helloworld.app]
 
+
 # define deployment behaviour based on supplied app spec
 def deploy(
     algod_client: AlgodClient,
     indexer_client: IndexerClient,
-    app_spec: ApplicationSpecification,
-    deployer: Account,
+    app_spec: algokit_utils.ApplicationSpecification,
+    deployer: algokit_utils.Account,
 ) -> None:
-    is_local = is_localnet(algod_client)
+    is_mainnet = algokit_utils.is_mainnet(algod_client)
     match app_spec.contract.name:
         case "HelloWorldApp":
             from smart_contracts.artifacts.HelloWorldApp.client import (
@@ -42,19 +34,23 @@ def deploy(
             )
             deploy_response = app_client.deploy(
                 on_schema_break=(
-                    OnSchemaBreak.ReplaceApp if is_local else OnSchemaBreak.Fail
+                    algokit_utils.OnSchemaBreak.AppendApp
+                    if is_mainnet
+                    else algokit_utils.OnSchemaBreak.ReplaceApp
                 ),
-                on_update=OnUpdate.UpdateApp if is_local else OnUpdate.Fail,
-                allow_delete=is_local,
-                allow_update=is_local,
+                on_update=algokit_utils.OnUpdate.AppendApp
+                if is_mainnet
+                else algokit_utils.OnUpdate.UpdateApp,
+                allow_delete=not is_mainnet,
+                allow_update=not is_mainnet,
             )
 
             # if only just created, fund smart contract account
             if deploy_response.action_taken in [
-                OperationPerformed.Create,
-                OperationPerformed.Replace,
+                algokit_utils.OperationPerformed.Create,
+                algokit_utils.OperationPerformed.Replace,
             ]:
-                transfer_parameters = TransferParameters(
+                transfer_parameters = algokit_utils.TransferParameters(
                     from_account=deployer,
                     to_address=app_client.app_address,
                     micro_algos=algos_to_microalgos(1),
@@ -63,7 +59,7 @@ def deploy(
                     f"New app created, funding with "
                     f"{transfer_parameters.micro_algos}µ algos"
                 )
-                transfer(algod_client, transfer_parameters)
+                algokit_utils.transfer(algod_client, transfer_parameters)
 
             name = "world"
             response = app_client.hello(name=name)

diff --git a/...t/smart_contracts/{% if deployment_language == 'typescript' %}deploy-config.ts{% endif %} b/...t/smart_contracts/{% if deployment_language == 'typescript' %}deploy-config.ts{% endif %}
@@ -17,7 +17,7 @@ export async function deploy(name: (typeof contracts)[number], appSpec: AppSpec)
     },
     algod,
   )
-  const isLocal = await algokit.isLocalNet(algod)
+  const isMainNet = await algokit.isMainNet(algod)
   const appClient = new HelloWorldAppClient(
     {
       resolveBy: 'creatorAndName',
@@ -32,10 +32,10 @@ export async function deploy(name: (typeof contracts)[number], appSpec: AppSpec)
     // Edit this to add the custom deployment logic for each contract
     case 'HelloWorldApp':
       const app = await appClient.deploy({
-        allowDelete: isLocal,
-        allowUpdate: isLocal,
-        onSchemaBreak: isLocal ? 'replace' : 'fail',
-        onUpdate: isLocal ? 'update' : 'fail',
+        allowDelete: !isMainNet,
+        allowUpdate: !isMainNet,
+        onSchemaBreak: isMainNet ? 'append' : 'replace',
+        onUpdate: isMainNet ? 'append' : 'update',
       })
       // If app was just created fund the app account
       if (['create', 'replace'].includes(app.operationPerformed)) {

diff --git a/...smart_contracts/{% if deployment_language == 'typescript' %}package.json{% endif %}.jinja b/...smart_contracts/{% if deployment_language == 'typescript' %}package.json{% endif %}.jinja
@@ -9,7 +9,7 @@
     "format": "prettier --write ."
   },
   "dependencies": {
-    "@algorandfoundation/algokit-utils": "^2.0.0"
+    "@algorandfoundation/algokit-utils": "^2.2.1"
   },
   "devDependencies": {
     "dotenv": "^16.0.3",

diff --git a/tests_generated/test_default_parameters/pyproject.toml b/tests_generated/test_default_parameters/pyproject.toml
@@ -8,7 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 beaker-pyteal = "^1.0.0"
-algokit-utils = "^1.2"
+algokit-utils = "^1.3"
 python-dotenv = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]

diff --git a/tests_generated/test_default_parameters/smart_contracts/config.py b/tests_generated/test_default_parameters/smart_contracts/config.py
@@ -1,15 +1,6 @@
 import logging
 
-from algokit_utils import (
-    Account,
-    ApplicationSpecification,
-    OnSchemaBreak,
-    OnUpdate,
-    OperationPerformed,
-    TransferParameters,
-    is_localnet,
-    transfer,
-)
+import algokit_utils
 from algosdk.util import algos_to_microalgos
 from algosdk.v2client.algod import AlgodClient
 from algosdk.v2client.indexer import IndexerClient
@@ -21,14 +12,15 @@
 # define contracts to build and/or deploy
 contracts = [helloworld.app]
 
+
 # define deployment behaviour based on supplied app spec
 def deploy(
     algod_client: AlgodClient,
     indexer_client: IndexerClient,
-    app_spec: ApplicationSpecification,
-    deployer: Account,
+    app_spec: algokit_utils.ApplicationSpecification,
+    deployer: algokit_utils.Account,
 ) -> None:
-    is_local = is_localnet(algod_client)
+    is_mainnet = algokit_utils.is_mainnet(algod_client)
     match app_spec.contract.name:
         case "HelloWorldApp":
             from smart_contracts.artifacts.HelloWorldApp.client import (
@@ -42,19 +34,23 @@ def deploy(
             )
             deploy_response = app_client.deploy(
                 on_schema_break=(
-                    OnSchemaBreak.ReplaceApp if is_local else OnSchemaBreak.Fail
+                    algokit_utils.OnSchemaBreak.AppendApp
+                    if is_mainnet
+                    else algokit_utils.OnSchemaBreak.ReplaceApp
                 ),
-                on_update=OnUpdate.UpdateApp if is_local else OnUpdate.Fail,
-                allow_delete=is_local,
-                allow_update=is_local,
+                on_update=algokit_utils.OnUpdate.AppendApp
+                if is_mainnet
+                else algokit_utils.OnUpdate.UpdateApp,
+                allow_delete=not is_mainnet,
+                allow_update=not is_mainnet,
             )
 
             # if only just created, fund smart contract account
             if deploy_response.action_taken in [
-                OperationPerformed.Create,
-                OperationPerformed.Replace,
+                algokit_utils.OperationPerformed.Create,
+                algokit_utils.OperationPerformed.Replace,
             ]:
-                transfer_parameters = TransferParameters(
+                transfer_parameters = algokit_utils.TransferParameters(
                     from_account=deployer,
                     to_address=app_client.app_address,
                     micro_algos=algos_to_microalgos(1),
@@ -63,7 +59,7 @@ def deploy(
                     f"New app created, funding with "
                     f"{transfer_parameters.micro_algos}µ algos"
                 )
-                transfer(algod_client, transfer_parameters)
+                algokit_utils.transfer(algod_client, transfer_parameters)
 
             name = "world"
             response = app_client.hello(name=name)

diff --git a/tests_generated/test_deployment_language-python/pyproject.toml b/tests_generated/test_deployment_language-python/pyproject.toml
@@ -8,7 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 beaker-pyteal = "^1.0.0"
-algokit-utils = "^1.2"
+algokit-utils = "^1.3"
 python-dotenv = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]

diff --git a/tests_generated/test_deployment_language-python/smart_contracts/config.py b/tests_generated/test_deployment_language-python/smart_contracts/config.py
@@ -1,15 +1,6 @@
 import logging
 
-from algokit_utils import (
-    Account,
-    ApplicationSpecification,
-    OnSchemaBreak,
-    OnUpdate,
-    OperationPerformed,
-    TransferParameters,
-    is_localnet,
-    transfer,
-)
+import algokit_utils
 from algosdk.util import algos_to_microalgos
 from algosdk.v2client.algod import AlgodClient
 from algosdk.v2client.indexer import IndexerClient
@@ -21,14 +12,15 @@
 # define contracts to build and/or deploy
 contracts = [helloworld.app]
 
+
 # define deployment behaviour based on supplied app spec
 def deploy(
     algod_client: AlgodClient,
     indexer_client: IndexerClient,
-    app_spec: ApplicationSpecification,
-    deployer: Account,
+    app_spec: algokit_utils.ApplicationSpecification,
+    deployer: algokit_utils.Account,
 ) -> None:
-    is_local = is_localnet(algod_client)
+    is_mainnet = algokit_utils.is_mainnet(algod_client)
     match app_spec.contract.name:
         case "HelloWorldApp":
             from smart_contracts.artifacts.HelloWorldApp.client import (
@@ -42,19 +34,23 @@ def deploy(
             )
             deploy_response = app_client.deploy(
                 on_schema_break=(
-                    OnSchemaBreak.ReplaceApp if is_local else OnSchemaBreak.Fail
+                    algokit_utils.OnSchemaBreak.AppendApp
+                    if is_mainnet
+                    else algokit_utils.OnSchemaBreak.ReplaceApp
                 ),
-                on_update=OnUpdate.UpdateApp if is_local else OnUpdate.Fail,
-                allow_delete=is_local,
-                allow_update=is_local,
+                on_update=algokit_utils.OnUpdate.AppendApp
+                if is_mainnet
+                else algokit_utils.OnUpdate.UpdateApp,
+                allow_delete=not is_mainnet,
+                allow_update=not is_mainnet,
             )
 
             # if only just created, fund smart contract account
             if deploy_response.action_taken in [
-                OperationPerformed.Create,
-                OperationPerformed.Replace,
+                algokit_utils.OperationPerformed.Create,
+                algokit_utils.OperationPerformed.Replace,
             ]:
-                transfer_parameters = TransferParameters(
+                transfer_parameters = algokit_utils.TransferParameters(
                     from_account=deployer,
                     to_address=app_client.app_address,
                     micro_algos=algos_to_microalgos(1),
@@ -63,7 +59,7 @@ def deploy(
                     f"New app created, funding with "
                     f"{transfer_parameters.micro_algos}µ algos"
                 )
-                transfer(algod_client, transfer_parameters)
+                algokit_utils.transfer(algod_client, transfer_parameters)
 
             name = "world"
             response = app_client.hello(name=name)

diff --git a/tests_generated/test_deployment_language-typescript/pyproject.toml b/tests_generated/test_deployment_language-typescript/pyproject.toml
@@ -8,7 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 beaker-pyteal = "^1.0.0"
-algokit-utils = "^1.2"
+algokit-utils = "^1.3"
 python-dotenv = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]

diff --git a/tests_generated/test_deployment_language-typescript/smart_contracts/deploy-config.ts b/tests_generated/test_deployment_language-typescript/smart_contracts/deploy-config.ts
@@ -17,7 +17,7 @@ export async function deploy(name: (typeof contracts)[number], appSpec: AppSpec)
     },
     algod,
   )
-  const isLocal = await algokit.isLocalNet(algod)
+  const isMainNet = await algokit.isMainNet(algod)
   const appClient = new HelloWorldAppClient(
     {
       resolveBy: 'creatorAndName',
@@ -32,10 +32,10 @@ export async function deploy(name: (typeof contracts)[number], appSpec: AppSpec)
     // Edit this to add the custom deployment logic for each contract
     case 'HelloWorldApp':
       const app = await appClient.deploy({
-        allowDelete: isLocal,
-        allowUpdate: isLocal,
-        onSchemaBreak: isLocal ? 'replace' : 'fail',
-        onUpdate: isLocal ? 'update' : 'fail',
+        allowDelete: !isMainNet,
+        allowUpdate: !isMainNet,
+        onSchemaBreak: isMainNet ? 'append' : 'replace',
+        onUpdate: isMainNet ? 'append' : 'update',
       })
       // If app was just created fund the app account
       if (['create', 'replace'].includes(app.operationPerformed)) {

diff --git a/tests_generated/test_deployment_language-typescript/smart_contracts/package.json b/tests_generated/test_deployment_language-typescript/smart_contracts/package.json
@@ -9,7 +9,7 @@
     "format": "prettier --write ."
   },
   "dependencies": {
-    "@algorandfoundation/algokit-utils": "^2.0.0"
+    "@algorandfoundation/algokit-utils": "^2.2.1"
   },
   "devDependencies": {
     "dotenv": "^16.0.3",

diff --git a/tests_generated/test_ide_vscode-False/pyproject.toml b/tests_generated/test_ide_vscode-False/pyproject.toml
@@ -8,7 +8,7 @@ readme = "README.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 beaker-pyteal = "^1.0.0"
-algokit-utils = "^1.2"
+algokit-utils = "^1.3"
 python-dotenv = "^1.0.0"
 
 [tool.poetry.group.dev.dependencies]