-
Notifications
You must be signed in to change notification settings - Fork 57
chore: add mainnet execution simulation guide #989
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.
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
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
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
content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx
Show resolved
Hide resolved
content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx
Show resolved
Hide resolved
content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx
Show resolved
Hide resolved
content/docs/stacks/clarinet-js-sdk/guides/mainnet-execution-simulation.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm! thanks @ryanwaits 🙌
What does this PR do?
Reference
#985