Recursive-length prefix (RLP) serialization (original) (raw)

Recursive Length Prefix (RLP) serialization is used extensively in Ethereum's execution clients. RLP standardizes the transfer of data between nodes in a space-efficient format. The purpose of RLP is to encode arbitrarily nested arrays of binary data, and RLP is the primary encoding method used to serialize objects in Ethereum's execution layer. The main purpose of RLP is to encode structure; with the exception of positive integers, RLP delegates encoding specific data types (e.g. strings, floats) to higher-order protocols. Positive integers must be represented in big-endian binary form with no leading zeroes (thus making the integer value zero equivalent to the empty byte array). Deserialized positive integers with leading zeroes must be treated as invalid by any higher-order protocol using RLP.

More information in the Ethereum yellow paper (Appendix B)(opens in a new tab).

To use RLP to encode a dictionary, the two suggested canonical forms are:

use [[k1,v1],[k2,v2]...] with keys in lexicographic order
use the higher-level Patricia Tree encoding as Ethereum does

Definition

The RLP encoding function takes in an item. An item is defined as follows：

a string (i.e. byte array) is an item
a list of items is an item
a positive integer is an item

For example, all of the following are items:

an empty string;
the string containing the word "cat";
a list containing any number of strings;
and a more complex data structures like ["cat", ["puppy", "cow"], "horse", [[]], "pig", [""], "sheep"].
the number 100

Note that in the context of the rest of this page, 'string' means "a certain number of bytes of binary data"; no special encodings are used, and no knowledge about the content of the strings is implied (except as required by the rule against non-minimal positive integers).

RLP encoding is defined as follows:

For a positive integer, it is converted to the shortest byte array whose big-endian interpretation is the integer, and then encoded as a string according to the rules below.
For a single byte whose value is in the [0x00, 0x7f] (decimal [0, 127]) range, that byte is its own RLP encoding.
Otherwise, if a string is 0-55 bytes long, the RLP encoding consists of a single byte with value 0x80 (dec. 128) plus the length of the string followed by the string. The range of the first byte is thus [0x80, 0xb7] (dec. [128, 183]).
If a string is more than 55 bytes long, the RLP encoding consists of a single byte with value 0xb7 (dec. 183) plus the length in bytes of the length of the string in binary form, followed by the length of the string, followed by the string. For example, a 1024 byte long string would be encoded as \xb9\x04\x00 (dec. 185, 4, 0) followed by the string. Here, 0xb9 (183 + 2 = 185) as the first byte, followed by the 2 bytes 0x0400 (dec. 1024) that denote the length of the actual string. The range of the first byte is thus [0xb8, 0xbf] (dec. [184, 191]).
If a string is 2^64 bytes long, or longer, it may not be encoded.
If the total payload of a list (i.e. the combined length of all its items being RLP encoded) is 0-55 bytes long, the RLP encoding consists of a single byte with value 0xc0 plus the length of the payload followed by the concatenation of the RLP encodings of the items. The range of the first byte is thus [0xc0, 0xf7] (dec. [192, 247]).
If the total payload of a list is more than 55 bytes long, the RLP encoding consists of a single byte with value 0xf7 plus the length in bytes of the length of the payload in binary form, followed by the length of the payload, followed by the concatenation of the RLP encodings of the items. The range of the first byte is thus [0xf8, 0xff] (dec. [248, 255]).

In code, this is:

1def rlp_encode(input):

2 if isinstance(input,str):

3 if len(input) == 1 and ord(input) < 0x80:

4 return input

5 return encode_length(len(input), 0x80) + input

6 elif isinstance(input, list):

7 output = ''

8 for item in input:

9 output += rlp_encode(item)

10 return encode_length(len(output), 0xc0) + output

12def encode_length(L, offset):

13 if L < 56:

14 return chr(L + offset)

15 elif L < 256**8:

16 BL = to_binary(L)

17 return chr(len(BL) + offset + 55) + BL

18 raise Exception("input too long")

20def to_binary(x):

21 if x == 0:

22 return ''

23 return to_binary(int(x / 256)) + chr(x % 256)

Examples

