Blockchain.Data.RLP

The RLP module provides a framework within which serializers can be built, described in the Ethereum Yellowpaper (http://gavwood.com/paper.pdf).

The RLPObject is an intermediate data container, whose serialization rules are well defined. By creating code that converts from a given type to an RLPObject, full serialization will be specified. The RLPSerializable class provides functions to do this conversion.

Documentation

data RLPObject

An internal representation of generic data, with no type information.

End users will not need to directly create objects of this type (an RLPObject can be created using rlpEncode), however the designer of a new type will need to create conversion code by making their type an instance of the RLPSerializable class.

Constructors

RLPScalar Word8

RLPString ByteString

RLPArray [RLPObject]

Instances

Eq RLPObject

Methods

(==) :: RLPObject -> RLPObject -> Bool

(/=) :: RLPObject -> RLPObject -> Bool

Ord RLPObject

Methods

compare :: RLPObject -> RLPObject -> Ordering

(<) :: RLPObject -> RLPObject -> Bool

(<=) :: RLPObject -> RLPObject -> Bool

(>) :: RLPObject -> RLPObject -> Bool

(>=) :: RLPObject -> RLPObject -> Bool

max :: RLPObject -> RLPObject -> RLPObject

min :: RLPObject -> RLPObject -> RLPObject

Show RLPObject

Methods

showsPrec :: Int -> RLPObject -> ShowS

show :: RLPObject -> String

showList :: [RLPObject] -> ShowS

Pretty RLPObject

Methods

pretty :: RLPObject -> Doc

prettyList :: [RLPObject] -> Doc

formatRLPObject :: RLPObject -> String

class RLPSerializable a where

Converts objects to and from RLPObjects.

Minimal complete definition

rlpDecode, rlpEncode

Methods

rlpDecode :: RLPObject -> a

rlpEncode :: a -> RLPObject

Instances

RLPSerializable Integer

Methods

rlpDecode :: RLPObject -> Integer

rlpEncode :: Integer -> RLPObject

RLPSerializable ByteString

Methods

rlpDecode :: RLPObject -> ByteString

rlpEncode :: ByteString -> RLPObject

RLPSerializable String

Methods

rlpDecode :: RLPObject -> String

rlpEncode :: String -> RLPObject

RLPSerializable Code

Methods

rlpDecode :: RLPObject -> Code

rlpEncode :: Code -> RLPObject

rlpSplit :: ByteString -> (RLPObject, ByteString)

rlpSerialize :: RLPObject -> ByteString

Converts RLPObjects to bytes.

Full serialization of an object can be obtained using rlpSerialize . rlpEncode.

rlpDeserialize :: ByteString -> RLPObject

Converts bytes to RLPObjects.

Full deserialization of an object can be obtained using rlpDecode . rlpDeserialize.