aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorwinsvega <winsvega@mail.ru>2018-10-25 00:22:46 +0800
committerGitHub <noreply@github.com>2018-10-25 00:22:46 +0800
commit2cd62aeec11da29766b30d500f2b9a96f1f28cf0 (patch)
tree07e79783508681aeccf9302752032085aea940a0 /docs
parent5b4cc6c9d5b4004be8369852e5f9cfe4e81200df (diff)
parent2daa4ab522385bcf4c3498a65219424dc7f35458 (diff)
downloaddexon-tests-2cd62aeec11da29766b30d500f2b9a96f1f28cf0.tar.gz
dexon-tests-2cd62aeec11da29766b30d500f2b9a96f1f28cf0.tar.zst
dexon-tests-2cd62aeec11da29766b30d500f2b9a96f1f28cf0.zip
Merge pull request #533 from ethereum/blockchain-test-format-doc-updatesv6.0.0-beta.1
Blockchain test format doc updates on seal engine type
Diffstat (limited to 'docs')
-rw-r--r--docs/test_types/blockchain_tests.rst40
-rw-r--r--docs/using-testeth.rst6
2 files changed, 22 insertions, 24 deletions
diff --git a/docs/test_types/blockchain_tests.rst b/docs/test_types/blockchain_tests.rst
index c9b6dd359..cb4e9ab94 100644
--- a/docs/test_types/blockchain_tests.rst
+++ b/docs/test_types/blockchain_tests.rst
@@ -39,6 +39,8 @@ The client is expected to iterate through the list of blocks and ignore invalid
Test Structure
--------------
+For a formal structure definition see also the related `JSON Schema <https://github.com/ethereum/tests/blob/develop/JSONSchema/bc-schema.json>`_ in the repo.
+
::
{
@@ -63,31 +65,12 @@ Test Structure
"lastblockhash": " ... ",
"network": "Byzantium",
"postState": { ... },
- "pre": { ... }
+ "pre": { ... },
+ "sealEngine": [ "NoProof" | "Ethash" ]
},
"TESTNAME_EIP150": {
- "blocks" : [
- {
- "blockHeader": { ... },
- "rlp": { ... },
- "transactions": { ... },
- "uncleHeaders": { ... }
- },
- {
- "blockHeader": { ... },
- "rlp": { ... },
- "transactions": { ... },
- "uncleHeaders": { ... }
- },
- { ... }
- ],
- "genesisBlockHeader": { ... },
- "genesisRLP": " ... ",
- "lastblockhash": " ... ",
- "network": "Byzantium",
- "postState": { ... },
- "pre": { ... }
- },
+ ...
+ }
...
}
@@ -160,6 +143,17 @@ Pre and postState Sections
* ``postState`` section: as described in :ref:`state_tests` (section - post).
+Seal Engine
+^^^^^^^^^^^
+
+The ``sealEngine`` parameter (values: ``NoProof`` | ``Ethash``) defines the seal engine the
+test is generated with. For tests with a value ``NoProof`` you can skip block validation
+which will speed up test execution. Note that this also means that you cannot rely on
+``PoW`` specific block header values (``mixHash``, ``nonce``) for tests labelled this way.
+
+Currently this field is optional and there are still tests with no ``sealEngine`` parameter
+with the default here being the ``NoProof`` setting. So make sure to first check on parameter
+existence in your implementation.
Optional BlockHeader Information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/docs/using-testeth.rst b/docs/using-testeth.rst
index b725b8746..1395447ad 100644
--- a/docs/using-testeth.rst
+++ b/docs/using-testeth.rst
@@ -4,7 +4,11 @@ Test Creation
Instructions on how to create tests and how to use the cpp-client ``testeth`` tool
can be found in the c++ documentation
-`test generation chapter <https://github.com/ethereum/cpp-ethereum/blob/develop/doc/generating_tests.rst>`_.
+`test generation chapter <https://github.com/ethereum/aleth/blob/master/doc/generating_tests.rst>`_.
+
+Since docker images pointed to in the test generation docs are often outdated, you will probably
+have to rely on your own `source build <https://github.com/ethereum/aleth/#building-from-source>`_ of the Aleth C++
+Ethereum client for generating tests (start this early on since this is taking some time).