Skip to content

Commit

Permalink
docs: update instructions on browser based access to simulate traces
Browse files Browse the repository at this point in the history
  • Loading branch information
aorumbayev committed Oct 25, 2024
1 parent 2f5a9b8 commit d303d6a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/capabilities/debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ To keep the `algokit-utils-ts` package lean and isomporphic, the debugging utili

## Debugging in `browser` environment

Note that it's not possible to use `algokit-utils-ts-debug` in browser environments; however, you can still obtain and persist simulation traces from the browser network tab whenever a transaction is being submitted using the algokit-utils-ts package. Make sure to enable the debug mode in the algokit-utils-ts config as described in the [getting started](./docs/code/getting-started.md) guide. To obtain the simulation trace:
Note that it's not possible to use `algokit-utils-ts-debug` in browser environments; however, you can still obtain and persist simulation traces from the browser `Console` tab whenever a transaction is being submitted using the algokit-utils-ts package. Make sure to enable the debug mode in the algokit-utils-ts config as described in the [getting started](./docs/code/getting-started.md) guide. To obtain the simulation trace:

1. Open the browser network tab
1. Open the browser `Console` tab
2. Submit the transaction
3. Filter the requests by `simulate`
4. Copy the 'simulate' request body and store it in a file with a .trace.avm.json extension, then place it under the `debug_traces` folder in your AlgoKit contract project.
3. Look for the message containing `(Optional) Save content to your local file system to use with AlgoKit AVM Debugger.` in the `Console` tab that will appear after the transaction `simulate` request is submitted
4. Copy the 'simulate' request `JSON` and store it in a file with a `{your-title}.trace.avm.json` extension, then place it under the `debug_traces` folder in your AlgoKit contract project.
4.1. (Optional) If you are not using an AlgoKit project structure for your contracts codebase, as long as the trace file is within your VSCode workspace, the extension will present a picker to select the trace file.

0 comments on commit d303d6a

Please sign in to comment.