Skip to content

Commit 827e893

Browse files
authored
Merge pull request #992 from hirosystems/fix/mxs-doc
fix: mxs settings docs
2 parents 3a70bcc + b6f1eca commit 827e893

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,20 @@ MXS bridges this gap by allowing your unit tests, executed via the Clarinet JS S
3535
To use MXS in your unit tests, you need to enable it in your `Clarinet.toml` file. Add the following section:
3636

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

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

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

0 commit comments

Comments
 (0)