aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorholgerd77 <Holger.Drewes@gmail.com>2017-08-31 02:00:48 +0800
committerholgerd77 <Holger.Drewes@gmail.com>2017-08-31 02:00:48 +0800
commitb0425dc87ab3556d020b2e76980bfe516e7b4b84 (patch)
tree6fff5ae916c71d5e47f51d156483d840a0d11ffb /docs
parentce9d58f24f5d688c1d62ec79b903b3ba1a80e9f6 (diff)
downloaddexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.tar
dexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.tar.gz
dexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.tar.bz2
dexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.tar.lz
dexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.tar.xz
dexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.tar.zst
dexon-tests-b0425dc87ab3556d020b2e76980bfe516e7b4b84.zip
Updated rlp tests structure
Diffstat (limited to 'docs')
-rw-r--r--docs/rlp_tests/index.rst30
1 files changed, 20 insertions, 10 deletions
diff --git a/docs/rlp_tests/index.rst b/docs/rlp_tests/index.rst
index 154bd5890..2d812aae6 100644
--- a/docs/rlp_tests/index.rst
+++ b/docs/rlp_tests/index.rst
@@ -4,23 +4,33 @@ RLP Tests
=========
Describes an **RLP** (https://github.com/ethereum/wiki/wiki/RLP) encoding using
-the .json file. The client should read the rlp byte stream, **decode** and check
+the .json file.
+
+=================== ==============================================================
+Location `/RLPTests <https://github.com/ethereum/tests/tree/develop/RLPTests>`_
+Supported Hardforks Hardfork-independent
+Status Actively supported
+=================== ==============================================================
+
+
+Test Implementation
+-------------------
+
+The client should read the rlp byte stream, **decode** and check
whether the contents match its json representation. Then it should try do it
reverse - **encode** json rlp representation into rlp byte stream and check whether
it matches the given rlp byte stream.
-If it is an invalid RLP byte stream in the test, then 'in' field would contain string 'INVALID'
+If it is an invalid RLP byte stream in the test, then 'in' field would contain string ``INVALID``.
Some RLP byte streams are expected to be generated by fuzz test suite. For those
-examples 'in' field would contain string 'VALID' as it means that rlp should be easily decoded.
-
-RLP tests are located in in ``/RLPTests``
+examples 'in' field would contain string ``VALID`` as it means that rlp should be easily decoded.
-**Note** that RLP tests are testing a single RLP object encoding. Not a stream of
+**Note** that RLP tests are testing a single RLP object encoding and not a stream of
RLP objects in one array.
-Basic structure
----------------
+Test Structure
+--------------
::
@@ -48,7 +58,7 @@ Basic structure
}
Sections
---------
+^^^^^^^^
-* ``in`` - json object (array, int, string) representation of the rlp byte stream (\*except values 'VALID' and 'INVALID')
+* ``in`` - json object (array, int, string) representation of the rlp byte stream (\*except values ``VALID`` and ``INVALID``)
* ``out`` - string of rlp bytes stream