Skip to content

docs: correct migration slippage cap to 500 bps - #1150

Merged
collinsezedike merged 1 commit into
drydocs:mainfrom
Starr-p:fix/issue-1096-migration-keeper-md-documents-the-pre-unlimited
Oct 23, 2026
Merged

collinsezedike merged 1 commit into
drydocs:mainfrom
Starr-p:fix/issue-1096-migration-keeper-md-documents-the-pre-unlimited

Conversation

@Starr-p

@Starr-p Starr-p commented Oct 18, 2026

Copy link
Copy Markdown
Contributor

Overview

This PR corrects the migration keeper operations documentation so it reflects the post-#557 slippage cap. apps/docs/operations/migration-keeper.md still described the pre-#557 behavior (10,000 bps ceiling, 9999 treated as functionally unlimited), which would lead an operator to submit values that now revert with InvalidSlippageBps. The page is updated to match the contract's MAX_ADMIN_SLIPPAGE_BPS = 500 and to align with environment-variables.md and vault-contract.md.

Related Issue

Changes

📄 Migration Keeper Docs

  • [MODIFY] apps/docs/operations/migration-keeper.md
    • Corrected the migrate_adapter slippage bound from <= 10000 to the contract's 500 bps cap (MAX_ADMIN_SLIPPAGE_BPS), noting that values above it revert with InvalidSlippageBps.
    • Rewrote the config-loader guidance so it no longer claims only the literal 10000 is rejected and that 9999 is accepted as functionally unlimited; the loader enforces the same 500 bps cap.
    • Removed the remaining 10000/9999 accepted-value references so the page matches environment-variables.md and vault-contract.md.

Verification Results

Docs-only change — no test suite added or run.
Manually cross-checked the updated bounds against:
- packages/contracts/vault/src/lib.rs (MAX_ADMIN_SLIPPAGE_BPS = 500)
- packages/contracts/vault/src/storage.rs
- apps/docs/operations/environment-variables.md
- apps/docs/architecture/vault-contract.md
Acceptance Criteria Status
migration-keeper.md states the 500 bps cap and matches environment-variables.md and vault-contract.md ✅ Updated to 500 bps and cross-checked against both pages
No remaining reference to 10000/9999 as an accepted value ✅ Pre-#557 references removed from the page

Closes #1096

@vercel

vercel Bot commented Oct 18, 2026

Copy link
Copy Markdown

@Starr-p is attempting to deploy a commit to the Collins' projects Team on Vercel.

A member of the Team first needs to authorize it.

@drips-wave

drips-wave Bot commented Oct 18, 2026

Copy link
Copy Markdown

@Starr-p Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@collinsezedike collinsezedike left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The content is correct against packages/stellar-sdk-helpers/src/migration-keeper.ts. The only failing check is the commit header, which is 73 characters (the repo limit is 72). Please shorten it to 72 or fewer and this is good to go.

@collinsezedike collinsezedike changed the title docs: correct migration slippage cap to 500 bps in migration-keeper.md docs: correct migration slippage cap to 500 bps Oct 23, 2026
@collinsezedike
collinsezedike force-pushed the fix/issue-1096-migration-keeper-md-documents-the-pre-unlimited branch from 50c94e0 to 66c978f Compare October 23, 2026 15:29

@collinsezedike collinsezedike left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@Starr-p Thank you for your contribution. If you are interested, there are more open issues to pick up.

@collinsezedike
collinsezedike merged commit 1a6c004 into drydocs:main Oct 23, 2026
10 of 11 checks passed
@collinsezedike

Copy link
Copy Markdown
Collaborator

@Starr-p Thank you for your contribution. If you found Meridian useful, please star the repository: https://github.com/drydocs/meridian.

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.

[Docs] migration-keeper.md documents the pre-#557 unlimited slippage bound

2 participants