This commit is contained in:
SaraJane
2025-12-30 13:07:28 +00:00
commit 93e3f09667
95 changed files with 20233 additions and 0 deletions

0
projects/.gitkeep Normal file
View File

View File

@ -0,0 +1,56 @@
[algokit]
min_version = "v2.6.0"
[generate.smart-contract]
description = "Generate a new smart contract for existing project"
path = ".algokit/generators/create_contract"
[generate.env-file]
description = "Generate a new generic or Algorand network specific .env file"
path = ".algokit/generators/create_env_file"
[project]
type = 'contract'
name = 'TokenizeRWATemplate-contracts'
artifacts = 'smart_contracts/artifacts'
[project.deploy]
command = "npm run deploy:ci"
[project.deploy.testnet]
environment_secrets = [
"DEPLOYER_MNEMONIC",
"DISPENSER_MNEMONIC",
]
[project.deploy.mainnet]
environment_secrets = [
"DEPLOYER_MNEMONIC",
"DISPENSER_MNEMONIC",
]
[project.run]
# Commands intended for use locally and in CI
build = { commands = [
'npm run build',
], description = 'Build all smart contracts in the project' }
test = { commands = [
'npm run test',
], description = 'Run smart contract tests using vitest' }
audit = { commands = [
'npm run audit',
], description = 'Audit with better-npm-audit' }
lint = { commands = [
'npm run lint',
'npm run format',
], description = 'Perform linting' }
audit-teal = { commands = [
# 🚨 IMPORTANT 🚨: For strict TEAL validation, remove --exclude statements. The default starter contract is not for production. Ensure thorough testing and adherence to best practices in smart contract development. This is not a replacement for a professional audit.
'algokit task analyze smart_contracts/artifacts --recursive --force --exclude rekey-to --exclude is-updatable --exclude missing-fee-check --exclude is-deletable --exclude can-close-asset --exclude can-close-account --exclude unprotected-deletable --exclude unprotected-updatable',
], description = 'Audit TEAL files' }
# Commands intented for CI only, prefixed with `ci-` by convention
ci-teal-diff = { commands = [
'git add -N ./smart_contracts/artifacts',
'git diff --exit-code --minimal ./smart_contracts/artifacts',
], description = 'Check TEAL files for differences' }

View File

@ -0,0 +1,9 @@
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
_commit: 0.3.7
_src_path: gh:algorandfoundation/algokit-typescript-template
author_email: sarajanedeveloper@gmail.com
author_name: SaraJane
contract_name: hello_world
preset_name: production
project_name: TokenizeRWATemplate-contracts

View File

@ -0,0 +1,15 @@
_tasks:
- "echo '==== Successfully initialized new smart contract 🚀 ===='"
contract_name:
type: str
help: Name of your new contract.
placeholder: "my-new-contract"
default: "my-new-contract"
include_tests:
type: bool
help: Should we include testing files?
default: 'yes'
_templates_suffix: ".j2"

View File

@ -0,0 +1,7 @@
import { Contract } from '@algorandfoundation/algorand-typescript'
export class {{ contract_name.split('_')|map('capitalize')|join }} extends Contract {
{% if preset_name != 'starter' %}public {% endif %}hello(name: string): string {
return `Hello, ${name}`
}
}

View File

@ -0,0 +1,33 @@
import { AlgorandClient } from '@algorandfoundation/algokit-utils'
import { {{ contract_name.split('_')|map('capitalize')|join }}Factory } from '../artifacts/{{ contract_name }}/{{ contract_name.split('_')|map('capitalize')|join }}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 algorand = AlgorandClient.fromEnvironment()
const deployer = await algorand.account.fromEnvironment('DEPLOYER')
const factory = algorand.client.getTypedAppFactory({{ contract_name.split('_')|map('capitalize')|join }}Factory, {
defaultSender: deployer.addr,
})
const { appClient, result } = await factory.deploy({ onUpdate: 'append', onSchemaBreak: 'append' })
// If app was just created fund the app account
if (['create', 'replace'].includes(result.operationPerformed)) {
await algorand.send.payment({
amount: (1).algo(),
sender: deployer.addr,
receiver: appClient.appAddress,
})
}
const method = 'hello'
const response = await appClient.send.hello({
args: { name: 'world' },
})
console.log(
`Called ${method} on ${appClient.appClient.appName} (${appClient.appClient.appId}) with name = world, received: ${response.return}`,
)
}

View File

@ -0,0 +1,36 @@
import { Config } from '@algorandfoundation/algokit-utils'
import { algorandFixture } from '@algorandfoundation/algokit-utils/testing'
import { Address } from 'algosdk'
import { beforeAll, beforeEach, describe, expect, test } from 'vitest'
import { {{ contract_name.split('_')|map('capitalize')|join }}Factory } from '../artifacts/{{ contract_name }}/{{ contract_name.split('_')|map('capitalize')|join }}Client'
describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () => {
const localnet = algorandFixture()
beforeAll(() => {
Config.configure({
debug: true,
// traceAll: true,
})
})
beforeEach(localnet.newScope)
const deploy = async (account: Address) => {
const factory = localnet.algorand.client.getTypedAppFactory({{ contract_name.split('_')|map('capitalize')|join }}Factory, {
defaultSender: account,
})
const { appClient } = await factory.deploy({ onUpdate: 'append', onSchemaBreak: 'append' })
return { client: appClient }
}
test('says hello', async () => {
const { testAccount } = localnet.context
const { client } = await deploy(testAccount)
const result = await client.send.hello({ args: { name: 'World' } })
expect(result.return).toBe('Hello World')
})
})

View File

@ -0,0 +1,14 @@
import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
import { describe, expect, it } from 'vitest'
import { {{ contract_name.split('_')|map('capitalize')|join }} } from './contract.algo'
describe('{{ contract_name.split('_')|map('capitalize')|join }} contract', () => {
const ctx = new TestExecutionContext()
it('Logs the returned value when sayHello is called', () => {
const contract = ctx.contract.create({{ contract_name.split('_')|map('capitalize')|join }})
const result = contract.hello('Sally')
expect(result).toBe('Hello Sally')
})
})

View File

@ -0,0 +1,49 @@
_tasks:
- "echo '==== Successfully generated new .env file 🚀 ===='"
target_network:
type: str
help: Name of your target network.
choices:
- mainnet
- testnet
- localnet
- custom
default: "localnet"
when: "{{ not use_generic_env }}"
custom_network_name:
type: str
help: Name of your custom Algorand network.
placeholder: "custom"
when: "{{ not use_generic_env and target_network == 'custom' }}"
is_localnet:
type: bool
help: Whether to deploy on localnet.
placeholder: "true"
default: "{{ target_network == 'localnet' and not use_generic_env }}"
when: 'false'
is_testnet:
type: bool
help: Whether to deploy on testnet.
placeholder: "true"
default: "{{ target_network == 'testnet' and not use_generic_env }}"
when: 'false'
is_mainnet:
type: bool
help: Whether to deploy on mainnet.
placeholder: "true"
default: "{{ target_network == 'mainnet' and not use_generic_env }}"
when: 'false'
is_customnet:
type: bool
help: Whether to deploy on custom network.
placeholder: "true"
default: "{{ target_network == 'custom' and not use_generic_env }}"
when: 'false'
_templates_suffix: ".j2"

View File

@ -0,0 +1,7 @@
# this file contains algorand network settings for interacting with testnet via algonode
ALGOD_TOKEN={YOUR_ALGOD_TOKEN}
ALGOD_SERVER={YOUR_ALGOD_SERVER_URL}
ALGOD_PORT={YOUR_ALGOD_PORT}
INDEXER_TOKEN={YOUR_INDEXER_TOKEN}
INDEXER_SERVER={YOUR_INDEXER_SERVER_URL}
INDEXER_PORT={YOUR_INDEXER_PORT}

View File

@ -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

View File

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

View File

@ -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

View File

@ -0,0 +1,7 @@
root=true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true

View File

@ -0,0 +1,62 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
# Dependency directories
node_modules/
# TypeScript cache
*.tsbuildinfo
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# Editor/OS directories and files
.DS_Store
*.suo
# IntelliJ family
.idea
!.idea/
.idea/*
!.idea/runConfigurations/
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# Compiled code
dist/
build/
# Coverage report
coverage
# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local
# Received approval test files
*.received.*
# AlgoKit
debug_traces/
.algokit/static-analysis/ # Replace with .algokit/static-analysis/tealer/ to enable snapshot checks in CI
.algokit/sources

View File

@ -0,0 +1 @@
engine-strict = true

View File

@ -0,0 +1,13 @@
# don't ever format node_modules
node_modules
# don't lint format output (make sure it's set to your correct build folder name)
dist
build
# don't format nyc coverage output
coverage
# don't format generated types
**/generated/types.d.ts
**/generated/types.ts
# don't format ide files
.idea
smart_contracts/artifacts

View File

@ -0,0 +1,10 @@
module.exports = {
singleQuote: true,
jsxSingleQuote: false,
semi: false,
tabWidth: 2,
trailingComma: 'all',
printWidth: 120,
endOfLine: 'lf',
arrowParens: 'always',
}

