Skip to content

fix[ux]: improve checksum error messages - #5218

Merged
Sporarum merged 15 commits into
vyperlang:masterfrom
Sporarum:catch-invalid-address
Sep 16, 2026
Merged

Sporarum merged 15 commits into
vyperlang:masterfrom
Sporarum:catch-invalid-address

Conversation

@Sporarum

Copy link
Copy Markdown
Collaborator

What I did

Rebase #3621
Fix #3611
Refactor a bit the raising logic to make it nicer, see b19b32e

Closes #3621

How I did it

How to verify it

Run tests, includes new tests

Commit message

introduce a `BadChecksumAddress` exception (subclass of
`InvalidLiteral`) and raise it consistently for 20-byte hex literals
with a mismatched checksum, whether used in a `constant`, an annotated
assignment, or in a context where the expected type isn't known. when
the literal's type can't be determined, surface the checksum suggestion
as a hint. also clean up the raising logic in `AddressT` by extracting
the message builder and `raise_bad_checksum` helper.

Description for the changelog

Improve error messages involving address literals with incorrect checksums

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

@Sporarum

Copy link
Copy Markdown
Collaborator Author

I'm not sure what is the reason for the new error class, I kept it, but the new raising logic does not depend on it

@github-actions

Copy link
Copy Markdown

Gas Changes

No changes detected.

Summary

  • Total tests measured: 560
  • Changed: 0
  • Regressions (gas up): 0
  • Improvements (gas down): 0
  • New tests: 0
  • Deleted tests: 0
  • Newly failing: 0
  • Newly passing: 0

@github-actions

github-actions Bot commented Aug 14, 2026 •

Copy link
Copy Markdown

📊 Bytecode Size Changes (venom)

No changes detected.

Full bytecode sizes

