Skip to content

refactor(fill,fixtures): rename "engine reorg" to "engine x"; improve pre-allocation group terminology #1760

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.

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

Merged
merged 6 commits into from
Jun 18, 2025

Conversation

danceratopz
Copy link
Member

@danceratopz danceratopz commented Jun 17, 2025

🗒️ Description

Improves the language around the new fixture format and grouped pre-allocations generation.

Main Terminology Updates

  • From "engine reorg" → "engine x"
  • From: "shared pre-allocation state" → To: "pre-allocation groups"
  • From: "shared pre-state" → To: "pre-allocation groups"
  • From: "sharing pre-allocation" → To: "pre-allocation group optimization"
  • From: "shared state groups" → To: "pre-allocation groups"
EngineX
  • BlockchainEngineReorgFixtureBlockchainEngineXFixture
  • blockchain_test_engine_reorgblockchain_test_engine_x
  • blockchain_tests_engine_reorgblockchain_tests_engine_x
  • Renamed: blockchain_test_engine_reorg.md to blockchain_test_engine_x.md
Pre-Alloc Groups
  1. Core Files:

    • src/ethereum_test_fixtures/pre_alloc_groups.py (renamed from shared_alloc.py)
    • src/pytest_plugins/filler/filler.py
    • src/cli/pytest_commands/fill.py
    • src/pytest_plugins/filler/fixture_output.py
    • src/pytest_plugins/filler/pre_alloc.py
  2. Flag Renames:

    • --generate-shared-pre--generate-pre-alloc-groups
    • --use-shared-pre--use-pre-alloc-groups
  3. Class Renames:

    • SharedPreStateGroupPreAllocGroup
    • SharedPreStatePreAllocGroups
  4. Method Renames:

    • update_shared_pre_stateupdate_pre_alloc_groups
    • compute_shared_pre_alloc_hashcompute_pre_alloc_group_hash
    • shared_pre_alloc_folder_pathpre_alloc_groups_folder_path
  5. Variable Renames:

    • shared_pre_statepre_alloc_groups
    • shared_allocpre_alloc_group
    • shared_allocspre_alloc_groups
  6. Property Renames:

    • shared_pre_alloc_folder_pathpre_alloc_groups_folder_path
    • generate_shared_pregenerate_pre_alloc_groups
    • use_shared_preuse_pre_alloc_groups
  7. Documentation Updated:

    • docs/running_tests/test_formats/blockchain_test_engine_x.md - Comprehensive terminology update
    • docs/library/cli/extract_config.md
    • docs/CHANGELOG.md
    • src/cli/show_pre_alloc_group_stats.py - Help text updates

🔗 Related Issues

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.

@danceratopz danceratopz added type:refactor Type: Refactor scope:fill Scope: fill command labels Jun 17, 2025
@danceratopz danceratopz changed the title refactor(fill,fixtures): rename "engine reorg" to "engine x"; "shared-pre-alloc" to "grouped-pre-allocs" refactor(fill,fixtures): rename "engine reorg" to "engine x"; improve pre-allocation group terminology Jun 17, 2025
@danceratopz danceratopz requested a review from marioevz June 17, 2025 15:54
@danceratopz danceratopz marked this pull request as ready for review June 17, 2025 15:54
… groups' 1/2

Terminology:
- 'shared pre-allocation' → 'pre-allocation groups'
- 'shared pre-state' → 'pre-allocation groups'

Flags:
-  `--generate-shared-pre` -> `--generate-grouped-pre-allocs`
-  `--use-shared-pre` -> `--use-grouped-pre-allocs`

Method names updated:
- `update_shared_pre_state` → `update_pre_alloc_groups`
- `compute_shared_pre_alloc_hash` → `compute_pre_alloc_group_hash`
- `shared_pre_alloc_folder_path` → `grouped_pre_allocs_folder_path`
Rename command-line flags to align with function and class naming:
- --generate-grouped-pre-allocs → --generate-pre-alloc-groups
- --use-grouped-pre-allocs → --use-pre-alloc-groups

This improves consistency with PreAllocGroups class and related
method names throughout the codebase. Updated all flag definitions,
config.getoption() calls, property names, and documentation.
@danceratopz danceratopz force-pushed the refactor/rename-engine-reorg-to-engine-x branch from 8897f68 to 10b0323 Compare June 18, 2025 05:22
Copy link
Member

@marioevz marioevz left a comment

Choose a reason for hiding this comment

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

Huge rename! Thanks for this! 👍

@marioevz marioevz merged commit bb4289a into main Jun 18, 2025
27 checks passed
@marioevz marioevz deleted the refactor/rename-engine-reorg-to-engine-x branch June 18, 2025 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:fill Scope: fill command type:refactor Type: Refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants