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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

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://6736ede7171fe516edd8a7ec--aztec-docs-dev.netlify.app

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 given that considering its not a mandatory step for anyone to profile their contract.

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.

3 participants