Metadata-Version: 2.3
Name: vyupgrade
Version: 0.6.1
Summary: Compiler-backed tool for upgrading Vyper contracts.
Keywords: codemod,migration,smart-contracts,vyper
Author: banteg
License: MIT License
         
         Copyright (c) 2026 banteg
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Compilers
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Dist: packaging>=24.0
Requires-Dist: rich>=13.0.0
Requires-Dist: uv>=0.8.0
Requires-Python: >=3.11
Project-URL: Homepage, https://github.com/vyperlang/vyupgrade
Project-URL: Repository, https://github.com/vyperlang/vyupgrade
Project-URL: Issues, https://github.com/vyperlang/vyupgrade/issues
Project-URL: Changelog, https://github.com/vyperlang/vyupgrade/blob/master/CHANGELOG.md
Description-Content-Type: text/markdown

# vyupgrade

A compiler-backed tool for upgrading Vyper contracts across language
versions. It rewrites legacy syntax to a chosen target compiler, then proves the
rewrite is safe by compiling the source and the result and comparing their ABI,
method identifiers, and storage layout.

It covers installable Vyper `0.1.0b*` prereleases through `0.4.3`, plus opt-in
`0.5.0a1` through `0.5.0a3` alpha targets. Rules are version-gated: a given
rewrite only fires when the migration from the source version to the target
version actually crosses the compiler release that introduced the change.

## Install

Run it once without installing:

```bash
uvx vyupgrade contracts/
```

Or install it as a tool:

```bash
uv tool install vyupgrade
vyupgrade contracts/
```

## Usage

Preview the changes as a unified diff:

```bash
vyupgrade contracts/ --diff
```

Apply them in place and write a machine-readable report:

```bash
vyupgrade contracts/ --write --report-json vyupgrade-report.json
```

Fail without writing when files would change, for use in CI:

```bash
vyupgrade contracts/ --check
```

The target defaults to `0.4.3`; pass `--target-version` to migrate to a
different release, including an explicit alpha target such as `0.5.0a3`.

Paths may be files or directories; directories are searched recursively for
`.vy` and `.vyi` sources. The source version is inferred per file from its
`#pragma version` (or legacy `# @version`) line. Pass `--source-version` to
override the inference for files that have no pragma.

Rule gating for broad source pragmas uses the oldest satisfying compiler so
historical migrations still run. Unless `--source-vyper` overrides discovery,
source-validation authority is the nearest project's declared Vyper resolution
(including its lock), then an exact pragma, then the newest known compiler that
satisfies a ranged pragma without exceeding the requested target. Ranged
selection never inspects source syntax.

### How it validates

For each file, `vyupgrade` compiles the original under its source compiler and
the rewritten output under the target compiler, then compares the two
artifacts. A migration is only written back when every file still compiles
under the target, the source validation succeeded, every required artifact is
available, and ABI, method identifiers, and storage layout compare equal. This
write decision is independent of diagnostic selection and rule version gating.
Standalone `.vyi` inputs are target-compiled through a generated import harness.

Compiler subprocesses run through the bundled `uv`. Files in a project use the
complete nearest declared environment via `uv run --isolated --project`,
including all dependency groups and extras; an existing `uv.lock` is enforced
with `--frozen`. An unlocked project is mirrored into a temporary root so
resolution cannot create a lockfile in the source tree. Files without a project
use an isolated `uv run --no-project --with vyper==<version>` environment.
Dependencies are never guessed from imports or compiler errors.

For `0.1.0b*` source compilers, `vyupgrade` runs the compiler through a
`typed-ast` compatibility wrapper so the legacy compiler sees pre-Python-3.8
AST node classes without requiring a local Python 3.6 or 3.7 interpreter. When
an old compiler cannot produce a modern validation output format, that format is
dropped and reported as unavailable. Writes then remain blocked unless the
source-validation gap is explicitly accepted with `--allow-unvalidated-source`.
Target compilers must produce every requested validation output.

The target compiler receives the exact migrated source bytes. Historical
normalization is limited to copied dependencies in the temporary validation
overlay and is not applied to files that would be written.
Optional `--format mamushi` runs only against temporary staged candidates. The
formatted bytes are read back into the migration plan, compiled again under the
target compiler, and compared before any destination is changed. Formatter
failure leaves every original untouched.

Writes recheck all planned inputs, reject generated symlinks and unsafe hard-linked
or read-only replacements, and roll back already replaced files when a later write
fails. Multi-file replacement is rollback-aware rather than globally atomic; a
non-cooperating external writer can still race the final portable filesystem check.
Reports distinguish original, validated candidate, and final on-disk hashes. If a
post-write test command changes a planned file, the run exits nonzero and records the
drift.

