docs(genesis): document the CLI soft cap flag and refund command - #564
Draft
tonyboylehub wants to merge 1 commit into
Draft
tonyboylehub wants to merge 1 commit into
tonyboylehub wants to merge 1 commit into
Conversation
Covers the CLI surface added in metaplex-foundation/cli#132. - Add --softCap to the add-launch-pool flags table and a worked example configuring a floor and a ceiling together - Add a "Soft Cap and Minimum Threshold" section contrasting the two, linking to the protocol page for the refund math - Document the new "mplx genesis refund" command, both refund cases, and its permissionless crank behaviour - Add the soft cap validation failures and refund errors to Common Errors - Add three FAQ entries, mirrored into faqs frontmatter, and four glossary terms - Replace the Out of Scope section with an inline callout, per the GEO/LLM rubric - Drop the interim note on the protocol page saying the CLI has no soft cap flag, now that it does
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueComment |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes DEV-178.
Important
Blocked — do not merge yet.
--softCapflag and themplx genesis refundcommand. This PR documents a CLI surface that does not exist on a released version yet.docs/genesis-launchpool-soft-cap, notmain. Merge docs(genesis): document the Launch Pool soft cap #562 first, then retarget this tomain.Opened as a draft so the docs land in the same cycle as the CLI rather than lagging it again.
Why
The protocol soft cap docs (#562) had to carry an explicit note that the CLI could not do this yet. metaplex-foundation/cli#132 closes that gap, so this PR documents the new surface and removes the note.
What
On
/dev-tools/cli/genesis/launch-pool:--softCapin the flags table, alongside--minimumQuoteTokenThreshold, now labelled as the floor/ceiling pair they are.mplx genesis refund— both refund cases, the options, and the notes that only the payer signs (so it can be cranked for someone else), that no fee or penalty applies, and that claim order does not matter.faqsfrontmatter for FAQPage JSON-LD) and Glossary (4 new terms).## Out of Scopesection with an inline callout, per the GEO/LLM rubric.On
/smart-contracts/genesis/launch-pool, a one-line change: the interim "themplxCLI does not expose a soft cap flag yet" note becomes a statement that all three surfaces support it.Verification
pnpm run buildpasses;soft-cap-and-minimum-thresholdandrefundconfirmed as heading ids in the rendered HTML.slugifyHeading.mplx genesis refund --helpandmplx genesis bucket add-launch-pool --helpoutput from a local build.Follow-up
Locale parity for all of this is tracked separately in DEV-179.