Skip to content

chore: add mainnet execution simulation guide#989

Merged
ryanwaits merged 3 commits into
mainfrom
chore/mxs-guide
May 7, 2025
Merged

chore: add mainnet execution simulation guide#989
ryanwaits merged 3 commits into
mainfrom
chore/mxs-guide

Conversation

@ryanwaits

@ryanwaits ryanwaits commented May 5, 2025

Copy link
Copy Markdown
Contributor

What does this PR do?

  • add a guide for mainnet execution simulation (mxs)

Reference
#985

@vercel

vercel Bot commented May 5, 2025

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2025 1:20pm

@ryanwaits ryanwaits moved this from 🆕 New to 👀 In Review in Marketing/Devrel May 5, 2025
@ryanwaits ryanwaits requested a review from hugoclrd May 5, 2025 21:55
@ryanwaits ryanwaits changed the title add mainnet execution simulation guide chore: add mainnet execution simulation guide May 5, 2025

@hugoclrd hugoclrd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ryanwaits!
Left a couple of comments.

And before ## Limitations, can we add a section explaining how to set up an API key for mainnet execution simulation.

Basically, users need to set up an ENV var named HIRO_API_KEY=<api_key> with an API key generated on the Platform (could link to /stacks/api-keys or repeat the callout "Where can I get an API key?")

We also need to specify that currently the API key is only used for MXS (and other clarinet features don't use it).
The reason for this limitation is quite technical, we had to implement a custom HTTP client for MXS, and this client uses the API key. But other features don't use this client. Users probably don't need to know about that

Comment thread content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx Outdated
Comment thread content/_recipes/convert-btc-to-stx-address.mdx

@hugoclrd hugoclrd left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm! thanks @ryanwaits 🙌

@ryanwaits ryanwaits merged commit 3a70bcc into main May 7, 2025
@ryanwaits ryanwaits deleted the chore/mxs-guide branch May 7, 2025 16:00
@github-project-automation github-project-automation Bot moved this from 👀 In Review to ✅ Done in Marketing/Devrel May 7, 2025
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.

2 participants