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

feat(docs): add transaction profiler docs #9932

Merged
merged 8 commits into from
Nov 18, 2024
Merged

Conversation

saleel
Copy link
Contributor

@saleel saleel commented Nov 13, 2024

@saleel saleel requested a review from a team November 13, 2024 13:54
@saleel saleel changed the title docs: add transaction profiler docs feat(docs): add transaction profiler docs Nov 13, 2024
@AztecBot
Copy link
Collaborator

AztecBot commented Nov 13, 2024

Docs Preview

Hey there! 👋 You can check your preview at https://673b6f29aa468e0725746264--aztec-docs-dev.netlify.app

@saleel saleel requested a review from critesjosh November 14, 2024 10:30
@saleel saleel force-pushed the saleel/tx-profiler-docs branch from 86302dd to 557aede Compare November 14, 2024 16:17
@saleel saleel force-pushed the saleel/tx-profiler-docs branch from 557aede to 5f2d770 Compare November 14, 2024 16:19
Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am trying this command

aztec-wallet deploy token_contract@Token --args accounts:owner Test TST 18 -f owner -a token 

on the master version of the sandbox and am seeing this error.

throw new Error('Invalid contract artifact argument provided. To use this option, command should be called from a nargo workspace');

based on aztec-wallet deploy -h , the package@contract syntax can only be used from inside a nargo workspace, so will this only work if people run the command with this syntax from inside the monorepo.

Token deployment works when I run it in the monorepo after I compile the token contract. This is a lot to ask readers to go through, any ideas on how we can make this faster/easier?

Otherwise it works great! 🙌

aztec-wallet create-account -a user

# Deploy a token contract and mint 100 tokens to the user
aztec-wallet deploy token_contract@Token --args accounts:owner Test TST 18 -f owner -a token
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a note that readers need to clone the monorepo and compile the token contract with aztec-nargo compile --package token_contract in noir-projects/noir-contracts?

Copy link
Contributor Author

@saleel saleel Nov 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, right. I have added this note.

This is a lot to ask readers to go through, any ideas on how we can make this faster/easier?

In practice, devs would be trying this with their own contracts in their nargo workspace. This mostly serves as an example right?
But if they want to follow along and use the same steps then they would need to clone the monorepo and deploy the token contract. I think it is ok considering its not a mandatory step for anyone to profile their contract.

@saleel saleel requested a review from critesjosh November 15, 2024 06:39
@saleel saleel enabled auto-merge (squash) November 15, 2024 16:12
@saleel saleel closed this Nov 18, 2024
auto-merge was automatically disabled November 18, 2024 12:31

Pull request was closed

@saleel saleel reopened this Nov 18, 2024
@saleel saleel enabled auto-merge (squash) November 18, 2024 12:32
@@ -0,0 +1,71 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we not need to add this to the main docs reference file so it shows up on the sidebars?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its shows up on the sidebar now under "Aztec.nr" - https://6736ede7171fe516edd8a7ec--aztec-docs-dev.netlify.app/guides

@saleel saleel merged commit 74ed142 into master Nov 18, 2024
42 checks passed
@saleel saleel deleted the saleel/tx-profiler-docs branch November 18, 2024 16:46
TomAFrench added a commit that referenced this pull request Nov 18, 2024
* master: (281 commits)
  fix: don't take down runners with faulty runner check (#10019)
  feat(docs): add transaction profiler docs (#9932)
  chore: hotfix runner wait (#10018)
  refactor: remove EnqueuedCallSimulator (#10015)
  refactor: stop calling public kernels (#9971)
  git subrepo push --branch=master noir-projects/aztec-nr
  git_subrepo.sh: Fix parent in .gitrepo file. [skip ci]
  chore: replace relative paths to noir-protocol-circuits
  git subrepo push --branch=master barretenberg
  chore: drop info to verbose in sequencer hot loop (#9983)
  refactor: Trace structure is an object (#10003)
  refactor: enqueued calls processor -> public tx simulator (#9919)
  chore: World state tech debt cleanup 1 (#9561)
  chore(ci): run noir tests in parallel to building e2e tests (#9977)
  Revert "chore: lower throughput of ebs disks" (#9996)
  feat: new proving broker implementation (#9400)
  chore: replace `to_radix` directive with brillig (#9970)
  chore: disable failing 48validator kind test (#9920)
  test: prove one epoch in kind (#9886)
  fix: formatting (#9979)
  ...
TomAFrench added a commit that referenced this pull request Nov 19, 2024
* master: (67 commits)
  chore: Fix bad merge on AztecLMDBStore initializer
  feat: add persisted database of proving jobs (#9942)
  chore: Clean up data configuration (#9973)
  chore: remove public kernels (#10027)
  chore: misc cleanup, docs and renaming (#9968)
  feat: IPA Accumulator in Builder (#9846)
  chore(docs): Updates to token contract (#9954)
  test(avm): minor benchmarking (#9869)
  chore(ci): run `l1-contracts` CI in parallel with `build` step (#10024)
  chore: build acir test programs in parallel to e2e build step (#9988)
  chore: pull out `array_set` pass changes (#9993)
  feat(avm): ephemeral avm tree (#9798)
  fix: don't take down runners with faulty runner check (#10019)
  feat(docs): add transaction profiler docs (#9932)
  chore: hotfix runner wait (#10018)
  refactor: remove EnqueuedCallSimulator (#10015)
  refactor: stop calling public kernels (#9971)
  git subrepo push --branch=master noir-projects/aztec-nr
  git_subrepo.sh: Fix parent in .gitrepo file. [skip ci]
  chore: replace relative paths to noir-protocol-circuits
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants