Skip to content

chore(docs): update profiler usage docs #12782

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.

Sign up for GitHub

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

Merged
saleel merged 2 commits into from
Mar 19, 2025
Merged

chore(docs): update profiler usage docs #12782

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a80c927
chore(docs): update profiler usage docs
saleel Mar 17, 2025
4610166
Merge branch 'master' into saleel/docs-profiler-update
saleel Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/docs/developers/guides/smart_contracts/profiling_transactions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@ Now, the `test0` account can transfer tokens by running:
aztec-wallet send transfer -ca token --args accounts:test1 40 -f accounts:test0
```

Instead of sending the above transaction, you can simulate it by running the `simulate` command with the same parameters, and then add a `--profile` flag to profile the gate count of each private function in the transaction.
Instead of sending the above transaction, you can profile it by running the `profile` command with the same parameters.


```bash
aztec-wallet simulate --profile transfer -ca token --args accounts:test1 40 -f accounts:test0
aztec-wallet profile transfer -ca token --args accounts:test1 40 -f accounts:test0
```

This will print the following results after some time:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developers/reference/environment_reference/cli_wallet_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,12 +134,12 @@ aztec-wallet simulate --from master_yoda --contract-address jedi_order --args "l

### Profile

Simulates a transaction with profiling enabled. This allows you to get the gate count of each private function in the transaction. Read more about profiling [here](../../guides/smart_contracts/profiling_transactions.md).
This allows you to get the gate count of each private function in the transaction. Read more about profiling [here](../../guides/smart_contracts/profiling_transactions.md).

#### Example

```bash
aztec-wallet simulate --profile --from master_yoda --contract-address jedi_order --args "luke_skywalker" train_jedi
aztec-wallet profile --from master_yoda --contract-address jedi_order --args "luke_skywalker" train_jedi
```

### Bridge Fee Juice
Expand Down