Skip to content

docs: explain proxy and upgradability pattern #619

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.

Sign up for GitHub

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

Open
kirito201922 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: explain proxy and upgradability pattern #619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/UPGRADABILITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Proxy and upgradability pattern

Stablecoin contracts use the proxy pattern to separate logic and state.

- **Proxy contract** – holds storage and delegates calls.
- **Implementation contract** – contains the logic and can be upgraded.

## Why proxies?

- Allows bug fixes and feature additions without migrating user balances.
- Separates admin controls (proxy admin) from token owner.

## How upgrades happen

1. Deploy new implementation.
2. Proxy admin calls `upgradeTo(newImplementation)`.
3. Initialization functions can be called to set up new state.

Always audit new implementations and understand risks before upgrading.