diff --git a/grammar_manual_verification.md b/grammar_manual_verification.md index 434bebec68..309ef48e69 100644 --- a/grammar_manual_verification.md +++ b/grammar_manual_verification.md @@ -41,3 +41,8 @@ Format (but don't add a codeblock for each item): - [ ] packages/testing/src/execution_testing/client_clis/clis/__init__.py:1 - "Package containing concrete implementations of Ethereum CL interfaces." Suggestion: "Package containing concrete implementations of Ethereum CLI interfaces." Reason: "CL" likely means "CLI" (Command Line Interface) since this package contains CLI tools. "CL" in Ethereum context typically means "Consensus Layer" which doesn't fit the context. + +- [x] packages/testing/src/execution_testing/forks/forks/forks.py:638 - Standalone string after docstring + Suggestion: Merge into docstring: """At genesis, there is no upper bound for initcode size. However, the default is set to the limit of EIP-3860 (Shanghai).""" + Reason: The string on line 638 appears after `del block_number, timestamp` and is not part of the docstring. Compare with similar `max_code_size` method which has both sentences in the docstring. + Status: Fixed in this PR. diff --git a/packages/testing/src/execution_testing/forks/base_fork.py b/packages/testing/src/execution_testing/forks/base_fork.py index 34979e8c49..a8814b995b 100644 --- a/packages/testing/src/execution_testing/forks/base_fork.py +++ b/packages/testing/src/execution_testing/forks/base_fork.py @@ -613,7 +613,7 @@ def block_rlp_size_limit( def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: - """Return list pre-compiles supported by the fork.""" + """Return list of precompiles supported by the fork.""" pass @classmethod @@ -621,7 +621,7 @@ def precompiles( def system_contracts( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: - """Return list system-contracts supported by the fork.""" + """Return list of system contracts supported by the fork.""" pass @classmethod diff --git a/packages/testing/src/execution_testing/forks/forks/forks.py b/packages/testing/src/execution_testing/forks/forks/forks.py index 89e62df6f9..90aac4ea8c 100644 --- a/packages/testing/src/execution_testing/forks/forks/forks.py +++ b/packages/testing/src/execution_testing/forks/forks/forks.py @@ -588,7 +588,7 @@ def block_rlp_size_limit( def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: - """At Genesis, no pre-compiles are present.""" + """At Genesis, no precompiles are present.""" del block_number, timestamp return [] @@ -596,7 +596,7 @@ def precompiles( def system_contracts( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: - """At Genesis, no system-contracts are present.""" + """At Genesis, no system contracts are present.""" del block_number, timestamp return [] @@ -633,9 +633,12 @@ def max_stack_height( def max_initcode_size( cls, *, block_number: int = 0, timestamp: int = 0 ) -> int: - """At genesis, there is no upper bound for initcode size.""" + """ + At genesis, there is no upper bound for initcode size. + + However, the default is set to the limit of EIP-3860 (Shanghai). + """ del block_number, timestamp - """However, the default is set to the limit of EIP-3860 (Shanghai)""" return 0xC000 @classmethod @@ -846,7 +849,7 @@ def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: """ - At Homestead, EC-recover, SHA256, RIPEMD160, and Identity pre-compiles + At Homestead, EC-recover, SHA256, RIPEMD160, and Identity precompiles are introduced. """ return [ @@ -948,7 +951,7 @@ def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: """ - At Byzantium, pre-compiles for bigint modular exponentiation, addition + At Byzantium, precompiles for bigint modular exponentiation, addition and scalar multiplication on elliptic curve alt_bn128, and optimal ate pairing check on elliptic curve alt_bn128 are introduced. """ @@ -1063,7 +1066,7 @@ class Istanbul(ConstantinopleFix): def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: - """At Istanbul, pre-compile for blake2 compression is introduced.""" + """At Istanbul, a precompile for blake2 compression is introduced.""" return [ Address(9, label="BLAKE2F"), ] + super(Istanbul, cls).precompiles( @@ -1712,7 +1715,7 @@ def tx_types( def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: - """At Cancun, pre-compile for kzg point evaluation is introduced.""" + """At Cancun, a precompile for kzg point evaluation is introduced.""" return [ Address(10, label="KZG_POINT_EVALUATION"), ] + super(Cancun, cls).precompiles( @@ -1816,7 +1819,7 @@ def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: """ - At Prague, pre-compile for BLS operations are added. + At Prague, precompiles for BLS operations are added. BLS12_G1ADD = 0x0B BLS12_G1MSM = 0x0C @@ -2223,7 +2226,7 @@ def precompiles( cls, *, block_number: int = 0, timestamp: int = 0 ) -> List[Address]: """ - At Osaka, pre-compile for p256verify operation is added. + At Osaka, a precompile for p256verify operation is added. P256VERIFY = 0x100 """ diff --git a/repo_subpaths_for_grammar_check.md b/repo_subpaths_for_grammar_check.md index fea9f47f03..d6fc5c88e8 100644 --- a/repo_subpaths_for_grammar_check.md +++ b/repo_subpaths_for_grammar_check.md @@ -27,7 +27,7 @@ Status legend: `[ ]` pending, `[~]` in progress, `[x]` complete - [x] `packages/testing/src/execution_testing/fixtures/**/*.py` (~16 files) - [x] `packages/testing/src/execution_testing/client_clis/**/*.py` (~21 files) - [x] `packages/testing/src/execution_testing/base_types/**/*.py` (~15 files) -- [ ] `packages/testing/src/execution_testing/forks/**/*.py` (~13 files) +- [x] `packages/testing/src/execution_testing/forks/**/*.py` (~13 files) - [ ] `packages/testing/src/execution_testing/tools/**/*.py`, `exceptions/**/*.py` (~24 files) - [ ] `packages/testing/src/execution_testing/vm/**/*.py`, `rpc/**/*.py`, `config/**/*.py` (~17 files) - [ ] `packages/testing/src/execution_testing/logging/**/*.py`, `execution/**/*.py`, `checklists/**/*.py`, `benchmark/**/*.py` (~14 files)