Skip to content

docs(genesis): document the CLI soft cap flag and refund command - #564

Draft
tonyboylehub wants to merge 1 commit into
docs/genesis-launchpool-soft-capfrom
docs/genesis-cli-soft-cap
Draft

tonyboylehub wants to merge 1 commit into
docs/genesis-launchpool-soft-capfrom
docs/genesis-cli-soft-cap

Conversation

@tonyboylehub

Copy link
Copy Markdown
Contributor

Closes DEV-178.

Important

Blocked — do not merge yet.

  1. Blocked on feat(genesis): add Launch Pool soft cap support to the CLI cli#132, which adds the --softCap flag and the mplx genesis refund command. This PR documents a CLI surface that does not exist on a released version yet.
  2. Stacked on docs(genesis): document the Launch Pool soft cap #562 — the base branch is docs/genesis-launchpool-soft-cap, not main. Merge docs(genesis): document the Launch Pool soft cap #562 first, then retarget this to main.

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:

  • --softCap in the flags table, alongside --minimumQuoteTokenThreshold, now labelled as the floor/ceiling pair they are.
  • New "Soft Cap and Minimum Threshold" section — a table contrasting what happens when each is breached, and the key point that a soft cap does not reject deposits at the cap. Links to the protocol page for the pro-rata refund math rather than restating it.
  • New "Refund" section for 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.
  • Fourth add-launch-pool example configuring a floor and a ceiling together.
  • Common Errors — the two client-side validation messages plus the three refund failure cases.
  • FAQ (3 new, mirrored into faqs frontmatter for FAQPage JSON-LD) and Glossary (4 new terms).
  • Replaced the ## Out of Scope section with an inline callout, per the GEO/LLM rubric.

On /smart-contracts/genesis/launch-pool, a one-line change: the interim "the mplx CLI does not expose a soft cap flag yet" note becomes a statement that all three surfaces support it.

Verification

  • pnpm run build passes; soft-cap-and-minimum-threshold and refund confirmed as heading ids in the rendered HTML.
  • All 10 in-page anchors on the CLI page and all 5 on the protocol page resolve against slugifyHeading.
  • Flag names, command name, options and error strings taken from the actual implementation in feat(genesis): add Launch Pool soft cap support to the CLI cli#132, and cross-checked against mplx genesis refund --help and mplx genesis bucket add-launch-pool --help output from a local build.

Follow-up

Locale parity for all of this is tracked separately in DEV-179.

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
@vercel

vercel Bot commented Sep 18, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
developer-hub Ready Ready Preview Sep 18, 2026 1:25am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Comment @coderabbitai help to get the list of available commands.

This branch was successfully deployed

1 active deployment
Preview — 32faea20 Deployed Sep 18, 2026 by vercel[bot]
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.

1 participant