View File

@ -0,0 +1,56 @@
{
"$schema": "https://aka.ms/codetour-schema",
"title": "Getting Started with Your AlgoKit Project",
"steps": [
{
"file": "README.md",
"description": "Welcome to your brand new AlgoKit template-based project. In this tour, we will guide you through the main features and capabilities included in the template.",
"line": 3
},
{
"file": "README.md",
"description": "Start by ensuring you have followed the setup of pre-requisites.",
"line": 9
},
{
"file": ".algokit.toml",
"description": "This is the main configuration file used by algokit-cli to manage the project. The default template includes a starter 'Hello World' contract that is deployed via the `algokit-utils` package. To create a new smart contract, you can use the [`algokit generate`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/generate.md) command and invoke a pre-bundled generator template by running `algokit generate smart-contract` (see how it is defined in the `.algokit.toml`, you can create your own generators if needed). This action will create a new folder in the `smart_contracts` directory, named after your project. Each folder contains a `contract.algo.ts` file, which is the entry point for your contract implementation, and `deployConfig.ts` file, that perform the deployment of the contract. Additionally you can define custom commands to run (similar to `npm` scripts), see definitions under `[project]` section in `.algokit.toml`.",
"line": 1
},
{
"file": "smart_contracts/hello_world/deploy-config.ts",
"description": "The default deployment scripts invoke a sample method on the starter contract that demonstrates how to interact with your deployed Algorand on-chain applications using the [`AlgoKit Typed Clients`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/generate.md#1-typed-clients) feature. The invocation if deploy is aliased in `.algokit.toml` file, allowing simple deployments via `algokit project deploy` command.",
"line": 32
},
{
"file": "smart_contracts/hello_world/contact.spec.ts",
"description": "The default tests provided demonstrate an example of setting up in-memory fast unit tests with the Algorand TypeScript testing library that mocks AVM functionality.",
"line": 5
},
{
"file": "smart_contracts/hello_world/contact.e2e.spec.ts",
"description": "The default tests provided demonstrate an example of setting up an end-to-end test with fixtures, and testing smart contract calls against a LocalNet network via an AlgoKit typed client.",
"line": 7
},
{
"file": ".env.localnet.template",
"description": "Environment files are a crucial mechanism that allows you to set up the [`algokit deploy`](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/deploy.md) feature to simplify deploying your contracts in CI/CD environments (please note we still recommend careful evaluation when it comes to deployment to MainNet). Clone the file and remove the `.template` suffix to apply the changes to deployment scripts and launch configurations. The network prefix `localnet|testnet|mainnet` is primarily optimized for `algokit deploy`. The order of loading the variables is `.env.{network}` < `.env`.",
"line": 2
},
{
"file": ".vscode/launch.json",
"description": "Refer to the pre-bundled Visual Studio launch configurations, offering various options on how to execute the build and deployment of your smart contracts. Alternatively execute `algokit project run` to see list of available custom commands.",
"line": 5
},
{
"file": ".vscode/extensions.json",
"description": "We highly recommend installing the recommended extensions to get the most out of this template starter project in your VSCode IDE.",
"line": 3
},
{
"file": "smart_contracts/index.ts",
"description": "Uncomment the following line to enable artifacts required for the [AlgoKit AVM Debugger](https://github.com/algorandfoundation/algokit-avm-vscode-debugger) that run for every single call rather than just failures. This VSCode plugin is available on the [VSCode Extension Marketplace](https://marketplace.visualstudio.com/items?itemName=algorandfoundation.algokit-avm-vscode-debugger) for every call. A new folder will be automatically created in the `.algokit` directory with source maps of all TEAL contracts in this workspace, as well as traces that will appear in a folder at the root of the workspace. You can then use the traces as entry points to trigger the debug extension. Make sure to have the `.algokit.toml` file available at the root of the workspace.",
"line": 13
}
]
}

View File

@ -0,0 +1,10 @@
{
"recommendations": [
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"vitest.explorer",
"editorconfig.editorconfig",
"vsls-contrib.codetour",
"algorandfoundation.algokit-avm-vscode-debugger"
]
}

View File

@ -0,0 +1,58 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "Build & Deploy contracts",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "deploy"],
"cwd": "${workspaceFolder}/smart_contracts",
"console": "integratedTerminal",
"skipFiles": ["<node_internals>/**", "node_modules/**"],
"preLaunchTask": "Build contracts (+ LocalNet)",
"env": {
"ALGOD_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"ALGOD_SERVER": "http://localhost",
"ALGOD_PORT": "4001",
"INDEXER_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"INDEXER_SERVER": "http://localhost",
"INDEXER_PORT": "8980"
}
},
{
"name": "Deploy contracts",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "deploy"],
"cwd": "${workspaceFolder}/smart_contracts",
"console": "integratedTerminal",
"skipFiles": ["<node_internals>/**", "node_modules/**"],
"env": {
"ALGOD_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"ALGOD_SERVER": "http://localhost",
"ALGOD_PORT": "4001",
"INDEXER_TOKEN": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"INDEXER_SERVER": "http://localhost",
"INDEXER_PORT": "8980"
}
},
{
"name": "Build contracts",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "build"],
"cwd": "${workspaceFolder}",
"console": "integratedTerminal",
"skipFiles": ["<node_internals>/**", "node_modules/**"],
},
{
"type": "avm",
"request": "launch",
"name": "Debug AVM executions",
"simulateTraceFile": "${workspaceFolder}/${command:PickSimulateTraceFile}",
"stopOnEntry": true
}
]
}

View File

@ -0,0 +1,19 @@
{
"files.eol": "\n",
"algorandTypeScript.languageServer.enable": true,
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.codeActionsOnSave": {
"source.organizeImports": "explicit"
},
"jest.enable": false,
"files.associations": {
".github/**/*.yml": "github-actions-workflow"
},
"eslint.enable": true,
"eslint.validate": ["typescript"],
"eslint.options": {
"extensions": [".ts"]
},
"eslint.workingDirectories": ["./smart_contracts"]
}

View File

@ -0,0 +1,69 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Build contracts",
"type": "npm",
"script": "build",
"path": "${workspaceFolder}",
"options": {
"cwd": "${workspaceFolder}"
},
"group": {
"kind": "build",
"isDefault": true
},
"problemMatcher": []
},
{
"label": "Build contracts (+ LocalNet)",
"type": "npm",
"script": "build",
"path": "${workspaceFolder}",
"options": {
"cwd": "${workspaceFolder}"
},
"dependsOn": "Start AlgoKit LocalNet",
"problemMatcher": []
},
{
"label": "Start AlgoKit LocalNet",
"command": "algokit",
"args": ["localnet", "start"],
"type": "shell",
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Stop AlgoKit LocalNet",
"command": "algokit",
"args": ["localnet", "stop"],
"type": "shell",
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Reset AlgoKit LocalNet",
"command": "algokit",
"args": ["localnet", "reset"],
"type": "shell",
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Analyze TEAL contracts with AlgoKit Tealer integration",
"command": "algokit",
"args": ["task", "analyze", "${workspaceFolder}/.algokit", "--recursive", "--force"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
}
]
}

View File

