chore: udpated examples

lempira · lempira · commit 97b28fc3f10d · 2025-03-25T22:49:29.000+01:00
diff --git a/examples/production/.github/workflows/production-cd.yaml b/examples/production/.github/workflows/production-cd.yaml
@@ -11,7 +11,7 @@ jobs:
     name: Validate production
     uses: ./.github/workflows/production-ci.yaml
   deploy-testnet:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     needs: validate
     environment: contract-testnet
     steps:
@@ -28,13 +28,13 @@ jobs:
       - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version: "3.12"
 
       - name: Install algokit
         run: pipx install algokit
 
       - name: Bootstrap dependencies
-        run: algokit project bootstrap all
+        run: algokit project bootstrap all 
 
       - name: Configure git
         shell: bash
@@ -43,7 +43,7 @@ jobs:
           git config --global user.email "actions@github.com" && git config --global user.name "github-actions"
 
       - name: Deploy to testnet
-        run: algokit project deploy testnet
+        run: algokit project deploy testnet 
         env:
           # This is the account that becomes the creator of the contract
           DEPLOYER_MNEMONIC: ${{ secrets.DEPLOYER_MNEMONIC }}
diff --git a/examples/production/.github/workflows/production-ci.yaml b/examples/production/.github/workflows/production-ci.yaml
@@ -6,7 +6,7 @@ on:
 
 jobs:
   validate:
-    runs-on: 'ubuntu-latest'
+    runs-on: "ubuntu-latest"
     steps:
       - name: Checkout source code
         uses: actions/checkout@v4
@@ -16,12 +16,12 @@ jobs:
         with:
           node-version: '22.x'
           cache: 'npm'
-          cache-dependency-path: '**/package-lock.json'
+          cache-dependency-path: "**/package-lock.json"
 
       - name: Set up Python 3.12
         uses: actions/setup-python@v5
         with:
-          python-version: '3.12'
+          python-version: "3.12"
 
       - name: Install algokit
         run: pipx install algokit
@@ -30,38 +30,44 @@ jobs:
         run: algokit localnet start
 
       - name: Bootstrap dependencies
-        run: algokit project bootstrap all
+        run: algokit project bootstrap all 
 
       - name: Configure git
         shell: bash
         run: |
           # set git user and email as test invoke git
           git config --global user.email "actions@github.com" && git config --global user.name "github-actions"
 
+
       - name: Audit dependencies
-        run: algokit project run audit
+        run: algokit project run audit 
+
+
 
       - name: Lint and format
-        run: algokit project run lint
+        run: algokit project run lint 
+
+
 
       - name: Run tests
         shell: bash
         run: |
           set -o pipefail
-          algokit project run test
+          algokit project run test 
+
 
       - name: Build smart contracts
-        run: algokit project run build
+        run: algokit project run build 
 
       - name: Scan TEAL files for issues
-        run: algokit project run audit-teal
+        run: algokit project run audit-teal 
 
       # # Uncomment to enable TEAL static analysis with snapshoting using Tealer package
       # # Would first require running locally using audit-teal command and committing the snapshots into source control
       # # Please note, tealer has a known bug that may result in large snapshot file sizes, track resolution here:
       # # https://github.com/crytic/tealer/issues/101
       # - name: Check output stability of the smart contracts
-      #   run: algokit project run ci-teal-diff
+      #   run: algokit project run ci-teal-diff 
 
       - name: Run deployer against LocalNet
-        run: algokit project deploy localnet
+        run: algokit project deploy localnet 
diff --git a/examples/production/.vscode/launch.json b/examples/production/.vscode/launch.json
@@ -45,8 +45,8 @@
       "runtimeArgs": ["run", "build"],
       "cwd": "${workspaceFolder}",
       "console": "integratedTerminal",
-      "skipFiles": ["<node_internals>/**", "node_modules/**"]
-    },
+      "skipFiles": ["<node_internals>/**", "node_modules/**"],
+    },    
     {
       "type": "avm",
       "request": "launch",
diff --git a/examples/production/.vscode/settings.json b/examples/production/.vscode/settings.json
@@ -15,4 +15,4 @@
     "extensions": [".ts"]
   },
   "eslint.workingDirectories": ["./smart_contracts"]
-}
+  }
diff --git a/examples/production/README.md b/examples/production/README.md
@@ -16,18 +16,15 @@ This project has been generated using AlgoKit. See below for default getting sta
 ### Initial Setup
 
 #### 1. Clone the Repository
-
 Start by cloning this repository to your local machine.
 
 #### 2. Install Pre-requisites
