Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How can we bundle some example Noir Contracts into aztec-cli? #1357

Closed
iAmMichaelConnor opened this issue Aug 1, 2023 · 3 comments
Closed
Labels
A-ux/devex Area: relates to external ux / devex. (Users typically are devs) (See also A-internal-devex) T-question Type: Someone is asking a questions about something

Comments

@iAmMichaelConnor
Copy link
Contributor

To get users up and running as quickly as possible, it would be useful if the aztec-cli (or aztec.js or the sandbox??) could come bundled with some simple example Noir Contracts, already compiled, which can be deployed with a simple command. A user flow could then be:

  • install the cli
  • download and start the sandbox
  • aztec-cli deploy --example zk_token (or something)
  • start calling functions of that example contract.

A related concept is the ability to create a blank starter Noir Contract project.


A related concept is the ability to unbox a pre-built dapp which uses aztec.js. See #1056.

Tagging @critesjosh and @PhilWindle for thoughts :)

@iAmMichaelConnor iAmMichaelConnor added T-question Type: Someone is asking a questions about something A-ux/devex Area: relates to external ux / devex. (Users typically are devs) (See also A-internal-devex) labels Aug 1, 2023
@github-project-automation github-project-automation bot moved this to Todo in A3 Aug 1, 2023
@PhilWindle
Copy link
Collaborator

PhilWindle commented Aug 1, 2023 via email

@critesjosh
Copy link
Contributor

It would be cool to include a couple of different example contracts here. Maybe a "simple storage" contract that just has a storage slot that anyone can call and increment, as a minimal proof of concept contract. After that I think including a public token and a zk token would be interesting. And I imagine it would come with at least 1 basic account contract?

Once we have this, I can write a guide on how someone can start interacting with the Sandbox and the deployed contract by sending transactions from specific provided entry points (Aztec account contracts + their corresponding private keys) or by creating and funding their own account contracts.

@PhilWindle PhilWindle moved this from Todo to Done in A3 Aug 10, 2023
@iAmMichaelConnor
Copy link
Contributor Author

Closing because done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-ux/devex Area: relates to external ux / devex. (Users typically are devs) (See also A-internal-devex) T-question Type: Someone is asking a questions about something
Projects
Archived in project
Development

No branches or pull requests

3 participants