Ethereum Test Base Types package¶
Common definitions and types.
Address
¶
Bases: FixedSizeBytes[20]
Class that helps represent Ethereum addresses in tests.
Source code in src/ethereum_test_base_types/base_types.py
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 |
|
__new__(input, *, label=None)
¶
Creates a new Address object with an optional label.
Source code in src/ethereum_test_base_types/base_types.py
355 356 357 358 359 360 361 362 363 364 |
|
Bloom
¶
Bases: FixedSizeBytes[256]
Class that helps represent blooms in tests.
Source code in src/ethereum_test_base_types/base_types.py
375 376 377 378 379 380 |
|
BLSPublicKey
¶
Bases: FixedSizeBytes[48]
Class that helps represent BLS public keys in tests.
Source code in src/ethereum_test_base_types/base_types.py
391 392 393 394 395 396 |
|
BLSSignature
¶
Bases: FixedSizeBytes[96]
Class that helps represent BLS signatures in tests.
Source code in src/ethereum_test_base_types/base_types.py
399 400 401 402 403 404 |
|
Bytes
¶
Bases: bytes
, ToStringSchema
Class that helps represent bytes of variable length in tests.
Source code in src/ethereum_test_base_types/base_types.py
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
|
__new__(input=b'')
¶
Creates a new Bytes object.
Source code in src/ethereum_test_base_types/base_types.py
166 167 168 169 170 171 172 |
|
__hash__()
¶
Returns the hash of the bytes.
Source code in src/ethereum_test_base_types/base_types.py
174 175 176 177 178 |
|
__str__()
¶
Returns the hexadecimal representation of the bytes.
Source code in src/ethereum_test_base_types/base_types.py
180 181 182 183 184 |
|
hex(*args, **kwargs)
¶
Returns the hexadecimal representation of the bytes.
Source code in src/ethereum_test_base_types/base_types.py
186 187 188 189 190 |
|
or_none(input)
classmethod
¶
Converts the input to a Bytes while accepting None.
Source code in src/ethereum_test_base_types/base_types.py
192 193 194 195 196 197 198 199 |
|
keccak256()
¶
Return the keccak256 hash of the opcode byte representation.
Source code in src/ethereum_test_base_types/base_types.py
201 202 203 204 205 206 |
|
sha256()
¶
Return the sha256 hash of the opcode byte representation.
Source code in src/ethereum_test_base_types/base_types.py
208 209 210 211 212 |
|
FixedSizeBytes
¶
Bases: Bytes
Class that helps represent bytes of fixed length in tests.
Source code in src/ethereum_test_base_types/base_types.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 |
|
__class_getitem__(length)
¶
Creates a new FixedSizeBytes class with the given length.
Source code in src/ethereum_test_base_types/base_types.py
291 292 293 294 295 296 297 298 299 300 |
|
__new__(input)
¶
Creates a new FixedSizeBytes object.
Source code in src/ethereum_test_base_types/base_types.py
302 303 304 305 306 307 308 |
|
__hash__()
¶
Returns the hash of the bytes.
Source code in src/ethereum_test_base_types/base_types.py
310 311 312 313 314 |
|
or_none(input)
classmethod
¶
Converts the input to a Fixed Size Bytes while accepting None.
Source code in src/ethereum_test_base_types/base_types.py
316 317 318 319 320 321 322 323 |
|
__eq__(other)
¶
Compares two FixedSizeBytes objects to be equal.
Source code in src/ethereum_test_base_types/base_types.py
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 |
|
__ne__(other)
¶
Compares two FixedSizeBytes objects to be not equal.
Source code in src/ethereum_test_base_types/base_types.py
341 342 343 344 345 |
|
Hash
¶
Bases: FixedSizeBytes[32]
Class that helps represent hashes in tests.
Source code in src/ethereum_test_base_types/base_types.py
367 368 369 370 371 372 |
|
HashInt
¶
Bases: FixedSizeHexNumber[32]
Class that helps represent hashes in tests.
Source code in src/ethereum_test_base_types/base_types.py
272 273 274 275 276 277 |
|
HeaderNonce
¶
Bases: FixedSizeBytes[8]
Class that helps represent the header nonce in tests.
Source code in src/ethereum_test_base_types/base_types.py
383 384 385 386 387 388 |
|
HexNumber
¶
Bases: Number
Class that helps represent an hexadecimal numbers in tests.
Source code in src/ethereum_test_base_types/base_types.py
129 130 131 132 133 134 135 136 137 138 |
|
__str__()
¶
Returns the string representation of the number.
Source code in src/ethereum_test_base_types/base_types.py
134 135 136 137 138 |
|
Number
¶
Bases: int
, ToStringSchema
Class that helps represent numbers in tests.
Source code in src/ethereum_test_base_types/base_types.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
|
__new__(input)
¶
Creates a new Number object.
Source code in src/ethereum_test_base_types/base_types.py
51 52 53 54 55 |
|
__str__()
¶
Returns the string representation of the number.
Source code in src/ethereum_test_base_types/base_types.py
57 58 59 60 61 |
|
hex()
¶
Returns the hexadecimal representation of the number.
Source code in src/ethereum_test_base_types/base_types.py
63 64 65 66 67 |
|
or_none(input)
classmethod
¶
Converts the input to a Number while accepting None.
Source code in src/ethereum_test_base_types/base_types.py
69 70 71 72 73 74 75 76 |
|
Wei
¶
Bases: Number
Class that helps represent wei that can be parsed from strings
Source code in src/ethereum_test_base_types/base_types.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 |
|
__new__(input)
¶
Creates a new Number object.
Source code in src/ethereum_test_base_types/base_types.py
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
|
ZeroPaddedHexNumber
¶
Bases: HexNumber
Class that helps represent zero padded hexadecimal numbers in tests.
Source code in src/ethereum_test_base_types/base_types.py
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
|
hex()
¶
Returns the hexadecimal representation of the number.
Source code in src/ethereum_test_base_types/base_types.py
146 147 148 149 150 151 152 153 154 155 |
|
AccessList
¶
Bases: CamelModel
Access List for transactions.
Source code in src/ethereum_test_base_types/composite_types.py
479 480 481 482 483 484 485 486 487 488 489 490 491 |
|
to_list()
¶
Returns the access list as a list of serializable elements.
Source code in src/ethereum_test_base_types/composite_types.py
487 488 489 490 491 |
|
Account
¶
Bases: CamelModel
State associated with an address.
Source code in src/ethereum_test_base_types/composite_types.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
|
nonce: ZeroPaddedHexNumber = ZeroPaddedHexNumber(0)
class-attribute
instance-attribute
¶
The scalar value equal to a) the number of transactions sent by an Externally Owned Account, b) the amount of contracts created by a contract.
balance: ZeroPaddedHexNumber = ZeroPaddedHexNumber(0)
class-attribute
instance-attribute
¶
The amount of Wei (10-18 Eth) the account has.
code: Bytes = Bytes(b'')
class-attribute
instance-attribute
¶
Bytecode contained by the account.
storage: Storage = Field(default_factory=Storage)
class-attribute
instance-attribute
¶
Storage within a contract.
NONEXISTENT: None = None
class-attribute
¶
Sentinel object used to specify when an account should not exist in the state.
NonceMismatch
dataclass
¶
Bases: Exception
Test expected a certain nonce value for an account but a different value was found.
Source code in src/ethereum_test_base_types/composite_types.py
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
339 340 341 342 343 344 345 346 347 |
|
BalanceMismatch
dataclass
¶
Bases: Exception
Test expected a certain balance for an account but a different value was found.
Source code in src/ethereum_test_base_types/composite_types.py
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
366 367 368 369 370 371 372 373 374 |
|
CodeMismatch
dataclass
¶
Bases: Exception
Test expected a certain bytecode for an account but a different one was found.
Source code in src/ethereum_test_base_types/composite_types.py
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
393 394 395 396 397 398 399 400 401 |
|
check_alloc(address, account)
¶
Checks the returned alloc against an expected account in post state. Raises exception on failure.
Source code in src/ethereum_test_base_types/composite_types.py
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 |
|
__bool__()
¶
Returns True on a non-empty account.
Source code in src/ethereum_test_base_types/composite_types.py
435 436 437 438 439 |
|
with_code(code)
classmethod
¶
Create account with provided code
and nonce of 1
.
Source code in src/ethereum_test_base_types/composite_types.py
441 442 443 444 445 446 |
|
merge(account_1, account_2)
classmethod
¶
Create a merged account from two sources.
Source code in src/ethereum_test_base_types/composite_types.py
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
|
Alloc
¶
Bases: EthereumTestRootModel[Dict[Address, Account | None]]
Allocation of accounts in the state, pre and post test execution.
Source code in src/ethereum_test_base_types/composite_types.py
471 472 473 474 475 476 |
|
Storage
¶
Bases: EthereumTestRootModel[Dict[StorageKeyValueType, StorageKeyValueType]]
Definition of a storage in pre or post state of a test
Source code in src/ethereum_test_base_types/composite_types.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 |
|
StorageDictType: TypeAlias = Dict[str | int | bytes | SupportsBytes, str | int | bytes | SupportsBytes]
class-attribute
¶
Dictionary type to be used when defining an input to initialize a storage.
InvalidType
dataclass
¶
Bases: Exception
Invalid type used when describing test's expected storage key or value.
Source code in src/ethereum_test_base_types/composite_types.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
49 50 51 |
|
InvalidValue
dataclass
¶
Bases: Exception
Invalid value used when describing test's expected storage key or value.
Source code in src/ethereum_test_base_types/composite_types.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
66 67 68 |
|
MissingKey
dataclass
¶
Bases: Exception
Test expected to find a storage key set but key was missing.
Source code in src/ethereum_test_base_types/composite_types.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
82 83 84 |
|
KeyValueMismatch
dataclass
¶
Bases: Exception
Test expected a certain value in a storage key but value found was different.
Source code in src/ethereum_test_base_types/composite_types.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
|
__str__()
¶
Print exception string
Source code in src/ethereum_test_base_types/composite_types.py
107 108 109 110 111 112 113 114 115 116 117 |
|
__contains__(key)
¶
Checks for an item in the storage
Source code in src/ethereum_test_base_types/composite_types.py
119 120 121 |
|
__getitem__(key)
¶
Returns an item from the storage
Source code in src/ethereum_test_base_types/composite_types.py
123 124 125 126 127 |
|
__setitem__(key, value)
¶
Sets an item in the storage
Source code in src/ethereum_test_base_types/composite_types.py
129 130 131 132 133 134 135 136 137 |
|
__delitem__(key)
¶
Deletes an item from the storage
Source code in src/ethereum_test_base_types/composite_types.py
139 140 141 |
|
__iter__()
¶
Returns an iterator over the storage
Source code in src/ethereum_test_base_types/composite_types.py
143 144 145 |
|
__eq__(other)
¶
Returns True if both storages are equal.
Source code in src/ethereum_test_base_types/composite_types.py
147 148 149 150 151 152 153 |
|
__ne__(other)
¶
Returns True if both storages are not equal.
Source code in src/ethereum_test_base_types/composite_types.py
155 156 157 158 159 160 161 |
|
__bool__()
¶
Returns True if the storage is not empty
Source code in src/ethereum_test_base_types/composite_types.py
163 164 165 |
|
__add__(other)
¶
Returns a new storage that is the sum of two storages.
Source code in src/ethereum_test_base_types/composite_types.py
167 168 169 170 171 |
|
keys()
¶
Returns the keys of the storage
Source code in src/ethereum_test_base_types/composite_types.py
173 174 175 |
|
set_next_slot(slot)
¶
Sets the next slot to be used by store_next
.
Source code in src/ethereum_test_base_types/composite_types.py
177 178 179 180 181 182 |
|
items()
¶
Returns the items of the storage
Source code in src/ethereum_test_base_types/composite_types.py
184 185 186 |
|
store_next(value, hint='')
¶
Stores a value in the storage and returns the key where the value is stored.
Increments the key counter so the next time this function is called, the next key is used.
Source code in src/ethereum_test_base_types/composite_types.py
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
|
peek_slot()
¶
Peeks the next slot that will be used by store_next
.
Source code in src/ethereum_test_base_types/composite_types.py
204 205 206 207 208 |
|
contains(other)
¶
Returns True if self contains all keys with equal value as contained by second storage. Used for comparison with test expected post state and alloc returned by the transition tool.
Source code in src/ethereum_test_base_types/composite_types.py
210 211 212 213 214 215 216 217 218 219 220 221 222 |
|
must_contain(address, other)
¶
Succeeds only if self contains all keys with equal value as contained by second storage. Used for comparison with test expected post state and alloc returned by the transition tool. Raises detailed exception when a difference is found.
Source code in src/ethereum_test_base_types/composite_types.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
|
must_be_equal(address, other)
¶
Succeeds only if "self" is equal to "other" storage.
Source code in src/ethereum_test_base_types/composite_types.py
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
|
canary()
¶
Returns a canary storage filled with non-zero values where the current storage expects zero values, to guarantee that the test overwrites the storage.
Source code in src/ethereum_test_base_types/composite_types.py
284 285 286 287 288 289 |
|
to_bytes(input)
¶
Converts multiple types into bytes.
Source code in src/ethereum_test_base_types/conversions.py
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
|
to_hex(input)
¶
Converts multiple types into a bytes hex string.
Source code in src/ethereum_test_base_types/conversions.py
69 70 71 72 73 |
|
to_json(input)
¶
Converts a model to its json data representation.
Source code in src/ethereum_test_base_types/json.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
|
CamelModel
¶
Bases: CopyValidateModel
A base model that converts field names to camel case when serializing.
For example, the field name current_timestamp
in a Python model will be represented
as currentTimestamp
when it is serialized to json.
Source code in src/ethereum_test_base_types/pydantic.py
45 46 47 48 49 50 51 52 53 54 55 56 57 |
|
EthereumTestBaseModel
¶
Bases: BaseModel
, ModelCustomizationsMixin
Base model for all models for Ethereum tests.
Source code in src/ethereum_test_base_types/pydantic.py
17 18 19 20 21 22 |
|
EthereumTestRootModel
¶
Bases: RootModel[RootModelRootType]
, ModelCustomizationsMixin
Base model for all models for Ethereum tests.
Source code in src/ethereum_test_base_types/pydantic.py
25 26 27 28 29 30 |
|
ReferenceSpec
¶
Reference Specification Description Abstract Class.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
|
name()
abstractmethod
¶
Returns the name of the spec.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
35 36 37 38 39 40 |
|
has_known_version()
abstractmethod
¶
Returns true if the reference spec object is hard-coded with a latest known version.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
42 43 44 45 46 47 48 |
|
known_version()
abstractmethod
¶
Returns the latest known version in the reference.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
50 51 52 53 54 55 |
|
api_url()
abstractmethod
¶
Returns the URL required to poll the version from an API, if needed.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
57 58 59 60 61 62 |
|
latest_version()
abstractmethod
¶
Returns a digest that points to the latest version of the spec.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
64 65 66 67 68 69 |
|
is_outdated()
abstractmethod
¶
Checks whether the reference specification has been updated since the test was last updated.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
71 72 73 74 75 76 77 |
|
write_info(info)
abstractmethod
¶
Writes info about the reference specification used into the output fixture.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
79 80 81 82 83 84 85 |
|
parseable_from_module(module_dict)
abstractmethod
staticmethod
¶
Checks whether the module's dict contains required reference spec information.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
87 88 89 90 91 92 93 94 |
|
parse_from_module(module_dict)
abstractmethod
staticmethod
¶
Parses the module's dict into a reference spec.
Source code in src/ethereum_test_base_types/reference_spec/reference_spec.py
96 97 98 99 100 101 102 |
|