Class LiteDBStore

IStore implementation using LiteDB.

Inheritance
Object
LiteDBStore
Implements
Inherited Members
Namespace: Libplanet.Store
Assembly: Libplanet.dll
Syntax
public class LiteDBStore : IStore, IDisposable

Constructors

| Improve this Doc View Source

LiteDBStore(String, Boolean, Int32)

Creates a new LiteDBStore.

Declaration
public LiteDBStore(string path, bool journal = true, int cacheSize = 50000)
Parameters
Type Name Description
String path

The path where the storage file will be saved.
Boolean journal

Enables or disables double write check to ensure durability.
Int32 cacheSize

Max number of pages in the cache.

Methods

| Improve this Doc View Source

AppendIndex(String, HashDigest<SHA256>)

Declaration
public long AppendIndex(string namespace, HashDigest<SHA256> hash)
Parameters
Type Name Description
String namespace
HashDigest<SHA256> hash
Returns
Type Description
Int64
| Improve this Doc View Source

CountBlocks()

Declaration
public long CountBlocks()
Returns
Type Description
Int64
| Improve this Doc View Source

CountIndex(String)

Declaration
public long CountIndex(string namespace)
Parameters
Type Name Description
String namespace
Returns
Type Description
Int64
| Improve this Doc View Source

CountTransactions()

Declaration
public long CountTransactions()
Returns
Type Description
Int64
| Improve this Doc View Source

DeleteBlock(HashDigest<SHA256>)

