Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 2.28 KB

README.md

File metadata and controls

63 lines (48 loc) · 2.28 KB
Raw

rlp-rs

RLP Encode / Decode arbitrary bytes

Benches

1000 access list block decode with 2 tx
                        time:   [3.0907 ms 3.0932 ms 3.0958 ms]

1M bloom decode         time:   [49.896 ms 49.930 ms 49.964 ms]

1000 dynamic fee block decode with 2 tx
                        time:   [3.1349 ms 3.1378 ms 3.1407 ms]

1000 legacy block decode with 1 tx
                        time:   [1.8447 ms 1.8478 ms 1.8524 ms]

100 legacy block headers
                        time:   [66.384 µs 66.479 µs 66.578 µs]

nested list serialization
                        time:   [3.9982 ms 4.0036 ms 4.0090 ms]

Features

  • Serde integration

Limitations

  • Unimplemented on:

    • Map
    • Option

  • Rust doesn't support specialization yet. For this reason, use serde_bytes when annotating data that needs to be interpreter as bytes. For an example, look at Transaction. Reading material: https://serde.rs/impl-serialize.html#other-special-cases Additionally, serde_bytes had to be forked because there is no hard requirement on the size of bytes in the RLP representation. For instance, all zeros are removed to save some space. That means that serde_bytes has to be a bit more forgiving regarding arrays, it has been patched to prepend these 0 manually when deserializing to an array.

  • Because of the caveats of some Ethereum structure:

    • No representation of Option, although the block may have additional fields
    • Transaction envelope contains a prefix byte for all transactions besides the Legacy one

    The deserialization sometimes has to be implemented manually. Some rudimentary parsing of the "raw rlp" which is represented by the Rlp struct is provided. You can see the implementation of Block::from_bytes.

TODO

  • Finish implementing serde
  • Tests for trailing bytes
  • Better serde error handling
  • Reorder functions around
  • Better API with nice parsing functions
  • Benches, check if we can beat geth and fastrlp https://github.com/umbracle/fastrlp?tab=readme-ov-file#benchmark
  • Fuzz ser/de for corectness
  • Provide RLP-ready useful types
    • Add a crate types
    • Transaction
    • Block
    • Receipt
    • Provide conversions from popular lib types from this crate