Skip to content

docs(contracts): document contract immutability as a deliberate security property - #591

Merged
collinsezedike merged 1 commit into
drydocs:mainfrom
olu-cmd:Document_contract_immutability
Aug 25, 2026
Merged

docs(contracts): document contract immutability as a deliberate security property#591
collinsezedike merged 1 commit into
drydocs:mainfrom
olu-cmd:Document_contract_immutability

Conversation

@olu-cmd

@olu-cmd olu-cmd commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Documents contract immutability in docs/contracts.md as a deliberate security property, not an omission: no vault or adapter contract exposes an update_current_contract_wasm entry point.
  • Explains why an admin-gated upgrade() was considered and rejected, and how redeployment friction is already handled by existing tooling (deploy-testnet.sh for redeployment, migrate_adapter for moving live positions without a manual withdraw-then-deposit cycle per user).

Closes #574

@vercel

vercel Bot commented Aug 24, 2026

Copy link
Copy Markdown

@olu-cmd 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 Aug 24, 2026

Copy link
Copy Markdown

@olu-cmd 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.

@olu-cmd I need a few changes before this can merge:

  • The title (feat: doc added) doesn't match CONTRIBUTING.md's Commit Convention: it becomes the squash commit message, so it needs the right type (docs: for a docs-only change) and an imperative subject ("document" not "added"). Read the Commit Convention section for the exact format.
  • The PR body needs to follow CONTRIBUTING.md's required template (## Summary / ## Test plan), not just Close #574 and a one-line note.
  • docs/contracts.md:11 uses em dashes ("None of Meridian's contracts — vault or adapters — expose an"). Please rewrite as plain sentences without them.

The content itself is accurate and well-placed, this is about form, not substance.

@collinsezedike collinsezedike changed the title feat: doc added docs(contracts): document contract immutability as a deliberate security property Aug 25, 2026

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

Verified both factual claims directly against the contract source: no adapter or vault exposes an upgrade entry point, and migrate_adapter genuinely moves the whole vault-wide position atomically with a slippage bound, matching what's documented. Fixed the PR title (feat: doc added, wrong type and non-descriptive, and squash merge makes it the permanent commit message) to docs(contracts): document contract immutability as a deliberate security property. Merging now.

@collinsezedike
collinsezedike merged commit a3a5bac into drydocs:main Aug 25, 2026
8 of 9 checks passed
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.

[Chore] Document contract immutability as a deliberate security property

2 participants