Network.DFINITY.RadixTree

A generic data integrity layer.

Class

class Monad m => RadixDatabase config m database | database -> config where

Minimal complete definition

create, load, store

Methods

create :: config -> m database

load :: database -> ByteString -> m (Maybe ByteString)

store :: database -> ByteString -> ByteString -> m ()

Instances

MonadResource m => RadixDatabase (FilePath, Options) m DB

Defined in Network.DFINITY.RadixTree.Types

Methods

create :: (FilePath, Options) -> m DB

load :: DB -> ByteString -> m (Maybe ByteString)

store :: DB -> ByteString -> ByteString -> m ()

Types

type RadixRoot = ShortByteString

data RadixTree database

data RadixError

Constructors

InvalidArgument String

StateRootDoesNotExist RadixRoot

Instances

Eq RadixError

Defined in Network.DFINITY.RadixTree.Types

Methods

(==) :: RadixError -> RadixError -> Bool

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

Data RadixError

Defined in Network.DFINITY.RadixTree.Types

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RadixError -> c RadixError

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RadixError

toConstr :: RadixError -> Constr

dataTypeOf :: RadixError -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RadixError)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RadixError)

gmapT :: (forall b. Data b => b -> b) -> RadixError -> RadixError

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RadixError -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RadixError -> r

gmapQ :: (forall d. Data d => d -> u) -> RadixError -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RadixError -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RadixError -> m RadixError

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RadixError -> m RadixError

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RadixError -> m RadixError

Show RadixError

Defined in Network.DFINITY.RadixTree.Types

Methods

showsPrec :: Int -> RadixError -> ShowS

show :: RadixError -> String

showList :: [RadixError] -> ShowS

Exception RadixError

Defined in Network.DFINITY.RadixTree.Types

Methods

toException :: RadixError -> SomeException

fromException :: SomeException -> Maybe RadixError

displayException :: RadixError -> String

Create

createRadixTree

Arguments

:: RadixDatabase config m database

=> Int

Bloom filter size in bits.

-> Int

LRU cache size in items.

-> Maybe RadixRoot

Previous state root.

-> config

Database configuration.

-> m (RadixTree database)

Create a radix tree.

subtreeRadixTree

Arguments

:: RadixDatabase config m database

=> RadixRoot

State root.

-> RadixTree database

Radix tree.

-> m (RadixTree database)

Create a radix tree from a radix tree.

Insert

insertRadixTree

Arguments

:: RadixDatabase config m database

=> ByteString

Key.

-> ByteString

Value.

-> RadixTree database

Radix tree.

-> m (RadixTree database)

Insert a key and value into a radix tree.

Delete

deleteRadixTree

Arguments

:: RadixDatabase config m database

=> ByteString

Key.

-> RadixTree database

Radix tree.

-> m (RadixTree database)

Delete a value from a radix tree.

Merkleize

merkleizeRadixTree

Arguments

:: RadixDatabase config m database

=> RadixTree database

Radix tree.

-> m (RadixRoot, RadixTree database)

Merkleize a radix tree. This will flush the buffer to disk.

Query

lookupMerkleizedRadixTree

Arguments

:: RadixDatabase config m database

=> ByteString

Key.

-> RadixTree database

Radix tree.

-> m (Maybe (ByteString, RadixTree database))

Lookup a value in a Merkleized radix tree.

lookupNonMerkleizedRadixTree

Arguments

:: RadixDatabase config m database

=> ByteString

Key.

-> RadixTree database

Radix tree.

-> m (Maybe (ByteString, RadixTree database))

Lookup a value in a non-Merkleized radix tree.

Test

isEmptyRadixTree

Arguments

:: RadixTree database

Radix tree.

-> Bool

Check if a radix tree is empty.

isValidRadixRoot

Arguments

:: RadixDatabase config m database

=> RadixRoot

State root.

-> RadixTree database

Radix tree.

-> m Bool

Check if a state root is valid.

Stream

sourceMerkleizedRadixTree

Arguments

:: MonadResource m

=> RadixDatabase config (ConduitM () ByteString m) database

=> [Bool]

Bit mask.

-> Int

LRU cache size in items.

-> BoundedChan RadixRoot

Terminal state root producer.

-> RadixTree database

Radix tree.

-> ConduitM () ByteString m ()

Create a conduit from a Merkleized radix tree.

sinkMerkleizedRadixTree

Arguments

:: MonadResource m

=> RadixDatabase config (ConduitM ByteString () m) database

=> RadixRoot

Target state root.

-> BoundedChan RadixRoot

Terminal state root consumer.

-> RadixTree database

Radix tree.

-> ConduitM ByteString () m (Either [RadixRoot] (RadixTree database))

Create a Merkleized radix tree from a conduit.

Debug

printMerkleizedRadixTree

Arguments

:: MonadIO m

=> RadixDatabase config m database

=> RadixTree database

Radix tree.

-> m ()

Print a Merkleized radix tree.

printNonMerkleizedRadixTree

Arguments

:: MonadIO m

=> RadixDatabase config m database

=> RadixTree database

Radix tree.

-> m ()

Print a non-Merkleized radix tree.