the string "dog" = [ 0x83, 'd', 'o', 'g' ]
the list [ "cat", "dog" ] = [ 0xc8, 0x83, 'c', 'a', 't', 0x83, 'd', 'o', 'g' ]
the empty string ('null') = [ 0x80 ]
the empty list = [ 0xc0 ]
the integer 0 = [ 0x80 ]
the byte '\x00' = [ 0x00 ]
the byte '\x0f' = [ 0x0f ]
the bytes '\x04\x00' = [ 0x82, 0x04, 0x00 ]
the set theoretical representation(opens in a new tab) of three, [ [], [[]], [ [], [[]] ] ] = [ 0xc7, 0xc0, 0xc1, 0xc0, 0xc3, 0xc0, 0xc1, 0xc0 ]
the string "Lorem ipsum dolor sit amet, consectetur adipisicing elit" = [ 0xb8, 0x38, 'L', 'o', 'r', 'e', 'm', ' ', ... , 'e', 'l', 'i', 't' ]

RLP decoding

According to the rules and process of RLP encoding, the input of RLP decode is regarded as an array of binary data. The RLP decoding process is as follows:

according to the first byte (i.e. prefix) of input data and decoding the data type, the length of the actual data and offset;
according to the type and offset of data, decode the data correspondingly, respecting the minimal encoding rule for positive integers;
continue to decode the rest of the input;

Among them, the rules of decoding data types and offset is as follows:

the data is a string if the range of the first byte (i.e. prefix) is [0x00, 0x7f], and the string is the first byte itself exactly;
the data is a string if the range of the first byte is [0x80, 0xb7], and the string whose length is equal to the first byte minus 0x80 follows the first byte;
the data is a string if the range of the first byte is [0xb8, 0xbf], and the length of the string whose length in bytes is equal to the first byte minus 0xb7 follows the first byte, and the string follows the length of the string;
the data is a list if the range of the first byte is [0xc0, 0xf7], and the concatenation of the RLP encodings of all items of the list which the total payload is equal to the first byte minus 0xc0 follows the first byte;
the data is a list if the range of the first byte is [0xf8, 0xff], and the total payload of the list whose length is equal to the first byte minus 0xf7 follows the first byte, and the concatenation of the RLP encodings of all items of the list follows the total payload of the list;

In code, this is:

1def rlp_decode(input):

2 if len(input) == 0:

3 return

4 output = ''

5 (offset, dataLen, type) = decode_length(input)

6 if type is str:

7 output = instantiate_str(substr(input, offset, dataLen))

8 elif type is list:

9 output = instantiate_list(substr(input, offset, dataLen))

10 output += rlp_decode(substr(input, offset + dataLen))

11 return output

13def decode_length(input):

14 length = len(input)

15 if length == 0:

16 raise Exception("input is null")

17 prefix = ord(input[0])

18 if prefix <= 0x7f:

19 return (0, 1, str)

20 elif prefix <= 0xb7 and length > prefix - 0x80:

21 strLen = prefix - 0x80

22 return (1, strLen, str)

23 elif prefix <= 0xbf and length > prefix - 0xb7 and length > prefix - 0xb7 + to_integer(substr(input, 1, prefix - 0xb7)):

24 lenOfStrLen = prefix - 0xb7

25 strLen = to_integer(substr(input, 1, lenOfStrLen))

26 return (1 + lenOfStrLen, strLen, str)

27 elif prefix <= 0xf7 and length > prefix - 0xc0:

28 listLen = prefix - 0xc0;

29 return (1, listLen, list)

30 elif prefix <= 0xff and length > prefix - 0xf7 and length > prefix - 0xf7 + to_integer(substr(input, 1, prefix - 0xf7)):

31 lenOfListLen = prefix - 0xf7

32 listLen = to_integer(substr(input, 1, lenOfListLen))

33 return (1 + lenOfListLen, listLen, list)

34 raise Exception("input does not conform to RLP encoding form")

36def to_integer(b):

37 length = len(b)

38 if length == 0:

39 raise Exception("input is null")

40 elif length == 1:

41 return ord(b[0])

42 return ord(substr(b, -1)) + to_integer(substr(b, 0, -1)) * 256

Recursive-length prefix (RLP) serialization (original) (raw)

Definition

Examples

RLP decoding

Further reading

Was this article helpful?