Blockchain.Database.MerklePatricia.Internal

Documentation

type Key = NibbleString

The type of the database key

type Val = RLPObject

The type of the values in the database

data MPDB

This is the database reference type, contianing both the handle to the underlying database, as well as the stateRoot to the current tree holding the data.

The MPDB acts a bit like a traditional database handle, although because it contains the stateRoot, many functions act by updating its value. Because of this, it is recommended that this item be stored and modified within the state monad.

Constructors

MPDB

Fields

• ldb :: DB
• stateRoot :: StateRoot

Instances

(Monad m, MonadBaseControl IO m, MonadThrow m, MonadIO m) => PointedKeyValDB (KeyValMPLevelDB m) Key Val MPDB String

Methods

getKV :: Key -> KeyValMPLevelDB m (Maybe Val)

putKV :: (Key, Val) -> KeyValMPLevelDB m MPDB

deleteKV :: Key -> KeyValMPLevelDB m MPDB

emptyKV :: String -> KeyValMPLevelDB m MPDB

newtype StateRoot

Internal nodes are indexed in the underlying database by their 256-bit SHA3 hash. This types represents said hash.

The stateRoot is of this type, (ie- the pointer to the full set of key/value pairs at a particular time in history), and will be of interest if you need to refer to older or parallel version of the data.

Constructors

StateRoot ByteString

Instances

Eq StateRoot

Methods

(==) :: StateRoot -> StateRoot -> Bool

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

Read StateRoot

Methods

readsPrec :: Int -> ReadS StateRoot

readList :: ReadS [StateRoot]

readPrec :: ReadPrec StateRoot

readListPrec :: ReadPrec [StateRoot]

Show StateRoot

Methods

showsPrec :: Int -> StateRoot -> ShowS

show :: StateRoot -> String

showList :: [StateRoot] -> ShowS

IsString StateRoot

Methods

fromString :: String -> StateRoot

Generic StateRoot

Associated Types

type Rep StateRoot :: * -> *

Methods

from :: StateRoot -> Rep StateRoot x

to :: Rep StateRoot x -> StateRoot

Pretty StateRoot

Methods

pretty :: StateRoot -> Doc

prettyList :: [StateRoot] -> Doc

Binary StateRoot

Methods

put :: StateRoot -> Put

get :: Get StateRoot

putList :: [StateRoot] -> Put

RLPSerializable StateRoot

Methods

rlpDecode :: RLPObject -> StateRoot

rlpEncode :: StateRoot -> RLPObject

type Rep StateRoot

type Rep StateRoot = D1 (MetaData "StateRoot" "Blockchain.Database.MerklePatricia.StateRoot" "merkle-patricia-db-0.1.0-HehUr173YIm537XqKYO0YU" True) (C1 (MetaCons "StateRoot" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ByteString)))

data NodeData

Constructors

EmptyNodeData

FullNodeData

Fields

• choices :: [NodeRef]
• nodeVal :: Maybe Val

ShortcutNodeData

Fields

• nextNibbleString :: Key
• nextVal :: Either NodeRef Val

Instances

Eq NodeData

Methods

(==) :: NodeData -> NodeData -> Bool

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

Show NodeData

Methods

showsPrec :: Int -> NodeData -> ShowS

show :: NodeData -> String

showList :: [NodeData] -> ShowS

Pretty NodeData

Methods

pretty :: NodeData -> Doc

prettyList :: [NodeData] -> Doc

RLPSerializable NodeData

Methods

rlpDecode :: RLPObject -> NodeData

rlpEncode :: NodeData -> RLPObject

openMPDB

Arguments

:: String

The filepath with the location of the underlying database.

-> ResourceT IO MPDB

This function is used to create an MPDB object corresponding to the blank database. After creation, the stateRoot can be changed to a previously saved version.

emptyTriePtr :: StateRoot

The stateRoot of the empty database.

sha2StateRoot :: Digest Keccak_256 -> StateRoot

unboxStateRoot :: StateRoot -> ByteString

unsafePutKeyVal :: MonadResource m => MPDB -> Key -> Val -> m MPDB

unsafeGetKeyVals :: MonadResource m => MPDB -> Key -> m [(Key, Val)]

unsafeGetAllKeyVals :: MonadResource m => MPDB -> m [(Key, Val)]

unsafeDeleteKey :: MonadResource m => MPDB -> Key -> m MPDB

getNodeData :: MonadResource m => MPDB -> NodeRef -> m NodeData

putNodeData :: MonadResource m => MPDB -> NodeData -> m StateRoot

keyToSafeKey :: NibbleString -> NibbleString

getCommonPrefix :: Eq a => [a] -> [a] -> ([a], [a], [a])

replace :: Integral i => [a] -> i -> a -> [a]

prependToKey :: Key -> (Key, Val) -> (Key, Val)