status-im
/
nim-eth
mirror of https://github.com/status-im/nim-eth.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Rlp readme corrections [skip ci]

This commit is contained in:
Kim De Mey 2020-03-25 21:23:50 +01:00 committed by GitHub
parent c3f23e5912
commit 8028966005
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/rlp.md
View File

@ -3,13 +3,13 @@
### Introduction ### Introduction
A Nim implementation of the Recursive Length Prefix encoding (RLP) as specified A Nim implementation of the Recursive Length Prefix encoding (RLP) as specified
in the Ethereum's [Yellow Papper](https://ethereum.github.io/yellowpaper/paper.pdf) in the Ethereum's [Yellow Paper](https://ethereum.github.io/yellowpaper/paper.pdf)
and [Wiki](https://github.com/ethereum/wiki/wiki/RLP). and [Wiki](https://github.com/ethereum/wiki/wiki/RLP).
### Reading RLP data ### Reading RLP data
The `Rlp` type provided by this library represents a cursor over a RLP-encoded The `Rlp` type provided by this library represents a cursor over an RLP-encoded
byte stream. Before instantiating such a cursor, you must convert your byte stream. Before instantiating such a cursor, you must convert your
input data a `BytesRange` value provided by the [nim-ranges][RNG] library, input data a `BytesRange` value provided by the [nim-ranges][RNG] library,
which represents an immutable and thus cheap-to-copy sub-range view over an which represents an immutable and thus cheap-to-copy sub-range view over an
@ -55,7 +55,7 @@ that is too large), the library will raise an `UnsupportedRlpError` exception.
### DOM API ### DOM API
Calling `Rlp.toNodes` at any position within the stream will return a tree Calling `Rlp.toNodes` at any position within the stream will return a tree
of `RlpNode` objects representing the collection of values begging at that of `RlpNode` objects representing the collection of values starting at that
position: position:
``` nim ``` nim
@ -137,5 +137,5 @@ achieve this.
### Contributing / Testing ### Contributing / Testing
To test the correctness of any modifications to the library, please execute To test the correctness of any modifications to the library, please execute
`nimble test` at the root of the repo. `nimble test_rlp` at the root of the repo.