chore(spec-specs): fix typos in src/ethereum/

src/ethereum/ethash.py

@@ -398,8 +398,8 @@ def hashimoto_light(
     dataset_size: Uint,
 ) -> Tuple[Bytes, Hash32]:
     """
-    Run the [`hashimoto`] algorithm by generating dataset item using the cache
-    instead of loading the full dataset into main memory.
+    Run the [`hashimoto`] algorithm by generating a dataset item using the
+    cache instead of loading the full dataset into main memory.
 
     #### Parameters
 

src/ethereum/exceptions.py

@@ -18,7 +18,7 @@ class InvalidBlock(EthereumException):
 
 class StateWithEmptyAccount(EthereumException):
     """
-    Thrown when the state has empty account.
+    Thrown when the state has an empty account.
     """
 
 

src/ethereum/forks/amsterdam/blocks.py

@@ -152,7 +152,7 @@ class Header:
 
     number: Uint
     """
-    Block number, (height) in the chain.
+    Block number (height) in the chain.
     """
 
     gas_limit: Uint
@@ -272,7 +272,7 @@ class Block:
     header: Header
     """
     The block header containing metadata and cryptographic commitments. Refer
-    [headers] for more details on the fields included in the header.
+    to [headers] for more details on the fields included in the header.
 
     [headers]: ref:ethereum.forks.amsterdam.blocks.Header
     """

src/ethereum/forks/amsterdam/bloom.py

@@ -8,7 +8,7 @@
 Introduction
 ------------
 
-This modules defines functions for calculating bloom filters of logs. For the
+This module defines functions for calculating bloom filters of logs. For the
 general theory of bloom filters see e.g. `Wikipedia
 <https://en.wikipedia.org/wiki/Bloom_filter>`_. Bloom filters are used to allow
 for efficient searching of logs by address and/or topic, by rapidly

src/ethereum/forks/amsterdam/requests.py

@@ -1,5 +1,5 @@
 """
-Requests were introduced in EIP-7685 as a a general purpose framework for
+Requests were introduced in EIP-7685 as a general purpose framework for
 storing contract-triggered requests. It extends the execution header and
 body with a single field each to store the request information.
 This inherently exposes the requests to the consensus layer, which can

src/ethereum/forks/amsterdam/state.py

@@ -400,7 +400,7 @@ def account_exists(state: State, address: Address) -> bool:
 
 def account_has_code_or_nonce(state: State, address: Address) -> bool:
     """
-    Checks if an account has non zero nonce or non empty code.
+    Checks if an account has non-zero nonce or non-empty code.
 
     Parameters
     ----------
@@ -412,7 +412,7 @@ def account_has_code_or_nonce(state: State, address: Address) -> bool:
     Returns
     -------
     has_code_or_nonce : `bool`
-        True if the account has non zero nonce or non empty code,
+        True if the account has non-zero nonce or non-empty code,
         False otherwise.
 
     """
@@ -517,7 +517,7 @@ def set_account_balance(state: State, address: Address, amount: U256) -> None:
         Address of the account whose nonce needs to be incremented.
 
     amount:
-        The amount that needs to set in balance.
+        The amount that needs to be set in the balance.
 
     """
 
@@ -557,7 +557,7 @@ def set_code(state: State, address: Address, code: Bytes) -> None:
         The current state.
 
     address:
-        Address of the account whose code needs to be update.
+        Address of the account whose code needs to be updated.
 
     code:
         The bytecode that needs to be set.

src/ethereum/forks/amsterdam/trie.py

@@ -138,7 +138,7 @@ class BranchNode:
 def encode_internal_node(node: Optional[InternalNode]) -> Extended:
     """
     Encodes a Merkle Trie node into its RLP form. The RLP will then be
-    serialized into a `Bytes` and hashed unless it is less that 32 bytes
+    serialized into a `Bytes` object and hashed unless it is less than 32 bytes
     when serialized.
 
     This function also accepts `None`, representing the absence of a node,

