From 4624c7bf42166e5de111e0ba9bf7d3996eb87d17 Mon Sep 17 00:00:00 2001 From: Thomas Coratger Date: Sun, 30 Jun 2024 23:24:04 +0200 Subject: [PATCH] typo: fix encode_account documentation --- src/ethereum/arrow_glacier/fork_types.py | 5 ++--- src/ethereum/berlin/fork_types.py | 5 ++--- src/ethereum/byzantium/fork_types.py | 5 ++--- src/ethereum/cancun/fork_types.py | 5 ++--- src/ethereum/constantinople/fork_types.py | 5 ++--- src/ethereum/dao_fork/fork_types.py | 5 ++--- src/ethereum/frontier/fork_types.py | 5 ++--- src/ethereum/gray_glacier/fork_types.py | 5 ++--- src/ethereum/homestead/fork_types.py | 5 ++--- src/ethereum/istanbul/fork_types.py | 5 ++--- src/ethereum/london/fork_types.py | 5 ++--- src/ethereum/muir_glacier/fork_types.py | 5 ++--- src/ethereum/paris/fork_types.py | 5 ++--- src/ethereum/shanghai/fork_types.py | 5 ++--- src/ethereum/spurious_dragon/fork_types.py | 5 ++--- src/ethereum/tangerine_whistle/fork_types.py | 5 ++--- 16 files changed, 32 insertions(+), 48 deletions(-) diff --git a/src/ethereum/arrow_glacier/fork_types.py b/src/ethereum/arrow_glacier/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/arrow_glacier/fork_types.py +++ b/src/ethereum/arrow_glacier/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/berlin/fork_types.py b/src/ethereum/berlin/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/berlin/fork_types.py +++ b/src/ethereum/berlin/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/byzantium/fork_types.py b/src/ethereum/byzantium/fork_types.py index b8a26bd545..6f25f98c30 100644 --- a/src/ethereum/byzantium/fork_types.py +++ b/src/ethereum/byzantium/fork_types.py @@ -51,10 +51,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/cancun/fork_types.py b/src/ethereum/cancun/fork_types.py index 8d97937789..30dc2f4982 100644 --- a/src/ethereum/cancun/fork_types.py +++ b/src/ethereum/cancun/fork_types.py @@ -53,10 +53,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/constantinople/fork_types.py b/src/ethereum/constantinople/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/constantinople/fork_types.py +++ b/src/ethereum/constantinople/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/dao_fork/fork_types.py b/src/ethereum/dao_fork/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/dao_fork/fork_types.py +++ b/src/ethereum/dao_fork/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/frontier/fork_types.py b/src/ethereum/frontier/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/frontier/fork_types.py +++ b/src/ethereum/frontier/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/gray_glacier/fork_types.py b/src/ethereum/gray_glacier/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/gray_glacier/fork_types.py +++ b/src/ethereum/gray_glacier/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/homestead/fork_types.py b/src/ethereum/homestead/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/homestead/fork_types.py +++ b/src/ethereum/homestead/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/istanbul/fork_types.py b/src/ethereum/istanbul/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/istanbul/fork_types.py +++ b/src/ethereum/istanbul/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/london/fork_types.py b/src/ethereum/london/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/london/fork_types.py +++ b/src/ethereum/london/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/muir_glacier/fork_types.py b/src/ethereum/muir_glacier/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/muir_glacier/fork_types.py +++ b/src/ethereum/muir_glacier/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/paris/fork_types.py b/src/ethereum/paris/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/paris/fork_types.py +++ b/src/ethereum/paris/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/shanghai/fork_types.py b/src/ethereum/shanghai/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/shanghai/fork_types.py +++ b/src/ethereum/shanghai/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/spurious_dragon/fork_types.py b/src/ethereum/spurious_dragon/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/spurious_dragon/fork_types.py +++ b/src/ethereum/spurious_dragon/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( ( diff --git a/src/ethereum/tangerine_whistle/fork_types.py b/src/ethereum/tangerine_whistle/fork_types.py index 75812be178..270701e4f7 100644 --- a/src/ethereum/tangerine_whistle/fork_types.py +++ b/src/ethereum/tangerine_whistle/fork_types.py @@ -52,10 +52,9 @@ class Account: def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: """ - Encode `Account` dataclass. + Encode `Account` dataclass using RLP. - Storage is not stored in the `Account` dataclass, so `Accounts` cannot be - encoded with providing a storage root. + Note: Storage is not included in `Account`, so a storage root must be provided. """ return rlp.encode( (