diff options
| author | Felix Lange <fjl@twurst.com> | 2014-11-14 03:31:48 +0800 |
|---|---|---|
| committer | Felix Lange <fjl@twurst.com> | 2014-11-17 08:49:47 +0800 |
| commit | 74266d5bbd95ac07882b09230aec876bf7704f69 (patch) | |
| tree | 101cd83defc7d396f42500bbf080243fb8571acf /rlp/doc.go | |
| parent | 9509322ecd8e709ce8a17442836b6ff15ba2edff (diff) | |
| download | go-tangerine-74266d5bbd95ac07882b09230aec876bf7704f69.tar.gz go-tangerine-74266d5bbd95ac07882b09230aec876bf7704f69.tar.zst go-tangerine-74266d5bbd95ac07882b09230aec876bf7704f69.zip | |
rlp: new package for streaming RLP decoder
Diffstat (limited to 'rlp/doc.go')
| -rw-r--r-- | rlp/doc.go | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/rlp/doc.go b/rlp/doc.go new file mode 100644 index 000000000..aab98ea43 --- /dev/null +++ b/rlp/doc.go @@ -0,0 +1,17 @@ +/* +Package rlp implements the RLP serialization format. + +The purpose of RLP (Recursive Linear Prefix) qis to encode arbitrarily +nested arrays of binary data, and RLP is the main encoding method used +to serialize objects in Ethereum. The only purpose of RLP is to encode +structure; encoding specific atomic data types (eg. strings, ints, +floats) is left up to higher-order protocols; in Ethereum integers +must be represented in big endian binary form with no leading zeroes +(thus making the integer value zero be equivalent to the empty byte +array). + +RLP values are distinguished by a type tag. The type tag precedes the +value in the input stream and defines the size and kind of the bytes +that follow. +*/ +package rlp |