Project initialised with AlgoKit CLI using template: https://github.c…

…om/algorand-devrel/tealscript-algokit-template.git

.algokit.toml

@@ -0,0 +1,6 @@
+[algokit]
+min_version = "v1.12.1"
+
+[project]
+type = 'workspace'
+projects_root_path = 'projects'

.devcontainer.json

@@ -0,0 +1,19 @@
+{
+  "forwardPorts": [4001, 4002, 8980, 5173],
+  "portsAttributes": {
+    "4001": {
+      "label": "algod"
+    },
+    "4002": {
+      "label": "kmd"
+    },
+    "8980": {
+      "label": "indexer"
+    },
+    "5173": {
+      "label": "vite"
+    }
+  },
+  "postCreateCommand": "mkdir -p ~/.config/algokit && pipx install algokit && sudo chown -R codespace:codespace ~/.config/algokit",
+  "postStartCommand": "for i in {1..5}; do algokit localnet status > /dev/null 2>&1 && break || sleep 30; algokit localnet reset; done"
+}

.editorconfig

@@ -0,0 +1,10 @@
+[*]
+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
+single_quote = true

.gitattributes

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

.gitignore

@@ -0,0 +1,170 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Ruff (linter)
+.ruff_cache/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/
+!.idea/runConfigurations
+
+# macOS
+.DS_Store
+
+# Received approval test files
+*.received.*
+
+# NPM
+node_modules
+

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  // Disabled due to matangover.mypy extension not supporting monorepos
+  // To be addressed as part of https://github.com/matangover/mypy-vscode/issues/82
+  "mypy.enabled": false
+}

MetaMerkles.code-workspace

@@ -0,0 +1,32 @@
+{
+  "folders": [
+    {
+      "path": "./",
+      "name": "ROOT"
+    },
+    {
+      "path": "projects/MetaMerkles"
+    }
+  ],
+  "settings": {
+    "files.exclude": {
+      "projects/": true
+    },
+    "jest.disabledWorkspaceFolders": [
+      "ROOT",
+      "projects"
+    ]
+  },
+  "extensions": {
+    "recommendations": [
+      "joshx.workspace-terminals"
+    ]
+  },
+  "tasks": {
+    "version": "2.0.0",
+    "tasks": []
+  },
+  "launch": {
+    "configurations": []
+  }
+}

README.md

@@ -0,0 +1,21 @@
+# MetaMerkles
+
+Welcome to your new AlgoKit project!
+
+This is your workspace root. A `workspace` in AlgoKit is an orchestrated collection of standalone projects (backends, smart contracts, frontend apps and etc).
+
+By default, `projects_root_path` parameter is set to `projects`. Which instructs AlgoKit CLI to create a new directory under `projects` directory when new project is instantiated via `algokit init` at the root of the workspace.
+
+## Getting Started
+
+To get started refer to `README.md` files in respective sub-projects in the `projects` directory.
+
+To learn more about algokit, visit [documentation](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md).
+
+### GitHub Codespaces
+
+If executing this repository in GitHub Codespaces, the container will automatically cleanup templatized content and pre-install `algokit` for you. To get started execute:
+
+- `algokit init` - to invoke interactive wizard to guide you through the process of creating a new AlgoKit project
+
+Powered by [Copier templates](https://copier.readthedocs.io/en/stable/).

projects/MetaMerkles/.algokit.toml

@@ -0,0 +1,15 @@
+[algokit]
+min_version = "v2.0.0"
+
+[project]
+type = 'contract'
+name = 'MetaMerkles'
+artifacts = 'contracts/artifacts'
+
+[project.run]
+build = { commands = [ 
+  'npm run build',
+], description = 'Build all smart contracts in the project' }
+test = { commands = [
+  'npm run test',
+], description = 'Run smart contract tests' }

projects/MetaMerkles/.eslintrc.js

@@ -0,0 +1,56 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+  },
+  extends: [
+    'airbnb-base',
+    'plugin:import/errors',
+    'plugin:import/warnings',
+    'plugin:import/typescript',
+    'plugin:prettier/recommended',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/ban-ts-comment': 'warn',
+    'import/prefer-default-export': 'off',
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        js: 'never',
+        jsx: 'never',
+        ts: 'never',
+        tsx: 'never',
+      },
+    ],
+    'import/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: ['**/*.test.ts'],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: ['*.algo.ts'],
+      rules: {
+        'import/no-extraneous-dependencies': 'off',
+        'object-shorthand': 'off',
+        'class-methods-use-this': 'off',
+        'no-undef': 'off',
+        'max-classes-per-file': 'off',
+        'no-bitwise': 'off',
+        'operator-assignment': 'off',
+        'prefer-template': 'off',
+        'prefer-destructuring': 'off',
+      },
+    },
+  ],
+};

projects/MetaMerkles/.gitignore

@@ -0,0 +1 @@
+node_modules/

projects/MetaMerkles/.prettierrc.toml

@@ -0,0 +1,6 @@
+# .prettierrc.toml
+trailingComma = "es5"
+tabWidth = 2
+semi = true
+singleQuote = true
+printWidth = 120

projects/MetaMerkles/.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+    "recommendations": [
+        "dbaeumer.vscode-eslint",
+    ]
+  }

projects/MetaMerkles/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": "explicit"
+    },
+}

projects/MetaMerkles/README.md

@@ -0,0 +1,25 @@
+# TEALScript Project
+
+## Documentation
+
+For TEALScript documentation, go to https://tealscript.algo.xyz
+
+## Usage
+
+### Algokit
+
+This template assumes you have a local network running on your machine. The easiet way to setup a local network is with [algokit](https://github.com/algorandfoundation/algokit-cli). If you don't have Algokit or its dependencies installed locally you can open this repository in a GitHub codespace via https://codespaces.new and choosing this repo.
+
+### Build Contract
+
+`npm run build` will compile the contract to TEAL and generate an ABI and appspec JSON in [./contracts/artifacts](./contracts/artifacts/) and a algokit TypeScript client in [./contracts/clients](./contracts/clients/).
+
+`npm run compile-contract` or `npm run generate-client` can be used to compile the contract or generate the contract seperately.
+
+### Run Tests
+
+`npm run test` will execute the tests defined in [./\_\_test\_\_](./__test__) 
+
+### Lint
+
+`npm run lint` will lint the contracts and tests with ESLint.