Source-validation evidence records the declared spec, actual resolved compiler,
dependency context, whether the compiler started, a typed failure origin, and
the compiler process output. `compiler_output` contains only compiler stdout and
stderr; environment-manager or adapter diagnostics remain separate.

## Options

- `--target-version` — target Vyper version or spec (default `0.4.3`).
- `--source-version` — override the per-file inferred source version.
- `--diff` — print a unified diff instead of the report.
- `--write` — apply changes in place only after the validation decision passes.
- `--check` — exit non-zero if any file would change; write nothing.
- `--aggressive` — enable rewrites that change behavior or are not provably safe (e.g. `enum` → `flag`).
- `--include-dependencies` (alias `--upgrade-closure`) — also upgrade and cross-validate the resolved import closure, including dependencies found via `--compiler-search-paths`; dependency sources are never rewritten in place, so `--write` additionally requires a closure destination.
- `--closure-output DIR` — write the validated upgraded closure (project + dependencies, laid out import-root-relative so `vyper -p DIR` resolves every import) into DIR; requires `--include-dependencies`; overwrites files inside DIR, never deletes extras, never modifies dependency sources in place.
- `--closure-archive OUT.vyz` — emit the validated upgraded closure (dependencies bundled) as a single Vyper archive via the target compiler; requires `--include-dependencies`, a target >= 0.4.0, and exactly one entry contract.
- `--split-interfaces` — move top-level `interface` blocks into sibling `.vyi` files and import them.
- `--select` / `--ignore` — comma-separated rule codes to include or exclude.
- `--report-json PATH` — write a JSON report of fixes, diagnostics, and validation results.
- `--format mamushi` — format staged candidates, then revalidate the exact output before writing.
- `--test-command CMD` — run a test command after a successful write, record its result, and fail when it does not pass.
- `--enable-decimals` — treat decimals as enabled when reasoning about `0.4.x` rules.
- `--source-vyper` / `--target-vyper` — pin the exact compiler version for each side.
- `--source-python` / `--target-python` — pin the Python interpreter for each compiler subprocess.
- `--compiler-search-paths` — extra import search paths for the compiler.
- `--allow-unvalidated-source` — write despite a failed source compile or unavailable source artifacts.
- `--allow-abi-change` — write despite an ABI comparison mismatch.
- `--allow-method-id-change` — write despite a method-identifier comparison mismatch.
- `--allow-storage-layout-change` — write despite a storage-layout comparison mismatch.
- `--config PATH` — read configuration from a specific `pyproject.toml`.

JSON reports include a top-level `schema_version`. Version `4` provides producer
identity plus separate source and target validation attestations. Each
attestation records the declared source snapshot and compiler declarations,
compiler authority and identity, dependency context, process completion and
exit status, validated sources, the exact compile attempt, typed failure origin,
and compiler output when validation fails. Version `2` added a per-file `role`
and a top-level `closure` object; version `3` first introduced source-validation
evidence and is superseded by version `4`. Consumers should treat a missing
version as the legacy unversioned format and require a new schema version before
relying on renamed, removed, or type-changed fields.

### Configuration

Defaults can live in `pyproject.toml` under `[tool.vyupgrade]`. Command-line
flags take precedence.

```toml
[tool.vyupgrade]
paths = ["contracts/"]
target-version = "0.4.3"
source-version = "infer"
report-json = "vyupgrade-report.json"
aggressive = false
split-interfaces = false
format = "none"
allow-unvalidated-source = false
allow-abi-change = false
allow-method-id-change = false
allow-storage-layout-change = false
```

### Exit codes

- `0` — success.
- `1` — `--check` found files that would change.
- `2` — target compilation or required target artifacts failed validation.
- `3` — source compilation or source artifact availability failed validation.
- `4` — usage error (no paths, or conflicting flags).
- `5` — an error-severity diagnostic was raised.
- `6` — the requested formatter failed or could not be run.
- `7` — an unwaived ABI, method-identifier, or storage-layout mismatch blocked the write.
- `8` — the post-write test command failed, timed out, or could not start.
- `9` — migration planning or the rollback-aware write transaction failed.

## Coverage

Rewrites carry a `VY###` code and diagnostics a `VYD###` code. Where the source
intent cannot be proven safe, the change is reported as a manual-review
diagnostic instead of being applied.

- [docs/migration-coverage.md](docs/migration-coverage.md) — every syntax
  change mapped to a rule, diagnostic, explicit no-op, or validation-only
  behavior.
- [docs/vyper-syntax-history.md](docs/vyper-syntax-history.md) — the versioned
  Vyper syntax history from `0.5.0a3` back through the `0.1.0b*` prereleases,
  with PR links and before/after examples.
- [CHANGELOG.md](CHANGELOG.md) — release notes.
- [DEVELOPMENT.md](DEVELOPMENT.md) — maintainer validation and release workflow.
