aboutsummaryrefslogtreecommitdiffstats
path: root/rlp/doc.go
diff options
context:
space:
mode:
authorobscuren <geffobscura@gmail.com>2014-11-17 19:14:05 +0800
committerobscuren <geffobscura@gmail.com>2014-11-17 19:14:05 +0800
commita19d2c22782fa85cd38de246d9801fa1ebd0660a (patch)
tree2020199607d4cd9c2900f521e5a70ebda34e35ef /rlp/doc.go
parentca74bcc4cdf389b5ef5520f9ab5a7aec08424f30 (diff)
parentcad770c73412c4b27d00c98ae3c531b9d1bcc091 (diff)
downloadgo-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.tar
go-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.tar.gz
go-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.tar.bz2
go-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.tar.lz
go-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.tar.xz
go-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.tar.zst
go-tangerine-a19d2c22782fa85cd38de246d9801fa1ebd0660a.zip
Merge branch 'develop' into refactor
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