{"id":13618830,"url":"https://github.com/AztecProtocol/aztec-starter","last_synced_at":"2025-04-14T15:33:30.041Z","repository":{"id":213426073,"uuid":"733726710","full_name":"AztecProtocol/aztec-starter","owner":"AztecProtocol","description":"A simple aztec contract + test to get started.","archived":false,"fork":false,"pushed_at":"2025-04-10T15:02:50.000Z","size":816,"stargazers_count":36,"open_issues_count":8,"forks_count":42,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-11T17:56:31.676Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AztecProtocol.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-20T01:41:12.000Z","updated_at":"2025-04-04T14:27:07.000Z","dependencies_parsed_at":"2023-12-21T00:30:07.881Z","dependency_job_id":"cf0beeea-49ee-4e2d-8ca7-c6d04ec4aa5d","html_url":"https://github.com/AztecProtocol/aztec-starter","commit_stats":null,"previous_names":["aztecprotocol/aztec-starter"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AztecProtocol%2Faztec-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AztecProtocol%2Faztec-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AztecProtocol%2Faztec-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AztecProtocol%2Faztec-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AztecProtocol","download_url":"https://codeload.github.com/AztecProtocol/aztec-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248906819,"owners_count":21181222,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T21:00:31.132Z","updated_at":"2025-04-14T15:33:30.036Z","avatar_url":"https://github.com/AztecProtocol.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://aztec.network\"\u003e\n    \u003cimg src=\"https://github.com/AztecProtocol/aztec-packages/blob/master/docs/static/img/aztec-logo.9cde8ae1.svg\" alt=\"Aztec Protocol Logo\" width=\"300\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n# Aztec Starter\n\nThis repo is meant to be a starting point for writing Aztec contracts and tests.\n\nYou can find the **Easy Private Voting contract** in `./src/main.nr`. A simple integration test is in `./src/test/index.test.ts`.\n\nThe corresponding tutorial can be found in the [Aztec docs here](https://docs.aztec.network/developers/tutorials/codealong/contract_tutorials/private_voting_contract).\n\n\u003cdiv align=\"center\"\u003e\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/AztecProtocol/aztec-starter?logo=github\u0026color=yellow)](https://github.com/AztecProtocol/aztec-starter/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/AztecProtocol/aztec-starter?logo=github\u0026color=blue)](https://github.com/AztecProtocol/aztec-starter/network/members)\n[![Build](https://github.com/AztecProtocol/aztec-starter/actions/workflows/update.yaml/badge.svg)](https://github.com/AztecProtocol/aztec-starter/actions)\n[![GitHub last commit](https://img.shields.io/github/last-commit/AztecProtocol/aztec-starter?logo=git)](https://github.com/AztecProtocol/aztec-starter/commits/main)\n[![License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/license/mit)\n[![Discord](https://img.shields.io/badge/discord-join%20chat-5B5EA6)](https://discord.gg/aztec)\n[![Twitter Follow](https://img.shields.io/twitter/follow/aztecnetwork?style=flat\u0026logo=twitter)](https://x.com/aztecnetwork)\n\n\u003c/div\u003e\n\n---\n\n## 🚀 **Getting Started**\n\nUse **Node.js version 18.19.0**.\n\n[Start your codespace from the codespace dropdown](https://docs.github.com/en/codespaces/getting-started/quickstart).\n\nGet the **sandbox, aztec-cli, and other tooling** with this command:\n\n```bash\nbash -i \u003c(curl -s https://install.aztec.network)\n```\n\nInstall the correct version of the toolkit with:\n\n```bash\naztec-up 0.84.0\n```\n\nStart the sandbox with:\n\n```bash\naztec start --sandbox\n```\n\n---\n\n## 📦 **Install Packages**\n\nWe need to ignore node version warnings (a temporary fix):\n\n```bash\nYARN_IGNORE_ENGINES=true yarn install\n```\n\n---\n\n## 🏗 **Compile**\n\n```bash\naztec-nargo compile\n```\n\nor\n\n```bash\nyarn compile\n```\n\n---\n\n## 🔧 **Codegen**\n\nGenerate the **contract artifact JSON** and TypeScript interface:\n\n```bash\nyarn codegen\n```\n\n---\n\n## 🧪 **Test**\n\n**Make sure the sandbox is running before running tests.**\n\n```bash\naztec start --sandbox\n```\n\nThen test with:\n\n```bash\nyarn test\n```\n\nTesting will run the **TypeScript tests** defined in `index.test.ts` inside `./src/test`, as well as the [Aztec Testing eXecution Environment (TXE)](https://docs.aztec.network/developers/guides/smart_contracts/testing) tests defined in [`first.nr`](./src/test/first.nr) (imported in the contract file with `mod test;`).\n\nNote: The Typescript tests spawn an instance of the sandbox to test against, and close it once the TS tests are complete.\n\n---\n\n## ❗ **Error Resolution**\n\n### 🔄 **Update Node.js and Noir Dependencies**\n\n```bash\nyarn update\n```\n\n### 🔄 **Update Contract**\n\nGet the **contract code from the monorepo**. The script will look at the versions defined in `./Nargo.toml` and fetch that version of the code from the monorepo.\n\n```bash\nyarn update\n```\n\nYou may need to update permissions with:\n\n```bash\nchmod +x update_contract.sh\n```\n\n### 💬 Join the Community:\n\n\u003cp align=\"left\"\u003e\n  \u003ca href=\"https://forum.aztec.network\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Aztec%20%20Forum-5C4C9F?style=for-the-badge\u0026logo=startrek\u0026logoColor=white\" alt=\"Forum\"\u003e\n  \u003c/a\u003e  \n  \u003ca href=\"https://t.me/AztecAnnouncements_Official\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Telegram-26A5E4?logo=telegram\u0026logoColor=white\u0026style=for-the-badge\" alt=\"Telegram\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://discord.gg/aztec\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Discord-5865F2?logo=discord\u0026logoColor=white\u0026style=for-the-badge\" alt=\"Discord\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://x.com/aztecnetwork\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Twitter-000000?logo=x\u0026logoColor=white\u0026style=for-the-badge\" alt=\"Twitter (X)\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","funding_links":[],"categories":["Coding"],"sub_categories":["Boilerplates"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAztecProtocol%2Faztec-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAztecProtocol%2Faztec-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAztecProtocol%2Faztec-starter/lists"}