English | 简体中文

MoonUpgradeGuard documentation

MoonUpgradeGuard is an offline preflight compatibility checker for EVM contract upgrades. Given two existing Solidity compiler artifacts, it compares storage layout and ABI, then emits stable diagnostics and CI-friendly exit codes.

It does not compile contracts, connect to a chain, or prove an upgrade safe in every respect.

Start here

• Getting started: get an executable, run a first check, and understand the exit codes.
• Hands-on tutorial: prepare real compiler artifacts, read compatible, incompatible, and invalid results, and integrate CI.
• Diagnostics reference: look up errors, warnings, and their meanings.
• Artifact fixtures: inspect compatible and incompatible inputs and real compiler artifacts.

Go deeper

• Differential results: behavior compared with OpenZeppelin Upgrades Core.
• References and licensing: rule sources, dependency licenses, and fixture provenance.
• Roadmap: delivered capabilities and later directions.

The repository README retains the full project description; this site also organizes the material by task.