src/ethereum/forks/amsterdam/vm/__init__.py

@@ -63,7 +63,7 @@ class BlockOutput:
     receipts_trie : `ethereum.fork_types.Root`
         Trie root of all the receipts in the block.
     receipt_keys :
-        Key of all the receipts in the block.
+        Keys of all the receipts in the block.
     block_logs : `Bloom`
         Logs bloom of all the logs included in all the transactions of the
         block.

src/ethereum/forks/amsterdam/vm/eoa_delegation.py

@@ -157,8 +157,6 @@ def set_delegation(message: Message) -> U256:
     ----------
     message :
         Transaction specific items.
-    env :
-        External items required for EVM execution.
 
     Returns
     -------

src/ethereum/forks/amsterdam/vm/gas.py

@@ -232,7 +232,7 @@ def calculate_message_call_gas(
         account inside a message call.
     call_stipend :
         The amount of stipend provided to a message call to execute code while
-        transferring value(ETH).
+        transferring value (ETH).
 
     Returns
     -------
@@ -288,7 +288,7 @@ def init_code_cost(init_code_length: Uint) -> Uint:
 
 def calculate_excess_blob_gas(parent_header: Header) -> U64:
     """
-    Calculated the excess blob gas for the current block based
+    Calculates the excess blob gas for the current block based
     on the gas used in the parent block.
 
     Parameters

src/ethereum/forks/amsterdam/vm/instructions/arithmetic.py

@@ -84,7 +84,7 @@ def sub(evm: Evm) -> None:
 
 def mul(evm: Evm) -> None:
     """
-    Multiply the top two elements of the stack, and pushes the result back
+    Multiplies the top two elements of the stack, and pushes the result back
     on the stack.
 
     Parameters
@@ -353,7 +353,7 @@ def signextend(evm: Evm) -> None:
         # Can't extend any further
         result = value
     else:
-        # U256(0).to_be_bytes() gives b'' instead b'\x00'.
+        # U256(0).to_be_bytes() gives b'' instead of b'\x00'.
         value_bytes = Bytes(value.to_be_bytes32())
         # Now among the obtained value bytes, consider only
         # N `least significant bytes`, where N is `byte_num + 1`.

src/ethereum/forks/amsterdam/vm/instructions/block.py

@@ -101,7 +101,7 @@ def coinbase(evm: Evm) -> None:
 def timestamp(evm: Evm) -> None:
     """
     Push the current block's timestamp onto the stack. Here the timestamp
-    being referred is actually the unix timestamp in seconds.
+    being referred to is actually the unix timestamp in seconds.
 
     Here the current block refers to the block in which the currently
     executing transaction/call resides.

src/ethereum/forks/amsterdam/vm/instructions/environment.py

@@ -426,7 +426,7 @@ def returndatasize(evm: Evm) -> None:
 
 def returndatacopy(evm: Evm) -> None:
     """
-    Copies data from the return data buffer code to memory.
+    Copies data from the return data buffer to memory.
 
     Parameters
     ----------

src/ethereum/forks/amsterdam/vm/instructions/memory.py

@@ -93,7 +93,7 @@ def mstore8(evm: Evm) -> None:
 
 def mload(evm: Evm) -> None:
     """
-    Load word from memory.
+    Loads a word from memory.
 
     Parameters
     ----------
@@ -123,7 +123,7 @@ def mload(evm: Evm) -> None:
 
 def msize(evm: Evm) -> None:
     """
-    Push the size of active memory in bytes onto the stack.
+    Pushes the size of active memory in bytes onto the stack.
 
     Parameters
     ----------
@@ -146,7 +146,7 @@ def msize(evm: Evm) -> None:
 
 def mcopy(evm: Evm) -> None:
     """
-    Copy the bytes in memory from one location to another.
+    Copies the bytes in memory from one location to another.
 
     Parameters
     ----------

src/ethereum/forks/amsterdam/vm/instructions/stack.py

@@ -23,7 +23,7 @@
 
 def pop(evm: Evm) -> None:
     """
-    Remove item from stack.
+    Removes an item from the stack.
 
     Parameters
     ----------
@@ -46,7 +46,7 @@ def pop(evm: Evm) -> None:
 
 def push_n(evm: Evm, num_bytes: int) -> None:
     """
-    Pushes a N-byte immediate onto the stack. Push zero if num_bytes is zero.
+    Pushes an N-byte immediate onto the stack. Push zero if num_bytes is zero.
 
     Parameters
     ----------
@@ -79,7 +79,7 @@ def push_n(evm: Evm, num_bytes: int) -> None:
 
 def dup_n(evm: Evm, item_number: int) -> None:
     """
-    Duplicate the Nth stack item (from top of the stack) to the top of stack.
+    Duplicates the Nth stack item (from top of the stack) to the top of stack.
 
     Parameters
     ----------
@@ -107,7 +107,7 @@ def dup_n(evm: Evm, item_number: int) -> None:
 
 def swap_n(evm: Evm, item_number: int) -> None:
     """
-    Swap the top and the `item_number` element of the stack, where
+    Swaps the top and the `item_number` element of the stack, where
     the top of the stack is position zero.
 
     If `item_number` is zero, this function does nothing (which should not be

src/ethereum/forks/amsterdam/vm/instructions/system.py

@@ -193,8 +193,8 @@ def create2(evm: Evm) -> None:
     """
     Creates a new account with associated code.
 
-    It's similar to CREATE opcode except that the address of new account
-    depends on the init_code instead of the nonce of sender.
+    It's similar to the CREATE opcode except that the address of the new
+    account depends on the init_code instead of the nonce of sender.
 
     Parameters
     ----------

src/ethereum/forks/amsterdam/vm/precompiled_contracts/bls12_381/bls12_381_pairing.py

@@ -33,7 +33,7 @@ def bls12_pairing(evm: Evm) -> None:
     Raises
     ------
     InvalidParameter
-        If the input length is invalid or if sub-group check fails.
+        If the input length is invalid or if the subgroup check fails.
 
     """
     data = evm.message.data
@@ -54,12 +54,12 @@ def bls12_pairing(evm: Evm) -> None:
         g1_slice = data[g1_start : g1_start + Uint(128)]
         g1_point = bytes_to_g1(bytes(g1_slice))
         if not is_inf(bls12_multiply(g1_point, curve_order)):
-            raise InvalidParameter("Sub-group check failed for G1 point.")
+            raise InvalidParameter("Subgroup check failed for G1 point.")
 
         g2_slice = data[g2_start : g2_start + Uint(256)]
         g2_point = bytes_to_g2(bytes(g2_slice))
         if not is_inf(bls12_multiply(g2_point, curve_order)):
-            raise InvalidParameter("Sub-group check failed for G2 point.")
+            raise InvalidParameter("Subgroup check failed for G2 point.")
 
         result *= pairing(g2_point, g1_point)
 

src/ethereum/forks/amsterdam/vm/precompiled_contracts/ecrecover.py

@@ -8,7 +8,7 @@
 Introduction
 ------------
 
-Implementation of the ECRECOVER precompiled contract.
+Implementation of the `ECRECOVER` precompiled contract.
 """
 
 from ethereum_types.numeric import U256

src/ethereum/forks/amsterdam/vm/precompiled_contracts/mapping.py

@@ -8,7 +8,7 @@
 Introduction
 ------------
 
-Mapping of precompiled contracts their implementations.
+Mapping of precompiled contracts to their implementations.
 """
 
 from typing import Callable, Dict

src/ethereum/forks/amsterdam/vm/precompiled_contracts/modexp.py

@@ -22,7 +22,7 @@
 
 def modexp(evm: Evm) -> None:
     """
-    Calculates `(base**exp) % modulus` for arbitrary sized `base`, `exp` and.
+    Calculates `(base**exp) % modulus` for arbitrary sized `base`, `exp` and
     `modulus`. The return value is the same length as the modulus.
     """
     data = evm.message.data

src/ethereum/forks/amsterdam/vm/precompiled_contracts/p256verify.py

@@ -5,9 +5,10 @@
     :backlinks: none
     :local:
 
-Introduction.
+Introduction
 ------------
-Implementation of the P256VERIFY precompiled contract.
+
+Implementation of the `P256VERIFY` precompiled contract.
 """
 
 from ethereum_types.numeric import U256

src/ethereum/forks/amsterdam/vm/precompiled_contracts/point_evaluation.py

@@ -8,7 +8,7 @@
 Introduction
 ------------
 
-Implementation of the POINT EVALUATION precompiled contract.
+Implementation of the `POINT EVALUATION` precompiled contract.
 """
 
 from ethereum_types.bytes import Bytes, Bytes32, Bytes48

src/ethereum/forks/amsterdam/vm/runtime.py

@@ -21,7 +21,7 @@
 
 def get_valid_jump_destinations(code: Bytes) -> Set[Uint]:
     """
-    Analyze the evm code to obtain the set of valid jump destinations.
+    Analyze the EVM code to obtain the set of valid jump destinations.
 
     Valid jump destinations are defined as follows:
         * The jump destination is less than the length of the code.

src/ethereum/forks/arrow_glacier/blocks.py

@@ -121,7 +121,7 @@ class Header:
 
     number: Uint
     """
-    Block number, (height) in the chain.
+    Block number (height) in the chain.
     """
 
     gas_limit: Uint
@@ -207,7 +207,7 @@ class Block:
     header: Header
     """
     The block header containing metadata and cryptographic commitments. Refer
-    [headers] for more details on the fields included in the header.
+    to [headers] for more details on the fields included in the header.
 
     [headers]: ref:ethereum.forks.arrow_glacier.blocks.Header
     """

src/ethereum/forks/arrow_glacier/bloom.py

@@ -8,7 +8,7 @@
 Introduction
 ------------
 
-This modules defines functions for calculating bloom filters of logs. For the
+This module defines functions for calculating bloom filters of logs. For the
 general theory of bloom filters see e.g. `Wikipedia
 <https://en.wikipedia.org/wiki/Bloom_filter>`_. Bloom filters are used to allow
 for efficient searching of logs by address and/or topic, by rapidly

src/ethereum/forks/arrow_glacier/state.py

@@ -367,7 +367,7 @@ def account_exists(state: State, address: Address) -> bool:
 
 def account_has_code_or_nonce(state: State, address: Address) -> bool:
     """
-    Checks if an account has non zero nonce or non empty code.
+    Checks if an account has non-zero nonce or non-empty code.
 
     Parameters
     ----------
@@ -379,7 +379,7 @@ def account_has_code_or_nonce(state: State, address: Address) -> bool:
     Returns
     -------
     has_code_or_nonce : `bool`
-        True if the account has non zero nonce or non empty code,
+        True if the account has non-zero nonce or non-empty code,
         False otherwise.
 
     """
@@ -500,7 +500,7 @@ def set_account_balance(state: State, address: Address, amount: U256) -> None:
         Address of the account whose nonce needs to be incremented.
 
     amount:
-        The amount that needs to set in balance.
+        The amount that needs to be set in the balance.
 
     """
 
@@ -520,7 +520,7 @@ def touch_account(state: State, address: Address) -> None:
         The current state.
 
     address:
-        The address of the account that need to initialised.
+        The address of the account that needs to be initialized.
 
     """
     if not account_exists(state, address):
@@ -557,7 +557,7 @@ def set_code(state: State, address: Address, code: Bytes) -> None:
         The current state.
 
     address:
-        Address of the account whose code needs to be update.
+        Address of the account whose code needs to be updated.
 
     code:
         The bytecode that needs to be set.