@ -0,0 +1,157 @@
# TokenizeRWATemplate-contracts
This project has been generated using AlgoKit. See below for default getting started instructions.
# Setup
### Pre-requisites
- [Nodejs 22](https://nodejs.org/en/download) or later
- [AlgoKit CLI 2.5](https://github.com/algorandfoundation/algokit-cli?tab=readme-ov-file#install) or later
- [Docker](https://www.docker.com/) (only required for LocalNet)
- [Puya Compiler 4.4.4](https://pypi.org/project/puyapy/) or later
> For interactive tour over the codebase, download [vsls-contrib.codetour](https://marketplace.visualstudio.com/items?itemName=vsls-contrib.codetour) extension for VS Code, then open the [`.codetour.json`](./.tours/getting-started-with-your-algokit-project.tour) file in code tour extension.
### 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.
- **Configure environment**: Execute `algokit generate env-file -a target_network localnet` to create a `.env.localnet` file with default configuration for `localnet`.
- **Start LocalNet**: Use `algokit localnet start` to initiate a local Algorand network.
### 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.
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 a seamless experience with breakpoint debugging and other features:
1. **Open Project**: In VS Code, open the repository root.
2. **Install Extensions**: Follow prompts to install recommended extensions.
3. **Debugging**:
- 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
By default the template creates a single `HelloWorld` contract under hello_world folder in the `smart_contracts` directory. To add a new contract:
1. From the root of the project (`../`) execute `algokit generate smart-contract`. This will create a new starter smart contract and deployment configuration file under `{your_contract_name}` subfolder in the `smart_contracts` directory.
2. Each contract potentially has different creation parameters and deployment steps. Hence, you need to define your deployment logic in `deploy-config.ts` file.
3. Technically, you need to reference your contract deployment logic in the `index.ts` file. However, by default, `index.ts` will auto import all TypeScript deployment files under `smart_contracts` directory. If you want to manually import specific contracts, modify the default code provided by the template in `index.ts` file.
> Please note, above is just a suggested convention tailored for the base configuration and structure of this template. The default code supplied by the template in the `index.ts` file is tailored for the suggested convention. You are free to modify the structure and naming conventions as you see fit.
### 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}`.
To generate a new `.env` or `.env.{target_network}` file, run `algokit generate env-file`
### Debugging Smart Contracts
This project is optimized to work with AlgoKit AVM Debugger extension. To activate it:
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.
> Please note, if you instantiated the project with --workspace flag in `algokit init` it will automatically attempt to move the contents of the `.github` folder to the root of the workspace.
### AlgoKit Workspaces
To define custom `algokit project run` commands refer to [documentation](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/run.md). This allows orchestration of commands spanning across multiple projects within an algokit workspace based project (monorepo).
#### 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/)).
#### 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/)
- 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
> 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).
> 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).
# Tools
This project makes use of Algorand TypeScript to build Algorand smart contracts. The following tools are in use:
- [Algorand](https://www.algorand.com/) - Layer 1 Blockchain; [Developer portal](https://dev.algorand.co/), [Why Algorand?](https://dev.algorand.co/getting-started/why-algorand/)
- [AlgoKit](https://github.com/algorandfoundation/algokit-cli) - One-stop shop tool for developers building on the Algorand network; [docs](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md), [intro tutorial](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/tutorials/intro.md)
- [Algorand TypeScript](https://github.com/algorandfoundation/puya-ts/) - A semantically and syntactically compatible, typed TypeScript language that works with standard TypeScript tooling and allows you to express smart contracts (apps) and smart signatures (logic signatures) for deployment on the Algorand Virtual Machine (AVM); [docs](https://github.com/algorandfoundation/puya-ts/), [examples](https://github.com/algorandfoundation/puya-ts/tree/main/examples)
- [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts) - A set of core Algorand utilities that make it easier to build solutions on Algorand.
- [NPM](https://www.npmjs.com/): TypeScript packaging and dependency management.
- [TypeScript](https://www.typescriptlang.org/): Strongly typed programming language that builds on JavaScript
- [ts-node-dev](https://github.com/wclr/ts-node-dev): TypeScript development execution environment- [Prettier](https://prettier.io/): A code formatter.- [ESLint](https://eslint.org/): A JavaScript / TypeScript linter.
- [vitest](https://vitest.dev/): Automated testing.
- [better-npm-audit](https://github.com/jeemok/better-npm-audit#readme): Tool for scanning JavaScript / TypeScript environments for packages with known vulnerabilities.
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.

View File

@ -0,0 +1,18 @@
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,
},
},
rules: {
'@typescript-eslint/explicit-member-accessibility': 'warn',
},
},
);

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,48 @@
{
"name": "smart_contracts",
"version": "1.0.0",
"description": "Smart contract deployer",
"main": "smart_contracts/index.ts",
"scripts": {
"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",
"lint:fix": "eslint smart_contracts --fix",
"audit": "better-npm-audit audit",
"format": "prettier --write .",
"test": "vitest run --coverage",
"test:watch": "vitest watch",
"check-types": "tsc --noEmit"
},
"engines": {
"node": ">=22.0",
"npm": ">=9.0"
},
"dependencies": {
"@algorandfoundation/algorand-typescript": "^1.0.1"
},
"devDependencies": {
"@algorandfoundation/algokit-client-generator": "^6.0.0",
"@algorandfoundation/algokit-utils": "^9.0.0",
"@algorandfoundation/algokit-utils-debug": "^1.0.4",
"@algorandfoundation/puya-ts": "^1.0.1",
"@rollup/plugin-typescript": "^12.1.2",
"@tsconfig/node22": "^22.0.0",
"algosdk": "^3.0.0",
"better-npm-audit": "^3.11.0",
"dotenv": "^16.4.7",
"eslint": "^9.18.0",
"@eslint/js": "^9.18.0",
"typescript-eslint": "^8.19.1",
"prettier": "^3.4.2",
"ts-node-dev": "^2.0.0",
"@algorandfoundation/algorand-typescript-testing": "^1.0.1",
"vitest": "^2.1.8",
"@vitest/coverage-v8": "^2.1.8",
"typescript": "^5.7.3"
},
"overrides": {
"esbuild": "0.25.0"
}
}

View File

@ -0,0 +1,14 @@
import { TestExecutionContext } from '@algorandfoundation/algorand-typescript-testing'
import { describe, expect, it } from 'vitest'
import { HelloWorld } from './contract.algo'
describe('HelloWorld contract', () => {
const ctx = new TestExecutionContext()
it('Logs the returned value when sayHello is called', () => {
const contract = ctx.contract.create(HelloWorld)
const result = contract.hello('Sally')
expect(result).toBe('Hello, Sally')
})
})

View File

@ -0,0 +1,7 @@
import { Contract } from '@algorandfoundation/algorand-typescript'
export class HelloWorld extends Contract {
public hello(name: string): string {
return `Hello, ${name}`
}
}

View File

@ -0,0 +1,53 @@
import { Config } from '@algorandfoundation/algokit-utils'
import { registerDebugEventHandlers } from '@algorandfoundation/algokit-utils-debug'
import { algorandFixture } from '@algorandfoundation/algokit-utils/testing'
import { Address } from 'algosdk'
import { beforeAll, beforeEach, describe, expect, test } from 'vitest'
import { HelloWorldFactory } from '../artifacts/hello_world/HelloWorldClient'
describe('HelloWorld contract', () => {
const localnet = algorandFixture()
beforeAll(() => {
Config.configure({
debug: true,
// traceAll: true,
})
registerDebugEventHandlers()
})
beforeEach(localnet.newScope)
const deploy = async (account: Address) => {
const factory = localnet.algorand.client.getTypedAppFactory(HelloWorldFactory, {
defaultSender: account,
})
const { appClient } = await factory.deploy({
onUpdate: 'append',
onSchemaBreak: 'append',
})
return { client: appClient }
}
test('says hello', async () => {
const { testAccount } = localnet.context
const { client } = await deploy(testAccount)
const result = await client.send.hello({ args: { name: 'World' } })
expect(result.return).toBe('Hello, World')
})
test('simulate says hello with correct budget consumed', async () => {
const { testAccount } = localnet.context
const { client } = await deploy(testAccount)
const result = await client
.newGroup()
.hello({ args: { name: 'World' } })
.hello({ args: { name: 'Jane' } })
.simulate()
expect(result.returns[0]).toBe('Hello, World')
expect(result.returns[1]).toBe('Hello, Jane')
expect(result.simulateResponse.txnGroups[0].appBudgetConsumed).toBeLessThan(100)
})
})

View File

@ -0,0 +1,33 @@
import { AlgorandClient } from '@algorandfoundation/algokit-utils'
import { HelloWorldFactory } from '../artifacts/hello_world/HelloWorldClient'
// Below is a showcase of various deployment options you can use in TypeScript Client
export async function deploy() {
console.log('=== Deploying HelloWorld ===')
const algorand = AlgorandClient.fromEnvironment()
const deployer = await algorand.account.fromEnvironment('DEPLOYER')
const factory = algorand.client.getTypedAppFactory(HelloWorldFactory, {
defaultSender: deployer.addr,
})
const { appClient, result } = await factory.deploy({ onUpdate: 'append', onSchemaBreak: 'append' })
// If app was just created fund the app account
if (['create', 'replace'].includes(result.operationPerformed)) {
await algorand.send.payment({
amount: (1).algo(),
sender: deployer.addr,
receiver: appClient.appAddress,
})
}
const method = 'hello'
const response = await appClient.send.hello({
args: { name: 'world' },
})
console.log(
`Called ${method} on ${appClient.appClient.appName} (${appClient.appClient.appId}) with name = world, received: ${response.return}`,
)
}

View File

@ -0,0 +1,62 @@
import { Config } from '@algorandfoundation/algokit-utils'
import { registerDebugEventHandlers } from '@algorandfoundation/algokit-utils-debug'
import { consoleLogger } from '@algorandfoundation/algokit-utils/types/logging'
import * as fs from 'node:fs'
import * as path from 'node:path'
// Uncomment the traceAll option to enable auto generation of AVM Debugger compliant sourceMap and simulation trace file for all AVM calls.
// Learn more about using AlgoKit AVM Debugger to debug your TEAL source codes and inspect various kinds of Algorand transactions in atomic groups -> https://github.com/algorandfoundation/algokit-avm-vscode-Debugger
Config.configure({
logger: consoleLogger,
debug: true,
// traceAll: true,
})
registerDebugEventHandlers()
// base directory
const baseDir = path.resolve(__dirname)
// function to validate and dynamically import a module
async function importDeployerIfExists(dir: string) {
const deployerPath = path.resolve(dir, 'deploy-config')
if (fs.existsSync(deployerPath + '.ts') || fs.existsSync(deployerPath + '.js')) {
const deployer = await import(deployerPath)
return { ...deployer, name: path.basename(dir) }
}
return null
}
// get a list of all deployers from the subdirectories
async function getDeployers() {
const directories = fs
.readdirSync(baseDir, { withFileTypes: true })
.filter((dirent) => dirent.isDirectory())
.map((dirent) => path.resolve(baseDir, dirent.name))
const deployers = await Promise.all(directories.map(importDeployerIfExists))
return deployers.filter((deployer) => deployer !== null) // Filter out null values
}
// execute all the deployers
(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
if (contractName && filteredDeployers.length === 0) {
console.warn(`No deployer found for contract name: ${contractName}`)
return
}
for (const deployer of filteredDeployers) {
try {
await deployer.deploy()
} catch (e) {
console.error(`Error deploying ${deployer.name}:`, e)
}
}
})()

View File

@ -0,0 +1,26 @@
{
"compilerOptions": {
"target": "ES2020",
"declaration": true,
"declarationMap": true,
"sourceMap": true,
"strict": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"allowJs": false,
"allowSyntheticDefaultImports": true,
"module": "CommonJS",
"moduleResolution": "Node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"lib": [
"ESNext"
],
},
"include": ["smart_contracts/**/*.ts"],
"exclude": ["node_modules", "dist", "coverage"]
}

View File

@ -0,0 +1,14 @@
{
"extends": "@tsconfig/node22/tsconfig.json",
"compilerOptions": {
"noEmit": true,
"target": "ES2023",
"module": "ESNext",
"lib": ["ES2023"],
"moduleResolution": "Bundler",
"resolveJsonModule": true,
"esModuleInterop": true
},
"include": ["**/*.ts", "**/*.mts"],
"exclude": ["node_modules"]
}

View File

@ -0,0 +1,21 @@
import { puyaTsTransformer } from '@algorandfoundation/algorand-typescript-testing/vitest-transformer'
import typescript from '@rollup/plugin-typescript'
import { defineConfig } from 'vitest/config'
export default defineConfig({
esbuild: {},
test: {
testTimeout: 10000,
coverage: {
provider: 'v8',
},
},
plugins: [
typescript({
tsconfig: './tsconfig.test.json',
transformers: {
before: [puyaTsTransformer],
},
}),
],
})

View File

@ -0,0 +1,17 @@
[algokit]
min_version = "v2.0.0"
[project]
type = "frontend"
name = 'TokenizeRWATemplate-frontend'
artifacts = "src/contracts"
[project.run]
build = { commands = ['npm run build'], description = 'Build frontend' }
test = { commands = ['npm run test'], description = 'Run frontend tests' }
lint = { commands = ['npm run lint'], description = 'Lint frontend code' }
ci-deploy-vercel = { commands = [
'npm install --global vercel@latest',
'npm run ci:vercel:pull',
'npm run ci:vercel:deploy',
], description = 'Deploy to Vercel' }

View File

@ -0,0 +1,9 @@
# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
_commit: 1.1.1
_src_path: gh:algorandfoundation/algokit-react-frontend-template
author_email: sarajanedeveloper@gmail.com
author_name: SaraJane
cloud_provider: vercel
preset_name: production
project_name: TokenizeRWATemplate-frontend

View File

@ -0,0 +1,9 @@
[*]
charset = utf-8
insert_final_newline = true
end_of_line = lf
indent_style = space
indent_size = 2
tab_width = 2
max_line_length = 140
trim_trailing_whitespace = true

View File

@ -0,0 +1,67 @@
# ======================
# LocalNet configuration
# uncomment below to use
# ======================
VITE_ENVIRONMENT=local
# Algod
VITE_ALGOD_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
VITE_ALGOD_SERVER=http://localhost
VITE_ALGOD_PORT=4001
VITE_ALGOD_NETWORK=localnet
# Indexer
VITE_INDEXER_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
VITE_INDEXER_SERVER=http://localhost
VITE_INDEXER_PORT=8980
# KMD
# Please note:
# 1. This is only needed for LocalNet since
# by default KMD provider is ignored on other networks.
# 2. AlgoKit LocalNet starts with a single wallet called 'unencrypted-default-wallet',
# with heaps of tokens available for testing.
VITE_KMD_TOKEN=aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
VITE_KMD_SERVER=http://localhost
VITE_KMD_PORT=4002
VITE_KMD_WALLET="unencrypted-default-wallet"
VITE_KMD_PASSWORD=""
# # ======================
# # TestNet configuration:
# # uncomment below to use
# # ======================
# VITE_ENVIRONMENT=local
# # Algod
# VITE_ALGOD_TOKEN=""
# VITE_ALGOD_SERVER="https://testnet-api.algonode.cloud"
# VITE_ALGOD_PORT=""
# VITE_ALGOD_NETWORK="testnet"
# # Indexer
# VITE_INDEXER_TOKEN=""
# VITE_INDEXER_SERVER="https://testnet-idx.algonode.cloud"
# VITE_INDEXER_PORT=""
# # ======================
# # MainNet configuration:
# # uncomment below to use
# # ======================
# VITE_ENVIRONMENT=production
# # Algod
# VITE_ALGOD_TOKEN=""
# VITE_ALGOD_SERVER="https://mainnet-api.algonode.cloud"
# VITE_ALGOD_PORT=""
# VITE_ALGOD_NETWORK="mainnet"
# # Indexer
# VITE_INDEXER_TOKEN=""
# VITE_INDEXER_SERVER="https://mainnet-idx.algonode.cloud"
# VITE_INDEXER_PORT=""

View File

@ -0,0 +1,27 @@
{
"root": true,
"env": {
"node": true
},
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint", "prettier"],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
"plugin:@typescript-eslint/recommended",
"plugin:prettier/recommended"
],
"rules": {
"prettier/prettier": "warn",
"no-console": "warn",
"@typescript-eslint/no-unused-vars": [
"warn",
{
"ignoreRestSiblings": true,
"argsIgnorePattern": "^_",
"destructuredArrayIgnorePattern": "^_"
}
],
"prefer-template": "error"
}
}

View File

@ -0,0 +1,38 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
# dependencies
/node_modules
/.pnp
.pnp.js
# testing
/coverage
# production
/build
# dotenv environment variable files
.env
env/
# misc
/dist
.DS_Store
npm-debug.log*
yarn-debug.log*
yarn-error.log*
/test-results/
/playwright-report/
/playwright/.cache/
# PyCharm
.idea
!.idea/
.idea/*
!.idea/runConfigurations/
.vercel
.netlify

View File

@ -0,0 +1 @@
engine-strict = true

View File

@ -0,0 +1,12 @@
# don't ever format node_modules
node_modules
# don't lint format output (make sure it's set to your correct build folder name)
dist
build
# don't format nyc coverage output
coverage
# don't format generated types
**/generated/types.d.ts
**/generated/types.ts
# don't format ide files
.idea

View File

@ -0,0 +1,10 @@
module.exports = {
singleQuote: true,
jsxSingleQuote: false,
semi: false,
tabWidth: 2,
trailingComma: 'all',
printWidth: 140,
endOfLine: 'lf',
arrowParens: 'always',
}

View File

@ -0,0 +1,14 @@
{
"recommendations": [
"EditorConfig.EditorConfig",
"dotenv.dotenv-vscode",
"esbenp.prettier-vscode",
"dbaeumer.vscode-eslint",
"krysenlo.vite-plugin-eslint-problemmatcher",
"ms-playwright.playwright",
"Orta.vscode-jest",
"bradlc.vscode-tailwindcss",
"csstools.postcss",
]
}

View File

@ -0,0 +1,68 @@
{
"configurations": [
{
"type": "msedge",
"request": "launch",
"name": "Run (Edge)",
"url": "http://localhost:5173",
"webRoot": "${workspaceFolder}",
"presentation": {
"hidden": false,
"group": "2. Web"
}
},
{
"type": "chrome",
"request": "launch",
"name": "Run (Chrome)",
"url": "http://localhost:5173",
"webRoot": "${workspaceFolder}",
"presentation": {
"hidden": false,
"group": "2. Web"
}
},
{
"type": "firefox",
"request": "launch",
"name": "Run (Firefox)",
"url": "http://localhost:5173",
"webRoot": "${workspaceFolder}",
"presentation": {
"hidden": false,
"group": "2. Web"
}
},
{
"name": "Run dApp",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "dev"],
"cwd": "${workspaceRoot}",
"console": "integratedTerminal",
"skipFiles": ["<node_internals>/**", "node_modules/**"],
"presentation": {
"hidden": false,
"group": "1. Run Project",
"order": 1
}
},
{
"name": "Run dApp (+ LocalNet)",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "dev"],
"cwd": "${workspaceRoot}",
"console": "integratedTerminal",
"skipFiles": ["<node_internals>/**", "node_modules/**"],
"preLaunchTask": "Start AlgoKit LocalNet",
"presentation": {
"hidden": false,
"group": "1. Run Project",
"order": 1
}
}
]
}

View File

@ -0,0 +1,13 @@
{
"editor.formatOnSave": true,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "explicit"
},
"dotenv.enableAutocloaking": false,
"jest.autoRun": {
"watch": false,
"onSave": "test-file"
}
}

View File

@ -0,0 +1,15 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Start AlgoKit LocalNet",
"command": "algokit",
"args": ["localnet", "start"],
"type": "shell",
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
}
]
}

