diff options
Diffstat (limited to 'docs/rlp_tests/index.rst')
| -rw-r--r-- | docs/rlp_tests/index.rst | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/docs/rlp_tests/index.rst b/docs/rlp_tests/index.rst index 00ba3dc7b..154bd5890 100644 --- a/docs/rlp_tests/index.rst +++ b/docs/rlp_tests/index.rst @@ -1,22 +1,26 @@ .. _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. +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. +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. +**Note** that RLP tests are testing a single RLP object encoding. Not a stream of +RLP objects in one array. Basic structure --------------------------------------------------------------------------------- +--------------- :: @@ -44,7 +48,7 @@ Basic structure } Sections --------------------------------------------------------------------------------- +-------- * ``in`` - json object (array, int, string) representation of the rlp byte stream (\*except values 'VALID' and 'INVALID') * ``out`` - string of rlp bytes stream |