aboutsummaryrefslogtreecommitdiffstats
path: root/docs/rlp_tests/index.rst
diff options
context:
space:
mode:
authorYoichi Hirai <i@yoichihirai.com>2017-08-31 20:01:56 +0800
committerGitHub <noreply@github.com>2017-08-31 20:01:56 +0800
commitf93e53ddcf5220dceb9f22222e55b54ab90ddf8f (patch)
tree8b0b253d62286073b506c253a7007391fc0a87a8 /docs/rlp_tests/index.rst
parent2bf539099e93b87aa0149065f0bc0e60aa6811b9 (diff)
parent047ea6801d058a6bd58f0f7a3d4aaa6d659684a7 (diff)
downloadtangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.tar
tangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.tar.gz
tangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.tar.bz2
tangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.tar.lz
tangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.tar.xz
tangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.tar.zst
tangerine-tests-f93e53ddcf5220dceb9f22222e55b54ab90ddf8f.zip
Merge pull request #292 from holgerd77/update-docs
Structural overhaul of the whole docs / Updated state test section / info box on test type status
Diffstat (limited to 'docs/rlp_tests/index.rst')
-rw-r--r--docs/rlp_tests/index.rst50
1 files changed, 0 insertions, 50 deletions
diff --git a/docs/rlp_tests/index.rst b/docs/rlp_tests/index.rst
deleted file mode 100644
index 00ba3dc7b..000000000
--- a/docs/rlp_tests/index.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-.. _rlp_tests:
-
-################################################################################
-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 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'
-
-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``
-
-**Note** that RLP tests are testing a single RLP object encoding. Not a stream of RLP objects in one array.
-
-Basic structure
---------------------------------------------------------------------------------
-
-::
-
- {
- "rlpTest": {
- "in": "dog",
- "out": "83646f67"
- },
-
- "multilist": {
- "in": [ "zw", [ 4 ], 1 ],
- "out": "c6827a77c10401"
- },
-
- "validRLP": {
- "in": "VALID",
- "out": "c7c0c1c0c3c0c1c0"
- },
-
- "invalidRLP": {
- "in": "INVALID",
- "out": "bf0f000000000000021111"
- },
- ...
- }
-
-Sections
---------------------------------------------------------------------------------
-
-* ``in`` - json object (array, int, string) representation of the rlp byte stream (\*except values 'VALID' and 'INVALID')
-* ``out`` - string of rlp bytes stream