View File

@ -0,0 +1,124 @@
# TokenizeRWATemplate-frontend
This starter React project has been generated using AlgoKit. See below for default getting started instructions.
# Setup
### 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:
- **npm**: Node package manager. Install from [Node.js Installation Guide](https://nodejs.org/en/download/). Verify with `npm -v` to see version `18.12`+.
- **AlgoKit CLI**: Essential for project setup and operations. Install the latest version from [AlgoKit CLI Installation Guide](https://github.com/algorandfoundation/algokit-cli#install). Verify installation with `algokit --version`, expecting `2.0.0` or later.
#### 3. Bootstrap Your Local Environment
Run the following commands within the project folder:
- **Install Project Dependencies**: With `algokit project bootstrap all`, ensure all dependencies are ready.
### Development Workflow
#### Terminal
Directly manage and interact with your project using AlgoKit commands:
1. **Build Contracts**: `algokit project run build` builds react web app and links with smart contracts in workspace, if any.
2. Remaining set of command for linting, testing and deployment can be found in respective [package.json](./package.json) file and [.algokit.toml](./.algokit.toml) files.
#### VS Code
For a seamless experience with breakpoint debugging and other features:
1. **Open Project**: In VS Code, open the repository root.
2. **Install Extensions**: Follow prompts to install recommended extensions.
3. **Debugging**:
- Use `F5` to start debugging.
- **Windows Users**: Select the Python interpreter at `./.venv/Scripts/python.exe` via `Ctrl/Cmd + Shift + P` > `Python: Select Interpreter` before the first run.
#### Other IDEs
While primarily optimized for VS Code, Jetbrains WebStorm has base support for this project:
1. **Open Project**: In your JetBrains IDE, open the repository root.
2. **Automatic Setup**: The IDE should configure the Python interpreter and virtual 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.
> Please note, by default frontend is pre configured to run against Algorand LocalNet. If you want to run against TestNet or MainNet, comment out the current environment variable and uncomment the relevant one in [`.env`](.env) file that is created after running bootstrap command and based on [`.env.template`](.env.template).
### Continuous Integration
This project uses [GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions) to define CI workflows, which are located in the [.github/workflows](`../../.github/workflows`) folder.
For pull requests and pushes to `main` branch against this repository the following checks are automatically performed by GitHub Actions:
- `install`: Installs dependencies using `npm`
- `lint`: Lints the codebase using `ESLint`
- `build`: Builds the codebase using `vite`
> Please note, if you instantiated the project via `algokit init` without explicitly specifying the `--no-workspace` flag, we will automatically attempt to move the contents of the `.github` folder to the root of the workspace.
### Continuous Deployment
The project template provides base Github Actions workflows for continuous deployment to [Netlify](https://www.netlify.com/) or [Vercel](https://vercel.com/). These workflows are located in the [`.github/workflows`](./.github/workflows) folder.
**Please note**: when configuring the github repository for the first time. Depending on selected provider you will need to set the provider secrets in the repository settings. Default setup provided by the template allows you to manage the secrets via environment variables and secrets on your github repository.
#### Setting up environment variables and secrets for webapp deployment
For Vercel:
1. Retrieve your [Vercel Access Token](https://vercel.com/support/articles/how-do-i-use-a-vercel-api-access-token)
2. Install the [Vercel CLI](https://vercel.com/cli) and run `vercel login`
3. Inside your folder, run `vercel link` to create a new Vercel project
4. Inside the generated `.vercel` folder, save the `projectId` and `orgId` from the `project.json`
5. Inside GitHub, add `VERCEL_TOKEN`, `VERCEL_ORG_ID`, and `VERCEL_PROJECT_ID` as [secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
6. Create an .env file containing ENV vars for the project (pointing to testnet or mainnet), drag and drop the .env file to upload initial batch of default environment variables to your vercel project.
7. Upon invocation, CD pipeline will pull the VITE_ prefixed environment variables, build the project and deploy to the specified environment.
For Netlify:
1. Retrieve your [Netlify Access Token](https://docs.netlify.com/cli/get-started/#obtain-a-token-in-the-netlify-ui)
2. Inside your folder run `netlify login`
3. Inside your folder run `netlify sites:create` to create a new site, obtain NETLIFY_SITE_ID from the output
4. Inside GitHub, add `NETLIFY_AUTH_TOKEN` and `NETLIFY_SITE_ID` as [secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
5. Define the VITE_ prefixed environment variables in netlify environment variables under site settings.
6. Upon invocation, CD pipeline will build the project and deploy to the specified environment.
> If you prefer alternative deployment methods, you can modify the relevant workflow files from the [`.github/workflows`](./.github/workflows) folder or modify deploy scripts in `.algokit.toml`.
# Algorand Wallet integrations
The template comes with [`use-wallet`](https://github.com/txnlab/use-wallet) integration, which provides a React hook for connecting to an Algorand wallet providers. The following wallet providers are included by default:
- LocalNet:
- - [KMD/Local Wallet](https://github.com/TxnLab/use-wallet#kmd-algorand-key-management-daemon) - Algorand's Key Management Daemon (KMD) is a service that manages Algorand private keys and signs transactions. Works best with AlgoKit LocalNet and allows you to easily test and interact with your dApps locally.
- TestNet and others:
- - [Pera Wallet](https://perawallet.app).
- - [Defly Wallet](https://defly.app).
- - [Exodus Wallet](https://www.exodus.com).
- - [Daffi Wallet](https://www.daffi.me).
Refer to official [`use-wallet`](https://github.com/txnlab/use-wallet) documentation for detailed guidelines on how to integrate with other wallet providers (such as WalletConnect v2). Too see implementation details on the use wallet hook and initialization of extra wallet providers refer to [`App.tsx`](./src/App.tsx).
# Tools
This project makes use of React and Tailwind to provider a base project configuration to develop frontends for your Algorand dApps and interactions with smart contracts. The following tools are in use:
- [AlgoKit Utils](https://github.com/algorandfoundation/algokit-utils-ts) - Various TypeScript utilities to simplify interactions with Algorand and AlgoKit.
- [React](https://reactjs.org/) - A JavaScript library for building user interfaces.
- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework for rapidly building custom designs.
- [daisyUI](https://daisyui.com/) - A component library for Tailwind CSS.
- [use-wallet](https://github.com/txnlab/use-wallet) - A React hook for connecting to an Algorand wallet providers.
- [npm](https://www.npmjs.com/): Node.js package manager
- [jest](https://jestjs.io/): JavaScript testing framework
- [playwright](https://playwright.dev/): Browser automation library
- [Prettier](https://prettier.io/): Opinionated code formatter
- [ESLint](https://eslint.org/): Tool for identifying and reporting on patterns in JavaScript
- 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 [.vscode](./.vscode) folder.
# Integrating with smart contracts and application clients
Refer to the detailed guidance on [integrating with smart contracts and application clients](./src/contracts/README.md). In essence, for any smart contract codebase generated with AlgoKit or other tools that produce compile contracts into ARC34 compliant app specifications, you can use the `algokit generate` command to generate TypeScript or Python typed client. Once generated simply drag and drop the generated client into `./src/contracts` and import it into your React components as you see fit.

View File

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>AlgoKit React Template</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>

View File

@ -0,0 +1,20 @@
import type { Config } from '@jest/types'
const config: Config.InitialOptions = {
preset: 'ts-jest',
testEnvironment: 'node',
testMatch: ['**/*.spec.ts', '**/*.spec.tsx'],
moduleDirectories: ['node_modules', 'src'],
transform: {
'<regex_match_files>': [
'ts-jest',
{
tsconfig: 'tsconfig.test.json',
},
],
},
coveragePathIgnorePatterns: ['tests'],
testPathIgnorePatterns: ['/tests/'],
}
export default config

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,84 @@
{
"name": "TokenizeRWATemplate-frontend",
"version": "0.1.0",
"author": {
"name": "SaraJane",
"email": "sarajanedeveloper@gmail.com"
},
"private": true,
"type": "module",
"engines": {
"node": ">=20.0",
"npm": ">=9.0"
},
"devDependencies": {
"@algorandfoundation/algokit-client-generator": "^5.0.0",
"@types/node": "^18.17.14",
"@types/react": "^18.2.11",
"@types/react-dom": "^18.2.4",
"@vitejs/plugin-react": "^4.2.1",
"autoprefixer": "^10.4.14",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"eslint-plugin-prettier": "^5.1.3",
"@typescript-eslint/eslint-plugin": "^7.0.2",
"@typescript-eslint/parser": "^7.0.2",
"postcss": "^8.4.24",
"tailwindcss": "3.3.2",
"ts-jest": "^29.1.1",
"@types/jest": "29.5.2",
"ts-node": "^10.9.1",
"typescript": "^5.1.6",
"@playwright/test": "^1.35.0",
"playwright": "^1.35.0",
"vite": "^5.0.0",
"vite-plugin-node-polyfills": "^0.22.0"
},
"dependencies": {
"@algorandfoundation/algokit-utils": "^9.0.0",
"@blockshake/defly-connect": "^1.2.1",
"@perawallet/connect": "^1.4.1",
"@txnlab/use-wallet": "^4.0.0",
"@txnlab/use-wallet-react": "^4.0.0",
"algosdk": "^3.0.0",
"daisyui": "^4.0.0",
"notistack": "^3.0.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"tslib": "^2.6.2"
},
"scripts": {
"generate:app-clients": "algokit project link --all",
"dev": "npm run generate:app-clients && vite",
"build": "npm run generate:app-clients && tsc && vite build",
"test": "jest --coverage --passWithNoTests",
"playwright:test": "playwright test",
"lint": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
"lint:fix": "eslint src --ext ts,tsx --report-unused-disable-directives --max-warnings 0 --fix",
"ci:vercel:build": "vercel build --prod --token=$VERCEL_TOKEN",
"ci:vercel:pull": "vercel pull --yes --environment=production --token=$VERCEL_TOKEN",
"ci:vercel:deploy": "npm run ci:vercel:build && vercel deploy --prebuilt --prod --token=$VERCEL_TOKEN",
"preview": "vite preview"
},
"eslintConfig": {
"extends": [
"react-app/jest",
"react-app"
]
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
},
"overrides": {
"ws@>7.0.0 <7.5.9": "7.5.10"
}
}

View File

@ -0,0 +1,73 @@
import { defineConfig, devices } from '@playwright/test'
/**
* Read environment variables from file.
* https://github.com/motdotla/dotenv
*/
// require('dotenv').config();
/**
* See https://playwright.dev/docs/test-configuration.
*/
export default defineConfig({
testDir: './tests',
/* Run tests in files in parallel */
fullyParallel: true,
/* Fail the build on CI if you accidentally left test.only in the source code. */
forbidOnly: !!process.env.CI,
/* Retry on CI only */
retries: process.env.CI ? 2 : 0,
/* Opt out of parallel tests on CI. */
workers: process.env.CI ? 1 : undefined,
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
reporter: 'html',
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
use: {
/* Base URL to use in actions like `await page.goto('/')`. */
// baseURL: 'http://127.0.0.1:3000',
/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
trace: 'on-first-retry',
testIdAttribute: 'data-test-id',
},
/* Configure projects for major browsers */
projects: [
{
name: 'chromium',
use: { ...devices['Desktop Chrome'] },
},
{
name: 'firefox',
use: { ...devices['Desktop Firefox'] },
},
/* Test against mobile viewports. */
// {
// name: 'Mobile Chrome',
// use: { ...devices['Pixel 5'] },
// },
// {
// name: 'Mobile Safari',
// use: { ...devices['iPhone 12'] },
// },
/* Test against branded browsers. */
// {
// name: 'Microsoft Edge',
// use: { ...devices['Desktop Edge'], channel: 'msedge' },
// },
// {
// name: 'Google Chrome',
// use: { ..devices['Desktop Chrome'], channel: 'chrome' },
// },
],
/* Run your local dev server before starting the tests */
webServer: {
command: 'npm run dev',
url: 'http://localhost:5173',
reuseExistingServer: !process.env.CI,
},
})

View File

@ -0,0 +1,6 @@
module.exports = {
plugins: {
tailwindcss: {},
autoprefixer: {},
},
}

View File

@ -0,0 +1,37 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-react-app"
/>
<!--
Notice the use of %PUBLIC_URL% in the tags above.
It will be replaced with the URL of the `public` folder during the build.
Only files inside the `public` folder can be referenced from the HTML.
Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>React App</title>
</head>
<body>
<noscript>You need to enable JavaScript to run this app.</noscript>
<div id="root"></div>
<!--
This HTML file is a template.
If you open it directly in the browser, you will see an empty page.
You can add webfonts, meta tags, or analytics to this file.
The build step will place the bundled scripts into the <body> tag.
To begin the development, run `npm start` or `yarn start`.
To create a production bundle, use `npm run build` or `yarn build`.
-->
</body>
</html>

View File

@ -0,0 +1,3 @@
# https://www.robotstxt.org/robotstxt.html
User-agent: *
Disallow:

View File

@ -0,0 +1,56 @@
import { SupportedWallet, WalletId, WalletManager, WalletProvider } from '@txnlab/use-wallet-react'
import { SnackbarProvider } from 'notistack'
import Home from './Home'
import { getAlgodConfigFromViteEnvironment, getKmdConfigFromViteEnvironment } from './utils/network/getAlgoClientConfigs'
let supportedWallets: SupportedWallet[]
if (import.meta.env.VITE_ALGOD_NETWORK === 'localnet') {
const kmdConfig = getKmdConfigFromViteEnvironment()
supportedWallets = [
{
id: WalletId.KMD,
options: {
baseServer: kmdConfig.server,
token: String(kmdConfig.token),
port: String(kmdConfig.port),
},
},
]
} else {
supportedWallets = [
{ id: WalletId.DEFLY },
{ id: WalletId.PERA },
{ id: WalletId.EXODUS },
// If you are interested in WalletConnect v2 provider
// refer to https://github.com/TxnLab/use-wallet for detailed integration instructions
]
}
export default function App() {
const algodConfig = getAlgodConfigFromViteEnvironment()
const walletManager = new WalletManager({
wallets: supportedWallets,
defaultNetwork: algodConfig.network,
networks: {
[algodConfig.network]: {
algod: {
baseServer: algodConfig.server,
port: algodConfig.port,
token: String(algodConfig.token),
},
},
},
options: {
resetNetwork: true,
},
})
return (
<SnackbarProvider maxSnack={3}>
<WalletProvider manager={walletManager}>
<Home />
</WalletProvider>
</SnackbarProvider>
)
}

View File

@ -0,0 +1,76 @@
// src/components/Home.tsx
import { useWallet } from '@txnlab/use-wallet-react'
import React, { useState } from 'react'
import ConnectWallet from './components/ConnectWallet'
import Transact from './components/Transact'
import AppCalls from './components/AppCalls'
interface HomeProps {}
const Home: React.FC<HomeProps> = () => {
const [openWalletModal, setOpenWalletModal] = useState<boolean>(false)
const [openDemoModal, setOpenDemoModal] = useState<boolean>(false)
const [appCallsDemoModal, setAppCallsDemoModal] = useState<boolean>(false)
const { activeAddress } = useWallet()
const toggleWalletModal = () => {
setOpenWalletModal(!openWalletModal)
}
const toggleDemoModal = () => {
setOpenDemoModal(!openDemoModal)
}
const toggleAppCallsModal = () => {
setAppCallsDemoModal(!appCallsDemoModal)
}
return (
<div className="hero min-h-screen bg-teal-400">
<div className="hero-content text-center rounded-lg p-6 max-w-md bg-white mx-auto">
<div className="max-w-md">
<h1 className="text-4xl">
Welcome to <div className="font-bold">AlgoKit 🙂</div>
</h1>
<p className="py-6">
This starter has been generated using official AlgoKit React template. Refer to the resource below for next steps.
</p>
<div className="grid">
<a
data-test-id="getting-started"
className="btn btn-primary m-2"
target="_blank"
href="https://github.com/algorandfoundation/algokit-cli"
>
Getting started
</a>
<div className="divider" />
<button data-test-id="connect-wallet" className="btn m-2" onClick={toggleWalletModal}>
Wallet Connection
</button>
{activeAddress && (
<button data-test-id="transactions-demo" className="btn m-2" onClick={toggleDemoModal}>
Transactions Demo
</button>
)}
{activeAddress && (
<button data-test-id="appcalls-demo" className="btn m-2" onClick={toggleAppCallsModal}>
Contract Interactions Demo
</button>
)}
</div>
<ConnectWallet openModal={openWalletModal} closeModal={toggleWalletModal} />
<Transact openModal={openDemoModal} setModalState={setOpenDemoModal} />
<AppCalls openModal={appCallsDemoModal} setModalState={setAppCallsDemoModal} />
</div>
</div>
</div>
)
}
export default Home

View File

@ -0,0 +1 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3"><g fill="#61DAFB"><path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/><circle cx="420.9" cy="296.5" r="45.7"/><path d="M520.5 78.1z"/></g></svg>

After

Width:  |  Height:  |  Size: 2.6 KiB

View File

@ -0,0 +1,24 @@
import { useWallet } from '@txnlab/use-wallet-react'
import { useMemo } from 'react'
import { ellipseAddress } from '../utils/ellipseAddress'
import { getAlgodConfigFromViteEnvironment } from '../utils/network/getAlgoClientConfigs'
const Account = () => {
const { activeAddress } = useWallet()
const algoConfig = getAlgodConfigFromViteEnvironment()
const networkName = useMemo(() => {
return algoConfig.network === '' ? 'localnet' : algoConfig.network.toLocaleLowerCase()
}, [algoConfig.network])
return (
<div>
<a className="text-xl" target="_blank" href={`https://lora.algokit.io/${networkName}/account/${activeAddress}/`}>
Address: {ellipseAddress(activeAddress)}
</a>
<div className="text-xl">Network: {networkName}</div>
</div>
)
}
export default Account

View File

@ -0,0 +1,98 @@
import { useWallet } from '@txnlab/use-wallet-react'
import { useSnackbar } from 'notistack'
import { useState } from 'react'
import { HelloWorldFactory } from '../contracts/HelloWorld'
import { OnSchemaBreak, OnUpdate } from '@algorandfoundation/algokit-utils/types/app'
import { getAlgodConfigFromViteEnvironment, getIndexerConfigFromViteEnvironment } from '../utils/network/getAlgoClientConfigs'
import { AlgorandClient } from '@algorandfoundation/algokit-utils'
interface AppCallsInterface {
openModal: boolean
setModalState: (value: boolean) => void
}
const AppCalls = ({ openModal, setModalState }: AppCallsInterface) => {
const [loading, setLoading] = useState<boolean>(false)
const [contractInput, setContractInput] = useState<string>('')
const { enqueueSnackbar } = useSnackbar()
const { transactionSigner, activeAddress } = useWallet()
const algodConfig = getAlgodConfigFromViteEnvironment()
const indexerConfig = getIndexerConfigFromViteEnvironment()
const algorand = AlgorandClient.fromConfig({
algodConfig,
indexerConfig,
})
algorand.setDefaultSigner(transactionSigner)
const sendAppCall = async () => {
setLoading(true)
// Please note, in typical production scenarios,
// you wouldn't want to use deploy directly from your frontend.
// Instead, you would deploy your contract on your backend and reference it by id.
// Given the simplicity of the starter contract, we are deploying it on the frontend
// for demonstration purposes.
const factory = new HelloWorldFactory({
defaultSender: activeAddress ?? undefined,
algorand,
})
const deployResult = await factory
.deploy({
onSchemaBreak: OnSchemaBreak.AppendApp,
onUpdate: OnUpdate.AppendApp,
})
.catch((e: Error) => {
enqueueSnackbar(`Error deploying the contract: ${e.message}`, { variant: 'error' })
setLoading(false)
return undefined
})
if (!deployResult) {
return
}
const { appClient } = deployResult
const response = await appClient.send.hello({ args: { name: contractInput } }).catch((e: Error) => {
enqueueSnackbar(`Error calling the contract: ${e.message}`, { variant: 'error' })
setLoading(false)
return undefined
})
if (!response) {
return
}
enqueueSnackbar(`Response from the contract: ${response.return}`, { variant: 'success' })
setLoading(false)
}
return (
<dialog id="appcalls_modal" className={`modal ${openModal ? 'modal-open' : ''} bg-slate-200`}>
<form method="dialog" className="modal-box">
<h3 className="font-bold text-lg">Say hello to your Algorand smart contract</h3>
<br />
<input
type="text"
placeholder="Provide input to hello function"
className="input input-bordered w-full"
value={contractInput}
onChange={(e) => {
setContractInput(e.target.value)
}}
/>
<div className="modal-action ">
<button className="btn" onClick={() => setModalState(!openModal)}>
Close
</button>
<button className={`btn`} onClick={sendAppCall}>
{loading ? <span className="loading loading-spinner" /> : 'Send application call'}
</button>
</div>
</form>
</dialog>
)
}
export default AppCalls

View File

@ -0,0 +1,86 @@
import { useWallet, Wallet, WalletId } from '@txnlab/use-wallet-react'
import Account from './Account'
interface ConnectWalletInterface {
openModal: boolean
closeModal: () => void
}
const ConnectWallet = ({ openModal, closeModal }: ConnectWalletInterface) => {
const { wallets, activeAddress } = useWallet()
const isKmd = (wallet: Wallet) => wallet.id === WalletId.KMD
return (
<dialog id="connect_wallet_modal" className={`modal ${openModal ? 'modal-open' : ''}`}>
<form method="dialog" className="modal-box">
<h3 className="font-bold text-2xl">Select wallet provider</h3>
<div className="grid m-2 pt-5">
{activeAddress && (
<>
<Account />
<div className="divider" />
</>
)}
{!activeAddress &&
wallets?.map((wallet) => (
<button
data-test-id={`${wallet.id}-connect`}
className="btn border-teal-800 border-1 m-2"
key={`provider-${wallet.id}`}
onClick={() => {
return wallet.connect()
}}
>
{!isKmd(wallet) && (
<img
alt={`wallet_icon_${wallet.id}`}
src={wallet.metadata.icon}
style={{ objectFit: 'contain', width: '30px', height: 'auto' }}
/>
)}
<span>{isKmd(wallet) ? 'LocalNet Wallet' : wallet.metadata.name}</span>
</button>
))}
</div>
<div className="modal-action ">
<button
data-test-id="close-wallet-modal"
className="btn"
onClick={() => {
closeModal()
}}
>
Close
</button>
{activeAddress && (
<button
className="btn btn-warning"
data-test-id="logout"
onClick={async () => {
if (wallets) {
const activeWallet = wallets.find((w) => w.isActive)
if (activeWallet) {
await activeWallet.disconnect()
} else {
// Required for logout/cleanup of inactive providers
// For instance, when you login to localnet wallet and switch network
// to testnet/mainnet or vice verse.
localStorage.removeItem('@txnlab/use-wallet:v3')
window.location.reload()
}
}
}}
>
Logout
</button>
)}
</div>
</form>
</dialog>
)
}
export default ConnectWallet

View File

@ -0,0 +1,46 @@
import React, { ReactNode } from 'react'
interface ErrorBoundaryProps {
children: ReactNode
}
interface ErrorBoundaryState {
hasError: boolean
error: Error | null
}
class ErrorBoundary extends React.Component<ErrorBoundaryProps, ErrorBoundaryState> {
constructor(props: ErrorBoundaryProps) {
super(props)
this.state = { hasError: false, error: null }
}
static getDerivedStateFromError(error: Error): ErrorBoundaryState {
// Update state so the next render will show the fallback UI.
return { hasError: true, error: error }
}
render(): ReactNode {
if (this.state.hasError) {
// You can render any custom fallback UI
return (
<div className="hero min-h-screen bg-teal-400">
<div className="hero-content text-center rounded-lg p-6 max-w-md bg-white mx-auto">
<div className="max-w-md">
<h1 className="text-4xl">Error occured</h1>
<p className="py-6">
{this.state.error?.message.includes('Attempt to get default algod configuration')
? 'Please make sure to set up your environment variables correctly. Create a .env file based on .env.template and fill in the required values. This controls the network and credentials for connections with Algod and Indexer.'
: this.state.error?.message}
</p>
</div>
</div>
</div>
)
}
return this.props.children
}
}
export default ErrorBoundary

View File

@ -0,0 +1,80 @@
import { algo, AlgorandClient } from '@algorandfoundation/algokit-utils'
import { useWallet } from '@txnlab/use-wallet-react'
import { useSnackbar } from 'notistack'
import { useState } from 'react'
import { getAlgodConfigFromViteEnvironment } from '../utils/network/getAlgoClientConfigs'
interface TransactInterface {
openModal: boolean
setModalState: (value: boolean) => void
}
const Transact = ({ openModal, setModalState }: TransactInterface) => {
const [loading, setLoading] = useState<boolean>(false)
const [receiverAddress, setReceiverAddress] = useState<string>('')
const algodConfig = getAlgodConfigFromViteEnvironment()
const algorand = AlgorandClient.fromConfig({ algodConfig })
const { enqueueSnackbar } = useSnackbar()
const { transactionSigner, activeAddress } = useWallet()
const handleSubmitAlgo = async () => {
setLoading(true)
if (!transactionSigner || !activeAddress) {
enqueueSnackbar('Please connect wallet first', { variant: 'warning' })
return
}
try {
enqueueSnackbar('Sending transaction...', { variant: 'info' })
const result = await algorand.send.payment({
signer: transactionSigner,
sender: activeAddress,
receiver: receiverAddress,
amount: algo(1),
})
enqueueSnackbar(`Transaction sent: ${result.txIds[0]}`, { variant: 'success' })
setReceiverAddress('')
} catch (e) {
enqueueSnackbar('Failed to send transaction', { variant: 'error' })
}
setLoading(false)
}
return (
<dialog id="transact_modal" className={`modal ${openModal ? 'modal-open' : ''} bg-slate-200`}>
<form method="dialog" className="modal-box">
<h3 className="font-bold text-lg">Send payment transaction</h3>
<br />
<input
type="text"
data-test-id="receiver-address"
placeholder="Provide wallet address"
className="input input-bordered w-full"
value={receiverAddress}
onChange={(e) => {
setReceiverAddress(e.target.value)
}}
/>
<div className="modal-action ">
<button className="btn" onClick={() => setModalState(!openModal)}>
Close
</button>
<button
data-test-id="send-algo"
className={`btn ${receiverAddress.length === 58 ? '' : 'btn-disabled'} lo`}
onClick={handleSubmitAlgo}
>
{loading ? <span className="loading loading-spinner" /> : 'Send 1 Algo'}
</button>
</div>
</form>
</dialog>
)
}
export default Transact

View File

@ -0,0 +1,14 @@
## How to connect my web app with Algorand smart contracts?
The following folder is reserved for the Algorand Application Clients. The clients are used to interact with instances of Algorand Smart Contracts (ASC1s) deployed on-chain.
To integrate this react frontend template with your smart contracts codebase, perform the following steps:
1. Generate the typed client using `algokit generate client -l typescript -o {path/to/this/folder}` or using the dedicated `link` command `algokit project link` (ensure to invoke it from the root of this react project). Using the `link` command is especially useful within workspaces that have multiple contract projects.
2. The generated typescript client should be ready to be imported and used in this react frontend template, making it a full fledged dApp.
> Please note, by default this template defines `"generate:app-clients": "algokit project link --all"` which is a shortcut to automatically link TEAL code from all `contract` projects in the workspace as typed clients into the `frontend` project that is invoking the `link` command. Refer to [documentation](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/features/project/link.md) to read more about `link` command.
## **How to interact with the smart contract?**
The generated client provides a set of functions that can be used to interact with the ABI (Application Binary Interface) compliant Algorand smart contract. For example, if the smart contract has a function called `hello`, the generated client will have a function called `hello` that can be used to interact with the smart contract. Refer to a [full-stack end-to-end starter template](https://github.com/algorandfoundation/algokit-fullstack-template) for a reference example on invoking and interacting with typescript typed clients generated.

View File

@ -0,0 +1,26 @@
import { AlgoClientConfig } from '@algorandfoundation/algokit-utils/types/network-client'
import type { TokenHeader } from 'algosdk/dist/types/client/urlTokenBaseHTTPClient'
export interface AlgoViteClientConfig extends AlgoClientConfig {
/** Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. */
server: string
/** The port to use e.g. 4001, 443, etc. */
port: string | number
/** The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value */
token: string | TokenHeader
/** String representing current Algorand Network type (testnet/mainnet and etc) */
network: string
}
export interface AlgoViteKMDConfig extends AlgoClientConfig {
/** Base URL of the server e.g. http://localhost, https://testnet-api.algonode.cloud/, etc. */
server: string
/** The port to use e.g. 4001, 443, etc. */
port: string | number
/** The token to use for API authentication (or undefined if none needed) - can be a string, or an object with the header key => value */
token: string | TokenHeader
/** KMD wallet name */
wallet: string
/** KMD wallet password */
password: string
}

View File

@ -0,0 +1,13 @@
import React from 'react'
import ReactDOM from 'react-dom/client'
import App from './App'
import './styles/main.css'
import ErrorBoundary from './components/ErrorBoundary'
ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
<React.StrictMode>
<ErrorBoundary>
<App />
</ErrorBoundary>
</React.StrictMode>,
)

View File

@ -0,0 +1,3 @@
@tailwind base;
@tailwind components;
@tailwind utilities;

View File

@ -0,0 +1,15 @@
import { ellipseAddress } from './ellipseAddress'
describe('ellipseAddress', () => {
it('should return ellipsed address with specified width', () => {
const address = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'
const result = ellipseAddress(address, 4)
expect(result).toBe('aaaa...aaaa')
})
it('should return empty string when address is empty', () => {
const address = ''
const result = ellipseAddress(address)
expect(result).toBe('')
})
})

View File

@ -0,0 +1,3 @@
export function ellipseAddress(address: string | null, width = 6): string {
return address ? `${address.slice(0, width)}...${address.slice(-width)}` : (address ?? '')
}

View File

@ -0,0 +1,41 @@
import { AlgoViteClientConfig, AlgoViteKMDConfig } from '../../interfaces/network'
export function getAlgodConfigFromViteEnvironment(): AlgoViteClientConfig {
if (!import.meta.env.VITE_ALGOD_SERVER) {
throw new Error('Attempt to get default algod configuration without specifying VITE_ALGOD_SERVER in the environment variables')
}
return {
server: import.meta.env.VITE_ALGOD_SERVER,
port: import.meta.env.VITE_ALGOD_PORT,
token: import.meta.env.VITE_ALGOD_TOKEN,
network: import.meta.env.VITE_ALGOD_NETWORK,
}
}
export function getIndexerConfigFromViteEnvironment(): AlgoViteClientConfig {
if (!import.meta.env.VITE_INDEXER_SERVER) {
throw new Error('Attempt to get default algod configuration without specifying VITE_INDEXER_SERVER in the environment variables')
}
return {
server: import.meta.env.VITE_INDEXER_SERVER,
port: import.meta.env.VITE_INDEXER_PORT,
token: import.meta.env.VITE_INDEXER_TOKEN,
network: import.meta.env.VITE_ALGOD_NETWORK,
}
}
export function getKmdConfigFromViteEnvironment(): AlgoViteKMDConfig {
if (!import.meta.env.VITE_KMD_SERVER) {
throw new Error('Attempt to get default kmd configuration without specifying VITE_KMD_SERVER in the environment variables')
}
return {
server: import.meta.env.VITE_KMD_SERVER,
port: import.meta.env.VITE_KMD_PORT,
token: import.meta.env.VITE_KMD_TOKEN,
wallet: import.meta.env.VITE_KMD_WALLET,
password: import.meta.env.VITE_KMD_PASSWORD,
}
}

View File

@ -0,0 +1,24 @@
/// <reference types="vite/client" />
interface ImportMetaEnv {
readonly VITE_ENVIRONMENT: string
readonly VITE_ALGOD_TOKEN: string
readonly VITE_ALGOD_SERVER: string
readonly VITE_ALGOD_PORT: string
readonly VITE_ALGOD_NETWORK: string
readonly VITE_INDEXER_TOKEN: string
readonly VITE_INDEXER_SERVER: string
readonly VITE_INDEXER_PORT: string
readonly VITE_KMD_TOKEN: string
readonly VITE_KMD_SERVER: string
readonly VITE_KMD_PORT: string
readonly VITE_KMD_PASSWORD: string
readonly VITE_KMD_WALLET: string
}
interface ImportMeta {
readonly env: ImportMetaEnv
}

View File

@ -0,0 +1,12 @@
/** @type {import('tailwindcss').Config} */
module.exports = {
content: ['./src/**/*.{js,ts,jsx,tsx}'],
theme: {
extend: {},
},
daisyui: {
themes: ['lofi'],
logs: false,
},
plugins: [require('daisyui')],
}

View File

@ -0,0 +1,40 @@
import { algorandFixture } from '@algorandfoundation/algokit-utils/testing'
import { expect, test } from '@playwright/test'
const localnet = algorandFixture()
test.beforeEach(async ({ page }) => {
await localnet.newScope()
await page.goto('http://localhost:5173/')
})
test('has title', async ({ page }) => {
// Expect a title "to contain" a substring.
await expect(page).toHaveTitle('AlgoKit React Template')
})
test('get started link', async ({ page }) => {
await expect(page.getByTestId('getting-started')).toHaveText('Getting started')
})
test('authentication and dummy payment transaction', async ({ page }) => {
page.on('dialog', async (dialog) => {
dialog.message() === 'KMD password' ? await dialog.accept() : await dialog.dismiss()
})
// 1. Must be able to connect to a KMD wallet provider
await page.getByTestId('connect-wallet').click()
await page.getByTestId('kmd-connect').click()
await page.getByTestId('close-wallet-modal').click()
// 2. Must be able to send a dummy payment transaction
await page.getByTestId('transactions-demo').click()
await page.getByTestId('receiver-address').fill(localnet.context.testAccount.toString())
await page.getByTestId('send-algo').click()
// 3. Must be able to see a notification that the transaction was sent
const notification = await page.getByText('Transaction sent:')
await notification.waitFor()
expect(notification).toBeTruthy()
})

View File

@ -0,0 +1,38 @@
{
"compilerOptions": {
"target": "ES2020" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
"module": "ES2022" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
"declaration": true /* Generates corresponding '.d.ts' file. */,
"declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
"sourceMap": true /* Generates corresponding '.map' file. */,
"strict": true /* Enable all strict type-checking options. */,
"noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
"noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
"experimentalDecorators": true /* Enables experimental support for ES7 decorators. */,
"emitDecoratorMetadata": true /* Enables experimental support for emitting type metadata for decorators. */,
"skipLibCheck": true /* Skip type checking of declaration files. */,
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */,
"allowJs": false,
"allowSyntheticDefaultImports": true,
"moduleResolution": "Node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"jsx": "react-jsx",
"outDir": "./dist/"
},
"include": [
"src/**/*.ts",
"src/**/*.tsx",
"vite.config.js",
"src/utils/ellipseAddress.spec.tsx",
"src/utils/ellipseAddress.spec.tsx",
"src/main.tsx",
],
"references": [
{
"path": "./tsconfig.node.json"
}
]
}

View File

@ -0,0 +1,9 @@
{
"compilerOptions": {
"composite": true,
"module": "ESNext",
"moduleResolution": "Node",
"allowSyntheticDefaultImports": true
},
"include": ["vite.config.ts"]
}

View File

@ -0,0 +1,15 @@
import react from '@vitejs/plugin-react'
import { defineConfig } from 'vite'
import { nodePolyfills } from 'vite-plugin-node-polyfills'
// https://vitejs.dev/config/
export default defineConfig({
plugins: [
react(),
nodePolyfills({
globals: {
Buffer: true,
},
}),
],
})