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

New setup docs #3195

Closed
Tracked by #2658
rahul-kothari opened this issue Nov 2, 2023 · 0 comments
Closed
Tracked by #2658

New setup docs #3195

rahul-kothari opened this issue Nov 2, 2023 · 0 comments
Assignees

Comments

@rahul-kothari
Copy link
Contributor

rahul-kothari commented Nov 2, 2023

After #3090 and #3128, the setup + installation is completely changed

  • no nargo needed (we use noir-wasm) - so no need to update or download nargo anymore
    edit: need it for LSP and nargo --new contract
  • no need to individually update yarn packages or nargo.toml
  • if installed sandbox using docker -> running the curl command, now updates sandbox and also installs aztec-CLI as a docker image
    • if you had cli previously installed as an npm/yarn package, then it doesn't update the cli.

Running aztec-cli update in your project directory does the following:

  • if you installed sandbox using docker -> it aborts. Tells you to run curl command, and then rerun the aztec-cli update command
  • If you installed sandbox using npm/yarn/pnpm -> it updates the package to your specified version (by default: latest)
  • It then finds package.json (if it can't find it, it aborts) and updates all aztec npm dependencies to the version of your sandbox
  • You also provide all your contract paths like so --contract src/contracts/Token --contract src/contracts/TokenBridge - it finds nargo.toml there and updates aztec-nr version to the version of your sandbox!
  • It also outputs the diffs!

Other doc updates:

  • We always tell users to install aztec-cli globally. Maybe tell them to do so locally? Given current command doesn't update global aztec-cli? Alternatively, current command can update global aztec-cli.
  • In places other than tutorials, (eg getting started) we only mention the docker flow and not the npm flow. Mention that
  • Updating page -> also explain what the current command does
  • Updating page uses "cli/uipdating" as a URL - https://docs.aztec.network/dev_docs/cli/updating. It should just be "updating"
  • Change "nargo project" references to "noir project"
@github-project-automation github-project-automation bot moved this to Todo in A3 Nov 2, 2023
@catmcgee catmcgee moved this from Todo to In Progress in A3 Nov 2, 2023
@alexghr alexghr mentioned this issue Nov 3, 2023
4 tasks
rahul-kothari added a commit that referenced this issue Nov 7, 2023
This PR aims to update the docs with latest changes in the CLI
(noir_wasm & `update` command)

Relates to #3195 

# Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if
the PR is ready to merge.
- [ ] If the pull request requires a cryptography review (e.g.
cryptographic algorithm implementations) I have added the 'crypto' tag.
- [ ] I have reviewed my diff in github, line by line and removed
unexpected formatting changes, testing logs, or commented-out code.
- [ ] Every change is related to the PR description.
- [ ] I have
[linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
this pull request to relevant issues (if any exist).

---------

Co-authored-by: Josh Crites <jc@joshcrites.com>
Co-authored-by: josh crites <critesjosh@gmail.com>
Co-authored-by: Rahul Kothari <rahul.kothari.201@gmail.com>
@github-project-automation github-project-automation bot moved this from In Progress to Done in A3 Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

4 participants