Declaration
public bool DeleteBlock(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash
Returns
Type Description
Boolean
| Improve this Doc View Source

DeleteIndex(String, HashDigest<SHA256>)

Declaration
public bool DeleteIndex(string namespace, HashDigest<SHA256> hash)
Parameters
Type Name Description
String namespace
HashDigest<SHA256> hash
Returns
Type Description
Boolean
| Improve this Doc View Source

DeleteNamespace(String)

Deletes an index, tx nonces, and state references in the given namespace. It also deletes namespace itself.

Declaration
public void DeleteNamespace(string namespace)
Parameters
Type Name Description
String namespace

The namespace to delete.
Remarks

This does not delete blocks or transactions that belong to the index of the namespace, but only the index, tx nonces, and state references.

| Improve this Doc View Source

DeleteTransaction(TxId)

Declaration
public bool DeleteTransaction(TxId txid)
Parameters
Type Name Description
TxId txid
Returns
Type Description
Boolean
| Improve this Doc View Source

Dispose()

Declaration
public void Dispose()
| Improve this Doc View Source

ForkStateReferences<T>(String, String, Block<T>, IImmutableSet<Address>)

Declaration
public void ForkStateReferences<T>(string srcNamespace, string destNamespace, Block<T> branchPoint, IImmutableSet<Address> addressesToStrip)
    where T : IAction, new()
Parameters
Type Name Description
String srcNamespace
String destNamespace
Block<T> branchPoint
IImmutableSet<Address> addressesToStrip
Type Parameters
Name Description
T
| Improve this Doc View Source

GetBlock<T>(HashDigest<SHA256>)

Declaration
public Block<T> GetBlock<T>(HashDigest<SHA256> blockHash)
    where T : IAction, new()
Parameters
Type Name Description
HashDigest<SHA256> blockHash
Returns
Type Description
Block<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

GetBlockStates(HashDigest<SHA256>)

Gets the states updated by actions in the inquired block.

Declaration
public AddressStateMap GetBlockStates(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash

Hash to query.
Returns
Type Description
AddressStateMap

The states updated by actions in the inquired block. If actions definitely do not update any addresses it returns an empty map. If there is no record for the inquired block (because actions in it have never been evaluated yet) it returns null instead.
Remarks

It does not return all states built up from the genesis block nor delta, but only dirty states by actions the inquired block.

For example, if actions in the genesis block do a++; b++, /// and actions in the second block do b++; c++, this method /// for the second block returns b = 2; c = 1 (dirty), not a = 1; b = 2; c = 1 (all states) nor b = 1; c = 1 (delta).

| Improve this Doc View Source

GetTransaction<T>(TxId)

Declaration
public Transaction<T> GetTransaction<T>(TxId txid)
    where T : IAction, new()
Parameters
Type Name Description
TxId txid
Returns
Type Description
Transaction<T>
Type Parameters
Name Description
T
| Improve this Doc View Source

GetTxNonce(String, Address)

Gets Transaction<T> nonce of the address.

Declaration
public long GetTxNonce(string namespace, Address address)
Parameters
Type Name Description
String namespace

The namespace to get Transaction<T> nonce.
Address address

The Address to get Transaction<T> nonce.
Returns
Type Description
Int64

A Transaction<T> nonce. If there is no previous Transaction<T>, return 0.
See Also
| Improve this Doc View Source

IncreaseTxNonce(String, Address, Int64)

Increases (or decreases if a negative delta is given) the tx nonce counter for signer.

Declaration
public void IncreaseTxNonce(string namespace, Address signer, long delta = 1L)
Parameters
Type Name Description
String namespace

The namespace to increase Transaction<T> nonce.
Address signer

The address of the account to increase tx nonce.
Int64 delta

How many to incrase the counter. A negative number decreases the counter. 1 by default.
See Also
| Improve this Doc View Source

IndexBlockHash(String, Int64)

Declaration
public HashDigest<SHA256>? IndexBlockHash(string namespace, long index)
Parameters
Type Name Description
String namespace
Int64 index
Returns
Type Description
Nullable<HashDigest<SHA256>>
| Improve this Doc View Source

IterateBlockHashes()

Declaration
public IEnumerable<HashDigest<SHA256>> IterateBlockHashes()
Returns
Type Description
IEnumerable<HashDigest<SHA256>>
| Improve this Doc View Source

IterateIndex(String)

Lists all block hashes in the .

Declaration
public IEnumerable<HashDigest<SHA256>> IterateIndex(string namespace)
Parameters
Type Name Description
String namespace

The namespace of the index that contains block hashes to iterate.
Returns
Type Description
IEnumerable<HashDigest<SHA256>>

Block hashes in the index of the namespace, in ascending order; the genesis block goes first, and the tip block goes last.
| Improve this Doc View Source

IterateStagedTransactionIds(Boolean)

Iterates staged TxIds.

Declaration
public IEnumerable<TxId> IterateStagedTransactionIds(bool toBroadcast)
Parameters
Type Name Description
Boolean toBroadcast

Whether to iterate only the TxIds set to broadcast.
Returns
Type Description
IEnumerable<TxId>

Staged TxIds.
| Improve this Doc View Source

IterateStateReferences(String, Address)

Gets pairs of a state reference and a corresponding Index of the requested address in the specified namespace.

Declaration
public IEnumerable<Tuple<HashDigest<SHA256>, long>> IterateStateReferences(string namespace, Address address)
Parameters
Type Name Description
String namespace

The chain namespace.
Address address

The Address to get state references.
Returns
Type Description
IEnumerable<Tuple<HashDigest<SHA256>, Int64>>

Ordered pairs of a state reference and a corresponding Index. The highest index (i.e., the closest to the tip) go last, and the lowest index (i.e., the closest to the genesis) go first.
See Also
| Improve this Doc View Source

IterateTransactionIds()

Declaration
public IEnumerable<TxId> IterateTransactionIds()
Returns
Type Description
IEnumerable<TxId>
| Improve this Doc View Source

ListAddresses(String)

Lists all addresses that have ever had states.

Declaration
public IEnumerable<Address> ListAddresses(string namespace)
Parameters
Type Name Description
String namespace

The namespace to list addresses.
Returns
Type Description
IEnumerable<Address>

All addresses in an arbitrary order. The order might be vary for each call.
| Improve this Doc View Source

ListNamespaces()

Lists existing namespaces.

Declaration
public IEnumerable<string> ListNamespaces()
Returns
Type Description
IEnumerable<String>

Existing namespaces.
| Improve this Doc View Source

ListTxNonces(String)

Lists all Addresses that have ever signed Transaction<T>, and their corresponding Transaction<T> nonces.

Declaration
public IEnumerable<KeyValuePair<Address, long>> ListTxNonces(string namespace)
Parameters
Type Name Description
String namespace

The namespace to list Addresses and their Transaction<T> nonces.
Returns
Type Description
IEnumerable<KeyValuePair<Address, Int64>>

Pairs of an Address and its tx nonce. All nonces are greater than 0. (If there are underlying entries having zero nonces these must be hidden.)
See Also
| Improve this Doc View Source

PutBlock<T>(Block<T>)

Declaration
public void PutBlock<T>(Block<T> block)
    where T : IAction, new()
Parameters
Type Name Description
Block<T> block
Type Parameters
Name Description
T
| Improve this Doc View Source

PutTransaction<T>(Transaction<T>)

Declaration
public void PutTransaction<T>(Transaction<T> tx)
    where T : IAction, new()
Parameters
Type Name Description
Transaction<T> tx
Type Parameters
Name Description
T
| Improve this Doc View Source

SetBlockStates(HashDigest<SHA256>, AddressStateMap)

Declaration
public void SetBlockStates(HashDigest<SHA256> blockHash, AddressStateMap states)
Parameters
Type Name Description
HashDigest<SHA256> blockHash
AddressStateMap states
| Improve this Doc View Source

StageTransactionIds(IDictionary<TxId, Boolean>)

Adds TxIds to the pending list so that a next Block<T> to be mined contains the corresponding Transaction<T>s.

Declaration
public void StageTransactionIds(IDictionary<TxId, bool> txids)
Parameters
Type Name Description
IDictionary<TxId, Boolean> txids

TxIds to add to pending list. Keys are TxIds and values are whether to broadcast.
| Improve this Doc View Source

StoreStateReference<T>(String, IImmutableSet<Address>, Block<T>)

Declaration
public void StoreStateReference<T>(string namespace, IImmutableSet<Address> addresses, Block<T> block)
    where T : IAction, new()
Parameters
Type Name Description
String namespace
IImmutableSet<Address> addresses
Block<T> block
Type Parameters
Name Description
T
| Improve this Doc View Source

UnstageTransactionIds(ISet<TxId>)

Declaration
public void UnstageTransactionIds(ISet<TxId> txids)
Parameters
Type Name Description
ISet<TxId> txids

Implements

Extension Methods

See Also