Contract legacy-O2 legacy-Os -O2 -O3 -Os
curvefi/legacy/CurveStableSwapMetaNG.vy 24952 23578 19769 19059 18523
curvefi/amm/stableswap/meta_implementation/meta_implementation_v_700.vy 23610 22805 19565 18627 18314
curvefi/amm/stableswap/implementation/implementation_v_700.vy 24962 23769 19188 18363 18019
curvefi/legacy/CurveStableSwapNG.vy 24473 23298 18749 17981 17636
curvefi/amm/tricryptoswap/implementation/implementation_v_200.vy 20724 19959 17250 16689 16325
curvefi/amm/twocryptoswap/implementation/implementation_v_210.vy 17634 16894 14958 14376 14027
yearnfi/VaultV3.vy 19972 19063 14739 13818 13269
curvefi/legacy/CurveCryptoSwap2.vy 18947 18382 14619 14129 13954
yearnfi/VaultV2.vy 16676 15763 13258 12466 12049
curvefi/amm/stableswap/factory/factory_v_100.vy 14558 13978 11852 10780 10880
curvefi/gauge/child_gauge/implementation/implementation_v_110.vy 12338 11561 9781 9184 8795
curvefi/amm/stableswap/views/views_v_120.vy 12784 12368 9705 9059 9294
curvefi/gauge/child_gauge/implementation/implementation_v_100.vy 12017 11249 9514 8924 8538
curvefi/amm/tricryptoswap/math/math_v_200.vy 11189 11126 9029 8144 8170
curvefi/legacy/CurveCryptoMathOptimized3.vy 11188 11125 9028 8144 8170
curvefi/gauge/child_gauge/implementation/implementation_v_020.vy 10665 9947 8626 8100 7714
curvefi/registries/metaregistry/metaregistry_v_110.vy 7590 6732 6491 5710 5603
curvefi/helpers/router/router_v_110.vy 6717 6717 6251 5733 6035
curvefi/amm/tricryptoswap/views/views_v_200.vy 7821 7776 6111 5896 6045
curvefi/helpers/stable_swap_meta_zap/stable_swap_meta_zap_v_100.vy 7302 7067 5877 5350 5610
curvefi/amm/twocryptoswap/views/views_v_200.vy 6991 6946 5680 5479 5614
curvefi/registries/metaregistry/registry_handlers/stableswap/handler_v_110.vy 6633 6259 5533 4695 5238
curvefi/amm/twocryptoswap/math/math_v_210.vy 6800 6800 5506 5012 5039
curvefi/amm/twocryptoswap/factory/factory_v_200.vy 5540 5252 4617 3917 4047
curvefi/amm/tricryptoswap/factory/factory_v_200.vy 5246 5021 4483 3890 4020
curvefi/gauge/child_gauge/factory/factory_v_201.vy 4844 4547 3901 3675 3511
curvefi/registries/metaregistry/registry_handlers/tricryptoswap/handler_v_110.vy 4241 3939 3718 3334 3429
curvefi/registries/metaregistry/registry_handlers/twocryptoswap/handler_v_110.vy 4186 3884 3671 3251 3329
curvefi/gauge/child_gauge/factory/factory_v_100.vy 4183 3914 3408 3144 2971
yearnfi/VaultFactory.vy 3765 3617 2936 2158 2461
curvefi/registries/address_provider/address_provider_v_201.vy 2973 2782 2613 2440 2353
curvefi/helpers/rate_provider/rate_provider_v_101.vy 3260 3260 2535 2263 2296
curvefi/amm/stableswap/math/math_v_100.vy 3067 3046 2458 2253 2310
curvefi/helpers/rate_provider/rate_provider_v_100.vy 2847 2841 2273 1954 1974
curvefi/helpers/deposit_and_stake_zap/deposit_and_stake_zap_v_100.vy 2322 2316 1782 1611 1670
curvefi/governance/relayer/taiko/relayer_v_001.vy 2068 2064 1731 1510 1558
curvefi/governance/relayer/polygon_cdk/relayer_v_101.vy 1556 1523 1530 1324 1347
curvefi/governance/relayer/arb_orbit/relayer_v_101.vy 1266 1262 1242 1066 1115
curvefi/governance/relayer/op_stack/relayer_v_101.vy 1186 1182 1183 1014 1056
curvefi/governance/relayer/not_rollup/relayer_v_100.vy 1168 1153 1174 1011 1037
curvefi/governance/vault/vault_v_100.vy 964 941 862 823 839
curvefi/governance/relayer/relayer_v_100.vy 496 496 593 490 503
curvefi/governance/agent/agent_v_100.vy 541 541 430 402 406
curvefi/governance/agent/agent_v_101.vy 541 541 430 402 406

Comment thread vyper/semantics/types/primitives.py Outdated
Comment thread vyper/semantics/types/primitives.py Outdated
Comment thread vyper/semantics/types/primitives.py Outdated
Comment thread vyper/semantics/analysis/utils.py Outdated

@charles-cooper charles-cooper left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

approved once the helpers are changed to classmethod and that stray AddressT() => AddressT

@Sporarum

Sporarum commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator Author

@charles-cooper feel free to merge when CI passes

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ab1482dc2e

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

suggestion_str = f" Did you mean {checksum_encode(node.value)}?"
# call `validate_literal` for its side effect of throwing an exception for
# address checksum mismatch
AddressT().validate_literal(node)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Preserve checksum errors for conditional address literals

When a lower-case 20-byte address with a bad checksum is used through a conditional expression, e.g. x: address = 0x... if True else 0x..., inference gives the IfExp a bytes20 type and reaches this branch. validate_literal is then called on the IfExp rather than a Hex leaf, so its base validator raises the generic InvalidLiteral: Invalid literal for address; the new BadChecksumAddress and corrective checksum hint are lost. Validate the relevant hex branch(es), or guard this path so non-Hex expressions retain an appropriate checksum diagnostic.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fair, but I think that's something that needs to be fixed with #5017

@Sporarum
Sporarum merged commit 4c04d6b into vyperlang:master Sep 16, 2026
171 checks passed
@Sporarum
Sporarum deleted the catch-invalid-address branch September 16, 2026 13:29
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.

Wrong InvalidLiteral raise for checksum issues

3 participants