-
 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.6.0` or later.
 
 #### 3. Bootstrap Your Local Environment
-
 Run the following commands within the project folder:
 
 - **Setup Project**: Execute `algokit project bootstrap all` to install dependencies and setup npm dependencies.
@@ -37,16 +34,14 @@ Run the following commands within the project folder:
 ### Development Workflow
 
 #### Terminal
-
 Directly manage and interact with your project using AlgoKit commands:
 
 1. **Build Contracts**: `algokit project run build` compiles all smart contracts. You can also specify a specific contract by passing the name of the contract folder as an extra argument.
-   For example: `algokit project run build -- hello_world` will only build the `hello_world` contract.
+For example: `algokit project run build -- hello_world` will only build the `hello_world` contract.
 2. **Deploy**: Use `algokit project deploy localnet` to deploy contracts to the local network. You can also specify a specific contract by passing the name of the contract folder as an extra argument.
-   For example: `algokit project deploy localnet -- hello_world` will only deploy the `hello_world` contract.
-
-#### VS Code
+For example: `algokit project deploy localnet -- hello_world` will only deploy the `hello_world` contract.
 
+#### VS Code 
 For a seamless experience with breakpoint debugging and other features:
 
 1. **Open Project**: In VS Code, open the repository root.
@@ -55,22 +50,20 @@ For a seamless experience with breakpoint debugging and other features:
    - Use `F5` to start debugging.
 
 #### JetBrains IDEs
-
 While primarily optimized for VS Code, JetBrains IDEs are supported:
 
 1. **Open Project**: In your JetBrains IDE, open the repository root.
 2. **Automatic Setup**: The IDE should configure the Node.js environment.
 3. **Debugging**: Use `Shift+F10` or `Ctrl+R` to start debugging. Note: Windows users may encounter issues with pre-launch tasks due to a known bug. See [JetBrains forums](https://youtrack.jetbrains.com/issue/IDEA-277486/Shell-script-configuration-cannot-run-as-before-launch-task) for workarounds.
 
 ## AlgoKit Workspaces and Project Management
-
 This project supports both standalone and monorepo setups through AlgoKit workspaces. Leverage [`algokit project run`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/run.md) commands for efficient monorepo project orchestration and management across multiple projects within a workspace.
 
 ## AlgoKit Generators
 
 This template provides a set of [algokit generators](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/generate.md) that allow you to further modify the project instantiated from the template to fit your needs, as well as giving you a base to build your own extensions to invoke via the `algokit generate` command.
 
-### Generate Smart Contract
+### Generate Smart Contract 
 
 By default the template creates a single `HelloWorld` contract under hello_world folder in the `smart_contracts` directory. To add a new contract:
 
@@ -82,7 +75,7 @@ By default the template creates a single `HelloWorld` contract under hello_world
 
 ### Generate '.env' files
 
-By default the template instance does not contain any env files to deploy to different networks. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`.
+By default the template instance does not contain any env files to deploy to different networks. Using [`algokit project deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/deploy.md) against `localnet` | `testnet` | `mainnet` will use default values for `algod` and `indexer` unless overwritten via `.env` or `.env.{target_network}`. 
 
 To generate a new `.env` or `.env.{target_network}` file, run `algokit generate env-file`
 
@@ -92,6 +85,7 @@ This project is optimized to work with AlgoKit AVM Debugger extension. To activa
 
 Refer to the commented header in the `index.ts` file in the `smart_contracts` folder.Since you have opted in to include VSCode launch configurations in your project, you can also use the `Debug TEAL via AlgoKit AVM Debugger` launch configuration to interactively select an available trace file and launch the debug session for your smart contract.
 
+
 For information on using and setting up the `AlgoKit AVM Debugger` VSCode extension refer [here](https://github.com/algorandfoundation/algokit-avm-vscode-debugger). To install the extension from the VSCode Marketplace, use the following link: [AlgoKit AVM Debugger extension](https://marketplace.visualstudio.com/items?itemName=algorandfoundation.algokit-avm-vscode-debugger).### 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.
@@ -104,43 +98,41 @@ To define custom `algokit project run` commands refer to [documentation](https:/
 
 #### Setting up GitHub for CI/CD workflow and TestNet deployment
 
-1. Every time you have a change to your smart contract, and when you first initialize the project you need to [build the contract](#initial-setup) and then commit the `smart_contracts/artifacts` folder so the [output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests pass
-2. Decide what values you want to use for the `allowUpdate` and `allowDelete` parameters specified in [`deploy-config.ts`](./smart_contracts/hello_world/deploy-config.ts).
-   When deploying to LocalNet these values are both set to `true` for convenience. But for non-LocalNet networks
-   they are more conservative and use `false`
-   These default values will allow the smart contract to be deployed initially, but will not allow the app to be updated or deleted if is changed and the build will instead fail.
-   To help you decide it may be helpful to read the [AlgoKit Utils app deployment documentation](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/docs/capabilities/app-deploy.md) or the [AlgoKit smart contract deployment architecture](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md#upgradeable-and-deletable-contracts).
-3. Create a [Github Environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#creating-an-environment) named `Test`.
-   Note: If you have a private repository and don't have GitHub Enterprise then Environments won't work and you'll need to convert the GitHub Action to use a different approach. Ignore this step if you picked `Starter` preset.
-4. Create or obtain a mnemonic for an Algorand account for use on TestNet to deploy apps, referred to as the `DEPLOYER` account.
-5. Store the mnemonic as a [secret](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) `DEPLOYER_MNEMONIC`
-   in the Test environment created in step 3.
-6. The account used to deploy the smart contract will require enough funds to create the app, and also fund it. There are two approaches available here:
-   - Either, ensure the account is funded outside of CI/CD.
-     In Testnet, funds can be obtained by using the [Algorand TestNet dispenser](https://bank.testnet.algorand.network/) and we recommend provisioning 50 ALGOs.
-   - Or, fund the account as part of the CI/CD process by using a `DISPENSER_MNEMONIC` GitHub Environment secret to point to a separate `DISPENSER` account that you maintain ALGOs in (similarly, you need to provision ALGOs into this account using the [TestNet dispenser](https://bank.testnet.algorand.network/)).
+  1. Every time you have a change to your smart contract, and when you first initialize the project you need to [build the contract](#initial-setup) and then commit the `smart_contracts/artifacts` folder so the [output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md) tests pass
+  2. Decide what values you want to use for the `allowUpdate` and `allowDelete` parameters specified in [`deploy-config.ts`](./smart_contracts/hello_world/deploy-config.ts).
+     When deploying to LocalNet these values are both set to `true` for convenience. But for non-LocalNet networks
+     they are more conservative and use `false`
+     These default values will allow the smart contract to be deployed initially, but will not allow the app to be updated or deleted if is changed and the build will instead fail.
+     To help you decide it may be helpful to read the [AlgoKit Utils app deployment documentation](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/docs/capabilities/app-deploy.md) or the [AlgoKit smart contract deployment architecture](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/architecture-decisions/2023-01-12_smart-contract-deployment.md#upgradeable-and-deletable-contracts).
+  3. Create a [Github Environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#creating-an-environment) named `Test`.
+     Note: If you have a private repository and don't have GitHub Enterprise then Environments won't work and you'll need to convert the GitHub Action to use a different approach. Ignore this step if you picked `Starter` preset.
+  4. Create or obtain a mnemonic for an Algorand account for use on TestNet to deploy apps, referred to as the `DEPLOYER` account.
+  5. Store the mnemonic as a [secret](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) `DEPLOYER_MNEMONIC`
+     in the Test environment created in step 3.
+  6. The account used to deploy the smart contract will require enough funds to create the app, and also fund it. There are two approaches available here:
+     * Either, ensure the account is funded outside of CI/CD.
+       In Testnet, funds can be obtained by using the [Algorand TestNet dispenser](https://bank.testnet.algorand.network/) and we recommend provisioning 50 ALGOs.
+     * Or, fund the account as part of the CI/CD process by using a `DISPENSER_MNEMONIC` GitHub Environment secret to point to a separate `DISPENSER` account that you maintain ALGOs in (similarly, you need to provision ALGOs into this account using the [TestNet dispenser](https://bank.testnet.algorand.network/)).
 
 #### Continuous Integration
 
 For pull requests and pushes to `main` branch against this repository the following checks are automatically performed by GitHub Actions:
-
-- NPM dependencies are audited using [better-npm-audit](https://github.com/jeemok/better-npm-audit#readme)
-- Code formatting is performed using [Prettier](https://prettier.io/)
-- Linting is checked using [ESLint](https://eslint.org/)
+ - NPM dependencies are audited using [better-npm-audit](https://github.com/jeemok/better-npm-audit#readme)
+ - Code formatting is performed using [Prettier](https://prettier.io/)
+ - Linting is checked using [ESLint](https://eslint.org/)
 - The base framework for testing is [vitest](https://vitest.dev/), and the project includes two separate kinds of tests:
 - - `Algorand TypeScript` smart contract unit tests, that are run using [`algorand-typescript-testing`](https://github.com/algorandfoundation/algorand-typescript-testing), which are executed in a Node.js intepreter emulating major AVM behaviour
 - - End-to-end (e2e) `AppClient` tests that are run against `algokit localnet` and test the behaviour in a real network environment
-- Smart contract artifacts are built
-- Smart contract artifacts are checked for [output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md).
-- Smart contract is deployed to a AlgoKit LocalNet instance
+ - Smart contract artifacts are built
+ - Smart contract artifacts are checked for [output stability](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/articles/output_stability.md).
+ - Smart contract is deployed to a AlgoKit LocalNet instance
 
 > NOTE: By default smart contract artifacts are compiled with `--debug-level` set to 0, to change this, modify the compiler invocation under the `build` script in `package.json`
 
 #### Continuous Deployment
 
 For pushes to `main` branch, after the above checks pass, the following deployment actions are performed:
-
-- The smart contract(s) are deployed to TestNet using [AlgoNode](https://algonode.io).
+  - The smart contract(s) are deployed to TestNet using [AlgoNode](https://algonode.io).
 
 > Please note deployment is also performed via `algokit deploy` command which can be invoked both via CI as seen on this project, or locally. For more information on how to use `algokit deploy` please see [AlgoKit documentation](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/deploy.md).
 
@@ -159,6 +151,10 @@ This project makes use of Algorand TypeScript to build Algorand smart contracts.
 - [better-npm-audit](https://github.com/jeemok/better-npm-audit#readme): Tool for scanning JavaScript / TypeScript environments for packages with known vulnerabilities.
 - [pre-commit](https://pre-commit.com/): A framework for managing and maintaining multi-language pre-commit hooks, to enable pre-commit you need to run `pre-commit install` in the root of the repository. This will install the pre-commit hooks and run them against modified files when committing. If any of the hooks fail, the commit will be aborted. To run the hooks on all files, use `pre-commit run --all-files`.
 
+
 It has also been configured to have a productive dev experience out of the box in [VS Code](https://code.visualstudio.com/), see the [.vscode](./.vscode) folder.
 
+
+
 It has also been configured to have a productive dev experience out of the box in [Jetbrains IDEs](https://www.jetbrains.com/ides/), see the [.idea](./.idea) folder.
+
diff --git a/examples/production/eslint.config.mjs b/examples/production/eslint.config.mjs
@@ -2,13 +2,17 @@ import eslint from '@eslint/js'
 import tseslint from 'typescript-eslint'
 import globals from 'globals'
 
-export default tseslint.config(eslint.configs.recommended, tseslint.configs.recommended, {
-  languageOptions: {
-    globals: {
-      ...globals.node,
+export default tseslint.config(
+  eslint.configs.recommended,
+  tseslint.configs.recommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+    rules: {
+      '@typescript-eslint/explicit-member-accessibility': 'warn',
     },
   },
-  rules: {
-    '@typescript-eslint/explicit-member-accessibility': 'warn',
-  },
-})
+);
diff --git a/examples/production/smart_contracts/hello_world/deploy-config.ts b/examples/production/smart_contracts/hello_world/deploy-config.ts
@@ -23,7 +23,7 @@ export async function deploy() {
     })
   }
 
-  const method = 'hello'
+  const method = 'hello'  
   const response = await appClient.send.hello({
     args: { name: 'world' },
   })
diff --git a/examples/production/smart_contracts/index.ts b/examples/production/smart_contracts/index.ts
@@ -39,12 +39,12 @@ async function getDeployers() {
 }
 
 // execute all the deployers
-;(async () => {
+(async () => {
   const contractName = process.argv.length > 2 ? process.argv[2] : undefined
   const contractDeployers = await getDeployers()
-
+  
   const filteredDeployers = contractName
-    ? contractDeployers.filter((deployer) => deployer.name === contractName)
+    ? contractDeployers.filter(deployer => deployer.name === contractName)
     : contractDeployers
 
   if (contractName && filteredDeployers.length === 0) {
diff --git a/examples/production/vitest.config.mts b/examples/production/vitest.config.mts
@@ -4,7 +4,7 @@ import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
   esbuild: {},
-  test: {
+  test: {    
     testTimeout: 10000,
     coverage: {
       provider: 'v8',
diff --git a/examples/starter/README.md b/examples/starter/README.md

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ export async function deploy() {`
`23`	`23`	`})`
`24`	`24`	`}`
`25`	`25`
`26`		`- const method = 'hello'`
	`26`	`+ const method = 'hello'`
`27`	`27`	`const response = await appClient.send.hello({`
`28`	`28`	`args: { name: 'world' },`
`29`	`29`	`})`