xxiled-plastic-cat / learn-algokit-ts-client

Learn Autogenerated AlgoKit TS Client with Calculator App

This project is meant to be cloned and used to follow along the AlgoKit App Client Explained video. With this project, you will learn how to set up your development environment with algokit bootstrap all, how to generate a typescript client for contract interaction with algokit generate and use the generated client to interact with a calculator smart contract.

Contents

📂smart_contract - Directory containing files related to the calculator smart contract
┃ 📂artifacts - Directory containing autogenerated artifacts
┃ 📜build.py - Python script that generates artifacts from the PyTeal/Beaker smart contract
┃ 📜calculator.py - Calculator smart contract in PyTeal/Beaker
┃ 📜deploy.ts - Deploy/interact script with the contract using the generated ts client
┃ 📜**.env** - Contains localnet env variables

Setup

1. Ensure you have AlgoKit installed and run algokit bootstrap all in this directory
2. Go into the smart_contract folder by running cd smart_contract
3. Generate ts client with algokit generate client artifacts/ --output artifacts/client.ts. Learn more about algokit generate here
4. Ensure you have Docker running and launch Localnet with algokit localnet start
5. copy everything inside of .env.localnet.template file into .env file.
6. Run the deploy.ts file by running npm run deploy in the smart_contract folder

Tools

The following tools are used in this project:

• Algorand - Layer 1 Blockchain; Developer portal, Why Algorand?
• AlgoKit - One-stop shop tool for developers building on the Algorand network; docs, intro tutorial
• Beaker - Smart contract development framework for PyTeal; docs, examples
• PyTEAL - Python language binding for Algorand smart contracts; docs
• AlgoKit Utils - A set of core Algorand utilities that make it easier to build solutions on Algorand.
• Poetry: Python packaging and dependency management.