#rlp #serde #data #implemented #ethereum #format

serde-rlp

Ethereum's RLP encoding implemented as a Serde data format

5 releases

Uses old Rust 2015

0.1.4 Sep 21, 2018
0.1.3 Sep 14, 2018
0.1.2 Sep 4, 2018
0.1.1 Sep 4, 2018
0.1.0 Sep 4, 2018

#2390 in Encoding

Download history 28/week @ 2024-11-13 52/week @ 2024-11-20 62/week @ 2024-11-27 90/week @ 2024-12-04 108/week @ 2024-12-11 39/week @ 2024-12-18 4/week @ 2024-12-25 47/week @ 2025-01-01 42/week @ 2025-01-08 72/week @ 2025-01-15 74/week @ 2025-01-22 71/week @ 2025-01-29 81/week @ 2025-02-05 50/week @ 2025-02-12 77/week @ 2025-02-19 53/week @ 2025-02-26

294 downloads per month
Used in 16 crates (via raiden-network-messages)

Custom license

38KB
1K SLoC

serde-rlp

Crates.io Build Status Docs.rs

Ethereum's RLP encoding implemented as a Serde data format

This code is part of clarity - an effort to implement lightweight Ethereum transaction signing. WIP.

Releasing

To release new version of serde-rlp do the following steps:

# Do a signed tag for new version with annotation "YYYY-MM-DD, Version v$VERSION"
git tag v1.0.0 -a -s "2018-09-04, Version v1.0.0"
git push origin --follow-tags

Examples

You should be able to use this crate same way as you'd use other serialization formats in serde.

Serialize

The key to serialization is serde_rlp::ser::to_bytes which does the magic.

extern crate serde_rlp;
use serde_rlp::ser::to_bytes;

// Basic key values
let data = vec![vec!["key1", "value1"], vec!["key2", "value2"]];
let bytes = to_bytes(&data).expect("Unable to serialize data");
println!("Serialized data: {:?}", bytes);

Deserialize

To deserialize data back into an object you should use serde_rlp::de::from_bytes.

extern crate serde_rlp;
use serde_rlp::de::from_bytes;

// Deserialize string "abc" encoded as RLP
let foo: String = from_bytes(&[0x83, 0x61, 0x62, 0x63]).unwrap();
println!("{}", foo);

An useful pattern is to deserialize into Vec<Bytes>, which will correctly deserialize elements of a RLP list.

Dependencies

~0.6–1MB
~19K SLoC