Skip to content

fix: mxs settings docs #992

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
ryanwaits merged 1 commit into from
May 13, 2025
Merged

fix: mxs settings docs #992

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 8 additions & 5 deletions content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,20 @@ MXS bridges this gap by allowing your unit tests, executed via the Clarinet JS S
To use MXS in your unit tests, you need to enable it in your `Clarinet.toml` file. Add the following section:

```toml -c
[testing]
[repl.remote_data]
# Enable mainnet execution simulation
mainnet_simulation = true
# Specify the Stacks block height to simulate (optional)
initial_height = 1094766
enabled = true
# Specify the Stacks block height to fork from (optional, default to latest)
initial_height = 522000
# Specify the API URL to use (optional, default to https://api.hiro.so)
api_url = 'https://api.hiro.so'
```

- `mainnet_simulation = true`: This flag activates the MXS feature for your tests.
- `enabled = true`: This flag activates the MXS feature for your tests.
- `initial_height = <block_height>`: This optional setting specifies the Stacks block height at which the simulation should start.
- If omitted, Clarinet defaults to the latest finalized Stacks block height at the time of execution.
- **Recommendation:** Setting a specific `initial_height` is highly recommended for consistent and reproducible test results, as the mainnet state constantly changes.
- `api_url = 'https://api.hiro.so'`: This optional setting specifies the API URL to use.

<Callout title="Example Project">
You can explore a project demonstrating MXS usage with a Pyth oracle contract in [this repository](https://github.com/hirosystems/clarinet-pyth-example).
Expand Down