DFINITY.RadixTree

A generic data integrity layer.

Class

class Monad m => RadixDatabase m database where

Minimal complete definition

load, store

Methods

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

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

Instances

MonadIO m => RadixDatabase m DB

Defined in DFINITY.RadixTree.Types

Methods

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

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

MonadIO m => RadixDatabase m (IORef (Map ByteString ByteString))

Defined in DFINITY.RadixTree.Types

Methods

load :: IORef (Map ByteString ByteString) -> ByteString -> m (Maybe ByteString)

store :: IORef (Map ByteString ByteString) -> ByteString -> ByteString -> m ()

RadixDatabase (ST s) (STRef s (Map ByteString ByteString))

Defined in DFINITY.RadixTree.Types

Methods

load :: STRef s (Map ByteString ByteString) -> ByteString -> ST s (Maybe ByteString)

store :: STRef s (Map ByteString ByteString) -> ByteString -> ByteString -> ST s ()

RadixDatabase (Transaction ReadWrite) (Database ByteString ByteString)

Defined in DFINITY.RadixTree.Types

Methods

load :: Database ByteString ByteString -> ByteString -> Transaction ReadWrite (Maybe ByteString)

store :: Database ByteString ByteString -> ByteString -> ByteString -> Transaction ReadWrite ()

Monad m => RadixDatabase (StateT (Map ByteString ByteString) m) ()

Defined in DFINITY.RadixTree.Types

Methods

load :: () -> ByteString -> StateT (Map ByteString ByteString) m (Maybe ByteString)

store :: () -> ByteString -> ByteString -> StateT (Map ByteString ByteString) m ()

Types

data RadixError

Constructors

InvalidArgument String

StateRootDoesNotExist RadixRoot

Instances

Eq RadixError

Defined in DFINITY.RadixTree.Types

Methods

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

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

Data RadixError

Defined in 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 DFINITY.RadixTree.Types

Methods

showsPrec :: Int -> RadixError -> ShowS

show :: RadixError -> String

showList :: [RadixError] -> ShowS

Exception RadixError

Defined in DFINITY.RadixTree.Types

Methods

toException :: RadixError -> SomeException

fromException :: SomeException -> Maybe RadixError

displayException :: RadixError -> String

data RadixProof

Instances

Eq RadixProof

Defined in DFINITY.RadixTree.Types

Methods

(==) :: RadixProof -> RadixProof -> Bool

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

Data RadixProof

Defined in DFINITY.RadixTree.Types

Methods

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

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

toConstr :: RadixProof -> Constr

dataTypeOf :: RadixProof -> DataType

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

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

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

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

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

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

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

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

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

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

Show RadixProof

Defined in DFINITY.RadixTree.Types

Methods

showsPrec :: Int -> RadixProof -> ShowS

show :: RadixProof -> String

showList :: [RadixProof] -> ShowS

NFData RadixProof

Defined in DFINITY.RadixTree.Types

Methods

rnf :: RadixProof -> ()

Serialise RadixProof

Defined in DFINITY.RadixTree.Types

Methods

encode :: RadixProof -> Encoding

decode :: Decoder s RadixProof

encodeList :: [RadixProof] -> Encoding

decodeList :: Decoder s [RadixProof]

type RadixRoot = ShortByteString

data RadixTree database

Getters

getCheckpoint :: RadixTree database -> RadixRoot

getRoot :: RadixTree database -> RadixRoot

getValue :: RadixProof -> ByteString

Create

createRadixTree

Arguments

:: RadixDatabase m database

=> Int

Bloom filter size in bits.

-> Int

LRU cache size in items.

-> Maybe RadixRoot

Previous state root.

-> database

Database.

-> m (RadixTree database)

Create a radix tree.

Insert

insertRadixTree

Arguments

:: RadixDatabase m database

=> ByteString

Key.

-> ByteString

Value.

-> RadixTree database

Radix tree.

-> m (RadixTree database)

Insert a value into a radix tree.

Delete

deleteRadixTree

Arguments

:: RadixDatabase m database

=> ByteString

Key.

-> RadixTree database

Radix tree.

-> m (RadixTree database)

Delete a value from a radix tree.

Merkleize

merkleizeRadixTree

Arguments

:: RadixDatabase m database

=> RadixTree database

Radix tree.

-> m (RadixRoot, RadixTree database)

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

Query

lookupRadixTree

Arguments

:: RadixDatabase m database

=> ByteString

Key.

-> RadixTree database

Radix tree.

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

Lookup a value in a radix tree.

Prove

createRadixProof

Arguments

:: RadixDatabase m database

=> ByteString

Key.

-> RadixTree database

Radix tree.

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

Prove that a value exists in a radix tree.

Verify

verifyRadixProof

Arguments

:: ByteString

Key.

-> RadixRoot

State root.

-> RadixProof

Radix proof.

-> Bool

Verify that a value exists in a radix tree.

Test

isEmptyRadixTree

Arguments

:: RadixTree database

Radix tree.

-> Bool

Check if a radix tree is empty.

isValidRadixRoot

Arguments

:: RadixDatabase m database

=> RadixRoot

State root.

-> RadixTree database

Radix tree.

-> m Bool

Check if a state root is valid.

Debug

Contents

contentsRadixTree

Arguments

:: RadixDatabase m database

=> RadixTree database

Radix tree.

-> m [(ByteString, ByteString)]

A convenient alias for contentsNonMerkleizedRadixTree.

contentsMerkleizedRadixTree

Arguments

:: RadixDatabase m database

=> RadixTree database

Radix tree.

-> m [(ByteString, ByteString)]

Get the contents of a Merkleized radix tree.

contentsNonMerkleizedRadixTree

Arguments

:: RadixDatabase m database

=> RadixTree database

Radix tree.

-> m [(ByteString, ByteString)]

Get the contents of a non-Merkleized radix tree.

Print

printRadixTree

Arguments

:: MonadIO m

=> RadixDatabase m database

=> RadixTree database

Radix tree.

-> m ()

A convenient alias for printNonMerkleizedRadixTree.

printMerkleizedRadixTree

Arguments

:: MonadIO m

=> RadixDatabase m database

=> RadixTree database

Radix tree.

-> m ()

Print a Merkleized radix tree.

printNonMerkleizedRadixTree

Arguments

:: MonadIO m

=> RadixDatabase m database

=> RadixTree database

Radix tree.

-> m ()

Print a non-Merkleized radix tree.