Spanis session 4

Author: evertdiaz

beginner-es/session_4/README.md

@@ -0,0 +1,56 @@
+# session_3
+
+This starter full stack project has been generated using AlgoKit. See below for default getting started instructions.
+
+## Setup
+
+### Initial setup
+
+1. Clone this repository locally.
+2. Install pre-requisites:
+   - Make sure to have [Docker](https://www.docker.com/) installed and running on your machine.
+   - Install `AlgoKit` - [Link](https://github.com/algorandfoundation/algokit-cli#install): The minimum required version is `1.3.0`. Ensure you can execute `algokit --version` and get `1.3.0` or later.
+   - Bootstrap your local environment; run `algokit bootstrap all` within this folder, which will install Poetry, run `npm install` and `poetry install` in the root directory to install NPM and Python packages respectively, set up a `.venv` folder with a Python virtual environment and also install all Python dependencies.
+     - For TypeScript projects, it will also run `npm install` to install NPM packages.
+     - For all projects, it will copy `.env.template` to `.env`.
+   - Run `algokit localnet start` to start a local Algorand network in Docker. If you are using VS Code launch configurations provided by the template, this will be done automatically for you.
+3. Open the project and start debugging / developing on:
+   - [Backend](backend/README.md) - Refer to the README for more information on how to work with smart contracts.
+   - [Frontend](frontend/README.md) - Refer to the README for more information on how to work with the frontend application.
+
+
+### Subsequently
+
+1. If you update to the latest source code and there are new dependencies, you will need to run `algokit bootstrap all` again.
+2. Follow step 3 above.
+
+### 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. You can configure these actions to suit your project's needs, including CI checks, audits, linting, type checking, testing, and deployments to TestNet.
+
+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 frontend application is deployed to a provider of your choice (Netlify, Vercel, etc.). See [frontend README](frontend/README.md) for more information.
+
+> Please note deployment of smart contracts is done 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).
+
+## Tools
+
+This project makes use of Python and React to build Algorand smart contracts and to provide a base project configuration to develop frontends for your Algorand dApps and interactions with smart contracts. The following tools are in use:
+
+- Algorand, AlgoKit, and AlgoKit Utils
+- Python dependencies including Poetry, Black, Ruff or Flake8, mypy, pytest, and pip-audit
+- React and related dependencies including AlgoKit Utils, Tailwind CSS, daisyUI, use-wallet, npm, jest, playwright, Prettier, ESLint, and Github Actions workflows for build validation
+
+It has also been configured to have a productive dev experience out of the box in [VS Code](https://code.visualstudio.com/), see the [backend .vscode](./backend/.vscode) and [frontend .vscode](./frontend/.vscode) folders for more details.
+
+## Integrating with smart contracts and application clients
+
+Refer to the [backend](backend/README.md) folder for overview of working with smart contracts, [frontend](frontend/README.md) for overview of the React project and the [frontend/contracts](frontend/src/contracts/README.md) folder for README on adding new smart contracts from backend as application clients on your frontend. The templates provided in these folders will help you get started.
+When you compile and generate smart contract artifacts, your frontend component will automatically generate typescript application clients from smart contract artifacts and move them to `frontend/src/contracts` folder, see [`generate:app-clients` in package.json](frontend/package.json). Afterwards, you are free to import and use them in your frontend application.
+
+The frontend starter also provides an example of interactions with your AuctionClient in [`AppCalls.tsx`](frontend/src/components/AppCalls.tsx) component by default.
+
+## Next Steps
+
+You can take this project and customize it to build your own decentralized applications on Algorand. Make sure to understand how to use AlgoKit and how to write smart contracts for Algorand before you start.

beginner-es/session_4/backend/.algokit.toml

@@ -0,0 +1,15 @@
+[algokit]
+min_version = "v1.4.0"
+
+[deploy]
+command = "npm run deploy:ci"
+environment_secrets = [
+  "DEPLOYER_MNEMONIC",
+]
+
+[deploy.localnet]
+environment_secrets = []
+
+[generate.smart_contract]
+description = "Adds new smart contract to existing project"
+path = ".algokit/generators/create_contract"

beginner-es/session_4/backend/.algokit/generators/create_contract/copier.yaml

@@ -0,0 +1,10 @@
+_task:
+    - "echo '==== Successfully initialized new smart contract 🚀 ===='"
+
+contract_name:
+    type: str
+    help: Name of your new contract.
+    placeholder: "my-new-contract"
+    default: "my-new-contract"
+
+_templates_suffix: ".j2"

beginner-es/session_4/backend/.algokit/generators/create_contract/smart_contracts/{{ contract_name }}/contract.py.j2

@@ -0,0 +1,30 @@
+import beaker
+import pyteal as pt
+{% if preset_name == 'starter' %}
+
+app = beaker.Application("{{ contract_name }}")
+{% elif preset_name == 'production' -%}
+from algokit_utils import DELETABLE_TEMPLATE_NAME, UPDATABLE_TEMPLATE_NAME
+
+app = beaker.Application("{{ contract_name }}")
+
+
+@app.update(authorize=beaker.Authorize.only_creator(), bare=True)
+def update() -> pt.Expr:
+    return pt.Assert(
+        pt.Tmpl.Int(UPDATABLE_TEMPLATE_NAME),
+        comment="Check app is updatable",
+    )
+
+
+@app.delete(authorize=beaker.Authorize.only_creator(), bare=True)
+def delete() -> pt.Expr:
+    return pt.Assert(
+        pt.Tmpl.Int(DELETABLE_TEMPLATE_NAME),
+        comment="Check app is deletable",
+    )
+{% endif %}
+
+@app.external
+def hello(name: pt.abi.String, *, output: pt.abi.String) -> pt.Expr:
+    return output.set(pt.Concat(pt.Bytes("Hello, "), name.get()))

beginner-es/session_4/backend/.algokit/generators/create_contract/smart_contracts/{{ contract_name }}/deploy-config.ts.j2

@@ -0,0 +1,62 @@
+import * as algokit from '@algorandfoundation/algokit-utils'
+import { {{ contract_name.split('_')|map('capitalize')|join }}Client } from '../artifacts/{{ contract_name }}/client'
+
+// Below is a showcase of various deployment options you can use in TypeScript Client
+export async function deploy() {
+  console.log('=== Deploying {{ contract_name.split('_')|map('capitalize')|join }} ===')
+
+  const algod = algokit.getAlgoClient()
+  const indexer = algokit.getAlgoIndexerClient()
+  const deployer = await algokit.getAccount(
+    { config: algokit.getAccountConfigFromEnvironment('DEPLOYER'), fundWith: algokit.algos(3) },
+    algod,
+  )
+  await algokit.ensureFunded(
+    {
+      accountToFund: deployer,
+      minSpendingBalance: algokit.algos(2),
+      minFundingIncrement: algokit.algos(2),
+    },
+    algod,
+  )
+  const isMainNet = await algokit.isMainNet(algod)
+  const appClient = new {{ contract_name.split('_')|map('capitalize')|join }}Client(
+    {
+      resolveBy: 'creatorAndName',
+      findExistingUsing: indexer,
+      sender: deployer,
+      creatorAddress: deployer.addr,
+    },
+    algod,
+  )
+
+  {%- if preset_name == 'starter' %}
+  const app = await appClient.deploy({
+    onSchemaBreak: 'append',
+    onUpdate: 'append',
+  })
+  {% elif preset_name == 'production' %}
+  const app = await appClient.deploy({
+    allowDelete: !isMainNet,
+    allowUpdate: !isMainNet,
+    onSchemaBreak: isMainNet ? 'append' : 'replace',
+    onUpdate: isMainNet ? 'append' : 'update',
+  })
+  {% endif %}
+
+  // If app was just created fund the app account
+  if (['create', 'replace'].includes(app.operationPerformed)) {
+    algokit.transferAlgos(
+      {
+        amount: algokit.algos(1),
+        from: deployer,
+        to: app.appAddress,
+      },
+      algod,
+    )
+  }
+
+  const method = 'hello'
+  const response = await appClient.hello({ name: 'world' })
+  console.log(`Called ${method} on ${app.name} (${app.appId}) with name = world, received: ${response.return}`)
+}

beginner-es/session_4/backend/.copier-answers.yml

@@ -0,0 +1,25 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: 1.8.0
+_src_path: gh:algorandfoundation/algokit-beaker-default-template
+algod_port: 4001
+algod_server: http://localhost
+algod_token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+author_email: [email protected]
+author_name: Evert
+contract_name: auction
+deployment_language: typescript
+ide_vscode: true
+indexer_port: 8980
+indexer_server: http://localhost
+indexer_token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+preset_name: starter
+project_name: backend
+python_linter: none
+use_dispenser: false
+use_github_actions: false
+use_pre_commit: false
+use_python_black: true
+use_python_mypy: false
+use_python_pip_audit: true
+use_python_pytest: true
+

beginner-es/session_4/backend/.editorconfig

@@ -0,0 +1,10 @@
+root=true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+
+[*.py]
+indent_size = 4

beginner-es/session_4/backend/.env.localnet.template

@@ -0,0 +1,7 @@
+# this file should contain environment variables specific to algokit localnet
+ALGOD_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ALGOD_SERVER=http://localhost
+ALGOD_PORT=4001
+INDEXER_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+INDEXER_SERVER=http://localhost
+INDEXER_PORT=8980

beginner-es/session_4/backend/.env.template

@@ -0,0 +1 @@
+# this file should contain environment variables common to all environments/networks

beginner-es/session_4/backend/.env.testnet.template

@@ -0,0 +1,3 @@
+# this file contains algorand network settings for interacting with testnet via algonode
+ALGOD_SERVER=https://testnet-api.algonode.cloud
+INDEXER_SERVER=https://testnet-idx.algonode.cloud

beginner-es/session_4/backend/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf