aboutsummaryrefslogtreecommitdiffstats
path: root/rlp/doc.go
diff options
context:
space:
mode:
authorobscuren <geffobscura@gmail.com>2014-11-17 19:13:11 +0800
committerobscuren <geffobscura@gmail.com>2014-11-17 19:13:11 +0800
commitcad770c73412c4b27d00c98ae3c531b9d1bcc091 (patch)
tree352728724e8e2985f0621c589c6acbf1193d3b16 /rlp/doc.go
parent33afb10b0da43d55b1d6e1fe6b1b97c6ff8d8f75 (diff)
parentb4e47a094c3f33011cb20b4cb5d3a966d823edbd (diff)
downloadgo-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.tar
go-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.tar.gz
go-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.tar.bz2
go-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.tar.lz
go-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.tar.xz
go-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.tar.zst
go-tangerine-cad770c73412c4b27d00c98ae3c531b9d1bcc091.zip
Merge branch 'develop' of github.com-obscure:ethereum/go-ethereum into develop
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