再帰的な長さのプレフィックス(RLP)シリアライゼーション

再帰的な長さのプレフィックス(RLP)シリアライゼーションは、イーサリアムの実行クライアントで広く使われています。 RLPはスペース効率に優れたフォーマットで、ノード間のデータ転送を標準化します。 RLPの目的は、任意のネストされたバイナリデータの配列をエンコード(符号化)することです。また、RLPはイーサリアムの実行レイヤーのオブジェクトのシリアライズに用いられる主要なエンコーディング方式です。 RLPの主な目的は、構造をエンコードすることです。正の整数を除いて、RLPは特定のデータ型(例: 文字列、浮動小数点など)のエンコードを上位のプロトコルに任せます。 正の整数は、先頭にゼロのないビックエンディアンのバイナリ形式で表現する必要があります(そのため、整数値のゼロは空のバイト配列と等価です)。 RLPを使う上位のプロトコルは、デシリアライズ化された先頭がゼロの正の整数を無効として扱わなければなりません。

詳細については、イーサリアムイエローペーパー (付録B)(opens in a new tab)を参照してください。

RLPを使用して辞書をエンコードするのに、次の2つの正規の方法があります。

• [[k1,v1],[k2,v2]...]のように辞書順にキーを並べて使用する
• イーサリアムのように上位レベルのパトリシア・ツリー・エンコーディングを使用する

定義

RLPエンコーディング関数は、アイテムを取ります。 アイテムは次のように定義されます。

• 文字列型(すなわちバイト配列) はアイテム
• アイテムのリストはアイテム
• 正の整数はアイテム

例えば、次はすべてアイテムです。

• 空文字列
• 「cat」という単語を含む文字列
• 任意の数の文字列を含むリスト
• 次のような、より複雑なデータ構造 ["cat", ["puppy", "cow"], "horse", [[]], "pig", [""], "sheep"]
• 数字の100

本ページのこれ以降では、「文字列」は「あるバイト数のバイナリデータ」を意味することに注意してください。特別なエンコーディングは使用されておらず、文字列が何を指すのかの知識は必要ありません(最小でない正の整数に対する規則で要求されていない場合を除く)。

RLPエンコーディングは以下のように定義されます。

• 正の整数では、ビックエンディアンを整数として解釈した最短のバイト配列に変換されます。そして、次に以下の規則に従って文字列としてエンコードします。
• [0x00, 0x7f](10進数[0, 127])の範囲にある1バイトは、そのバイト自体がRLPエンコーディングとなる。
• その他、文字列が0～55バイトの場合、RLPエンコーディングは値が0x80(10進数128)に、文字列の長さを足した1バイト、続いて文字列で構成される。 したがって、最初の1バイトの範囲は[0x80, 0xb7](10進数[128, 183])となる。
• 文字列の長さが55バイトを超える場合、RLPエンコーディングは、0xb7(10進数 183)にバイナリ形式の文字列長をバイト数を加えた1バイト、続けて文字列の長さ、次に文字列で構成される。 例えば、1024バイトの長さの文字列は、\xb9\x04\x00 (10進数185, 4, 0)にエンコードされ、その後文字列となる。 ここでは、最初の1バイトとして0xb9 (183 + 2 = 185)、次に実際の文字列の長さを示す2バイトの0x0400 (10進数1024)が続く。 したがって、最初の1バイトの範囲は、[0xb8, 0xbf] (10進数[184, 191])となる。
• 文字列が2^64バイト長以上の場合、エンコードされない可能性があります。
• リストの全ペイロード(例えば、RLPエンコードされるすべてのアイテムを合わせた長さ)が0～55バイトである場合、RLPエンコーディングは、0xc0にペイロードの長さを加えた1バイト、続けてアイテムをRLPエンコーディングして続けたもので構成される。 したがって、最初のバイトの範囲は[0xc0, 0xf7] (10進数[192, 247])となる。
• リストの全ペイロードが、55バイトを超える場合、RLPエンコーディングは、0xf7にバイナリ形式のペイロードの長さのバイト数を加えた1バイト、次にペイロードの長さ、アイテムのRLPエンコーディングしたものを続けたもので構成される。 したがって、最初のバイトの範囲は、[0xf8, 0xff] (10進数[248, 255])となる 。

コードでは、これは次のようになります。

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
11
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")
19
20def to_binary(x):
21    if x == 0:
22        return ''
23    return to_binary(int(x / 256)) + chr(x % 256)
すべて表示
 コピー

いくつかの例

• 文字列「dog」= [ 0x83, 'd', 'o', 'g' ]
• リスト [ "cat", "dog" ] = [ 0xc8, 0x83, 'c', 'a', 't', 0x83, 'd', 'o', 'g' ]
• 空文字列 ('null') = [ 0x80 ]
• 空リスト = [ 0xc0 ]
• 整数0 = [ 0x80 ]
• バイト '\x00' = [ 0x00 ]
• バイト '\x0f' = [ 0x0f ]
• バイト '\x04\x00' = [ 0x82, 0x04, 0x00 ]
• 3の集合論的表現(opens in a new tab) [ [], [[]], [ [], [[]] ] ] = [ 0xc7, 0xc0, 0xc1, 0xc0, 0xc3, 0xc0, 0xc1, 0xc0 ]
• 文字列「Lorem ipsum dolor sit amet, consectetur adipisicing elit」= [ 0xb8, 0x38, 'L', 'o', 'r', 'e', 'm', ' ', ... , 'e', 'l', 'i', 't' ]

RLPデコーディング

RLPエンコーディング規則とプロセスに従って、RLPデコードの入力は、バイナリデータ配列とみなされます。 RLPのデコーディングプロセスは、次のようになります。

1. 入力データの最初のバイト(プレフィックス) とデコーディングするデータ型に従った実際のデータ長とオフセット

2. データのタイプおよびオフセットに応じて、正の整数に関する最小エンコード規則に従って、対応するデータをデコードします。

3. 残りの入力のデコードを続行

その中で、データ型とオフセットのデコード規則は次のようになります。

1. 最初の1バイト(プレフィックス)の範囲が [0x00, 0x7f]の場合は、データは文字列型で、文字列はそのバイトそのもの。

2. 最初の1バイトの範囲が[0x80, 0xb7]の場合、データは文字列型。最初の1バイト、続いて最初の1バイトから 0x80 を引いた長さの文字列となる。

3. 最初の1バイトの範囲が[0xb8, 0xbf]の場合は、データは文字列型。最初の1バイト、続いて最初の1バイトから0xb7を引いた文字列長(バイトで表す)、最後に文字列となる。

4. 最初の1バイトの範囲が[0xc0, 0xf7]の場合は、データはリスト型。最初の1バイト、続いて全ペイロードが最初のバイトから0xc0を引いたものに等しい、リストの全アイテムをRLPエンコーディングして続けたものとなる。

5. 最初の1バイトの範囲が[0xf8, 0xff]の場合は、データはリスト型。最初の1バイト、続いてリストの長さが最初の1バイトから0xf7を引いたリストの全ペイロード、最後にリストのすべてのアイテムをRLPエンコーディングして続けたものとなる。

コードでは、これは次のようになります。

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
12
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")
35
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
すべて表示
 コピー

参考文献

• イーサリアムのRLP(opens in a new tab)
• イーサリアムの内部: RLP(opens in a new tab)
• Coglio, A. (2020). ACL2のイーサリアムの再帰的な長さのプレフィックス arXiv preprint arXiv:2009.13769.(opens in a new tab)

関連トピック

• パトリシア・マークル・ツリー