aboutsummaryrefslogtreecommitdiffstats
path: root/rlp/doc.go
diff options
context:
space:
mode:
authorobscuren <geffobscura@gmail.com>2014-12-20 09:34:12 +0800
committerobscuren <geffobscura@gmail.com>2014-12-20 09:34:12 +0800
commit3983dd2428137211f84f299f9ce8690c22f50afd (patch)
tree3a2dc53b365e6f377fc82a3514150d1297fe549c /rlp/doc.go
parent7daa8c2f6eb25511c6a54ad420709af911fc6748 (diff)
parent0a9dc1536c5d776844d6947a0090ff7e1a7c6ab4 (diff)
downloadgo-tangerine-vv0.7.10.tar
go-tangerine-vv0.7.10.tar.gz
go-tangerine-vv0.7.10.tar.bz2
go-tangerine-vv0.7.10.tar.lz
go-tangerine-vv0.7.10.tar.xz
go-tangerine-vv0.7.10.tar.zst
go-tangerine-vv0.7.10.zip
Merge branch 'release/v0.7.10'vv0.7.10
Diffstat (limited to 'rlp/doc.go')
-rw-r--r--rlp/doc.go17
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