Skip to content

Commit cf8e53a

Browse files
fix(docs): broken links have been repaired (issue #1196) (#1197)
* fix: broken documentation links have been repaired (issue #1196) * Update src/ethereum_test_vm/opcode.py --------- Co-authored-by: Mario Vega <[email protected]>
1 parent cf8eced commit cf8e53a

File tree

7 files changed

+13
-13
lines changed

7 files changed

+13
-13
lines changed

docs/consuming_tests/blockchain_test.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ For each [`Fixture`](#fixture) test object in the JSON fixture file, perform the
2828

2929
1. Determine whether the current block is valid or invalid:
3030

31-
1. If the [`expectException`](#expectexception-str) field is not present, it is valid, and object must be decoded as a [`FixtureBlock`](#fixtureblock).
32-
2. If the [`expectException`](#expectexception-str) field is present, it is invalid, and object must be decoded as a [`InvalidFixtureBlock`](#invalidfixtureblock).
31+
1. If the [`expectException`](#-expectexception-transactionexceptionblockexception) field is not present, it is valid, and object must be decoded as a [`FixtureBlock`](#fixtureblock).
32+
2. If the [`expectException`](#-expectexception-transactionexceptionblockexception) field is present, it is invalid, and object must be decoded as a [`InvalidFixtureBlock`](#invalidfixtureblock).
3333

3434
2. Attempt to decode field [`rlp`](#-rlp-bytes) as the current block
3535
1. If the block cannot be decoded:
@@ -192,7 +192,7 @@ Root hash of the parent beacon block.
192192

193193
#### - `rlp`: [`Bytes`](./common_types.md#bytes)
194194

195-
RLP serialized version of the block. Field is only optional when embedded in a [`InvalidFixtureBlock`](#invalidfixtureblock) as the [`rlp_decoded`](#rlp_decoded-optionalfixtureblock) field.
195+
RLP serialized version of the block. Field is only optional when embedded in a [`InvalidFixtureBlock`](#invalidfixtureblock) as the [`rlp_decoded`](#-rlp_decoded-optionalfixtureblock) field.
196196

197197
#### - `blockHeader`: [`FixtureHeader`](#fixtureheader)
198198

docs/consuming_tests/blockchain_test_engine.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ For each [`HiveFixture`](#hivefixture) test object in the JSON fixture file, per
3636
2. If [`errorCode`](#-errorcode-optionalnumber) is present:
3737
- Verify the directive returns an error, and the error code matches the one in [`errorCode`](#-errorcode-optionalnumber), otherwise fail the test.
3838
- Proceed to the next payload.
39-
3. If [`valid`](#-valid-bool) is `false`, verify that the directive returns `status` field of [PayloadStatusV1](https://github.com/ethereum/execution-apis/blob/main/src/engine/paris.md#payloadstatusv1) as `INVALID`, otherwise fail the test.
40-
4. If [`valid`](#-valid-bool) is `true`, verify that the directive returns `status` field of [PayloadStatusV1](https://github.com/ethereum/execution-apis/blob/main/src/engine/paris.md#payloadstatusv1) as `VALID`, otherwise fail the test.
39+
3. If `valid` is `false`, verify that the directive returns `status` field of [PayloadStatusV1](https://github.com/ethereum/execution-apis/blob/main/src/engine/paris.md#payloadstatusv1) as `INVALID`, otherwise fail the test.
40+
4. If `valid` is `true`, verify that the directive returns `status` field of [PayloadStatusV1](https://github.com/ethereum/execution-apis/blob/main/src/engine/paris.md#payloadstatusv1) as `VALID`, otherwise fail the test.
4141

4242
## Structures
4343

docs/consuming_tests/state_test.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ However tests generated by the `execution-spec-tests` repository do **not** use
2020

2121
## Consumption
2222

23-
For each [`Fixture`](#-fixture) test object in the JSON fixture file, perform the following steps:
23+
For each [`Fixture`](#fixture) test object in the JSON fixture file, perform the following steps:
2424

2525
1. Use [`pre`](#-pre-alloc) as the starting state allocation of the execution environment for the test.
2626
2. Use [`env`](#-env-fixtureenvironment) to configure the current execution environment.
@@ -32,10 +32,10 @@ For each [`Fixture`](#-fixture) test object in the JSON fixture file, perform th
3232
4. Attempt to apply the transaction using the current execution environment:
3333

3434
1. If the transaction could not be applied to the current execution context:
35-
- If [`expectException`](#-expectexception-str) is empty, fail the test.
36-
- If [`expectException`](#-expectexception-str) is not empty, revert the state to the pre-state.
35+
- If [`expectException`](#-expectexception-transactionexception) is empty, fail the test.
36+
- If [`expectException`](#-expectexception-transactionexception) is not empty, revert the state to the pre-state.
3737
2. If the transaction could be applied to the current execution context:
38-
- If [`expectException`](#-expectexception-str) is not empty, fail the test.
38+
- If [`expectException`](#-expectexception-transactionexception) is not empty, fail the test.
3939

4040
5. Compare the resulting post-state root with the expected post-state root contained in the [`hash`](#-hash-hash) field of the current [`FixtureForkPost`](#fixtureforkpost), and fail the test if they do not match.
4141
6. Compare the resulting logs hash with the expected logs contained in the [`logs`](#-logs-hash) field of the current [`FixtureForkPost`](#fixtureforkpost), and fail the test if they do not match.

docs/filling_tests/debugging_t8n_tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ which writes the response the from the `t8n-server` to the console output:
9090
}
9191
```
9292

93-
The `t8n.sh` is written to the debug directory for all [supported t8n tools](../index.md#transition-tool-support).
93+
The `t8n.sh` is written to the debug directory for all [supported t8n tools](./transition_tool_support.md).
9494

9595
## Verifying Test Fixtures via `evm blocktest`
9696

docs/filling_tests/filling_tests_vs_code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Implemented test cases can be explored in VS Code's "Testing" View; click on the
1111
</figure>
1212

1313
!!! note "Testing EVM Features Under Active Development"
14-
See [the VS Code section](./filling_tests_dev_fork.md#executing-tests-for-features-under-development) in [Filling Tests for Features under Development](./filling_tests_dev_fork.md) to explore tests targeting EVM features under development.
14+
See [the VS Code section](./filling_tests_dev_fork.md#vs-code-setup) in [Filling Tests for Features under Development](./filling_tests_dev_fork.md) to explore tests targeting EVM features under development.
1515

1616
## Filling and Debugging Test Cases
1717

docs/filling_tests/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ This guide describes how to get started with `fill` and commonly-used command-li
5353

5454
1. Learn [useful command-line flags](./filling_tests_command_line.md).
5555
2. [Execute tests for features under development](./filling_tests_dev_fork.md) via the `--fork` flag.
56-
3. _Optional:_ [Configure VS Code](../getting_started/setup_vs_code.md) to auto-format Python code and [execute tests within VS Code](./filling_tests_vs_code.md#executing-and-debugging-test-cases).
56+
3. _Optional:_ [Configure VS Code](../getting_started/setup_vs_code.md) to auto-format Python code and [execute tests within VS Code](./filling_tests_vs_code.md#filling-and-debugging-test-cases).
5757
4. Implement a new test case, see [Writing Tests](../writing_tests/index.md).

src/ethereum_test_vm/opcode.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5097,7 +5097,7 @@ class Opcodes(Opcode, Enum):
50975097
"""
50985098
!!! Note: This opcode is under development
50995099
5100-
EOFCREATE[initcontainer_index](value, salt, input_offset, input_size)
5100+
EOFCREATE[initcontainer_index] (value, salt, input_offset, input_size)
51015101
----
51025102
51035103
Description

0 commit comments

Comments
 (0)