Class LiteDBStore
Inheritance
System.Object
LiteDBStore
Assembly: Libplanet.dll
Syntax
public class LiteDBStore : BaseStore, IStore, IDisposable
Constructors
|
Improve this Doc
View Source
LiteDBStore(String, Boolean, Int32, Boolean, Boolean)
Declaration
public LiteDBStore(string path, bool journal = true, int cacheSize = 50000, bool flush = true, bool readOnly = false)
Parameters
Type |
Name |
Description |
System.String |
path |
The path where the storage file will be saved. If the path is
null , The database is created in memory with .
|
System.Boolean |
journal |
Enables or disables double write check to ensure durability.
|
System.Int32 |
cacheSize |
Max number of pages in the cache.
|
System.Boolean |
flush |
Writes data direct to disk avoiding OS cache. Turned on by default.
|
System.Boolean |
readOnly |
Opens database readonly mode. Turned off by default.
|
Methods
|
Improve this Doc
View Source
AppendIndex(Guid, HashDigest<SHA256>)
Declaration
public override long AppendIndex(Guid chainId, HashDigest<SHA256> hash)
Parameters
Type |
Name |
Description |
Guid |
chainId |
|
HashDigest<SHA256> |
hash |
|
Returns
Type |
Description |
System.Int64 |
|
Overrides
|
Improve this Doc
View Source
CountBlocks()
Declaration
public override long CountBlocks()
Returns
Type |
Description |
System.Int64 |
|
Overrides
|
Improve this Doc
View Source
CountIndex(Guid)
Declaration
public override long CountIndex(Guid chainId)
Parameters
Type |
Name |
Description |
Guid |
chainId |
|
Returns
Type |
Description |
System.Int64 |
|
Overrides
|
Improve this Doc
View Source
CountTransactions()
Declaration
public override long CountTransactions()
Returns
Type |
Description |
System.Int64 |
|
Overrides
|
Improve this Doc
View Source
DeleteBlock(HashDigest<SHA256>)
Declaration
public override bool DeleteBlock(HashDigest<SHA256> blockHash)
Parameters
Type |
Name |
Description |
HashDigest<SHA256> |
blockHash |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
|
Improve this Doc
View Source
DeleteChainId(Guid)
Deletes an index, tx nonces, and state references in the given
chainId
.
It also deletes chain itself. If there is no such chainId
it
does nothing.
Declaration
public override void DeleteChainId(Guid chainId)
Parameters
Type |
Name |
Description |
Guid |
chainId |
The ID of chain to delete.
|
Overrides
|
Improve this Doc
View Source
DeleteIndex(Guid, HashDigest<SHA256>)
Declaration
public override bool DeleteIndex(Guid chainId, HashDigest<SHA256> hash)
Parameters
Type |
Name |
Description |
Guid |
chainId |
|
HashDigest<SHA256> |
hash |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
|
Improve this Doc
View Source
DeleteTransaction(TxId)
Declaration
public override bool DeleteTransaction(TxId txid)
Parameters
Type |
Name |
Description |
TxId |
txid |
|
Returns
Type |
Description |
System.Boolean |
|
Overrides
|
Improve this Doc
View Source
Dispose()
Declaration
|
Improve this Doc
View Source
ForkBlockIndexes(Guid, Guid, HashDigest<SHA256>)
Forks block indexes from
sourceChainId
to
destinationChainId
.
Declaration
public override void ForkBlockIndexes(Guid sourceChainId, Guid destinationChainId, HashDigest<SHA256> branchPoint)
Parameters
Type |
Name |
Description |
Guid |
sourceChainId |
The chain ID of block indexes to
fork.
|
Guid |
destinationChainId |
The chain ID of destination
block indexes.
|
HashDigest<SHA256> |
branchPoint |
The branch point Block<T>
to fork.
|
Overrides
Exceptions
See Also
IterateIndex(
Guid,
System.Int32,
System.Nullable<
System.Int32>)
|
Improve this Doc
View Source
ForkStateReferences<T>(Guid, Guid, Block<T>)
Declaration
public override void ForkStateReferences<T>(Guid sourceChainId, Guid destinationChainId, Block<T> branchPoint)
where T : IAction, new()
Parameters
Type |
Name |
Description |
Guid |
sourceChainId |
|
Guid |
destinationChainId |
|
Block<T> |
branchPoint |
|
Type Parameters
Overrides
Libplanet.Store.BaseStore.ForkStateReferences<T>(Guid, Guid, Libplanet.Blocks.Block<T>)
|
Improve this Doc
View Source
GetBlockStates(HashDigest<SHA256>)
Declaration
public override AddressStateMap GetBlockStates(HashDigest<SHA256> blockHash)
Parameters
Type |
Name |
Description |
HashDigest<SHA256> |
blockHash |
|
Returns
Overrides
|
Improve this Doc
View Source
GetCanonicalChainId()
Gets the ID of the current canonical chain.
Declaration
public override Guid? GetCanonicalChainId()
Returns
Type |
Description |
System.Nullable<Guid> |
The ID of the current canonical chain. Maybe null .
|
Overrides
See Also
|
Improve this Doc
View Source
GetTransaction<T>(TxId)
Declaration
public override Transaction<T> GetTransaction<T>(TxId txid)
where T : IAction, new()
Parameters
Type |
Name |
Description |
TxId |
txid |
|
Returns
Type Parameters
Overrides
|
Improve this Doc
View Source
GetTxNonce(Guid, Address)
Declaration
public override long GetTxNonce(Guid chainId, Address address)
Parameters
Returns
Overrides
See Also
|
Improve this Doc
View Source
IncreaseTxNonce(Guid, Address, Int64)
Increases (or decreases if a negative delta
is given)
the tx nonce counter for signer
.
Declaration
public override void IncreaseTxNonce(Guid chainId, Address signer, long delta = null)
Parameters
Type |
Name |
Description |
Guid |
chainId |
The ID of the chain to increase
Transaction<T> nonce.
|
Address |
signer |
The address of the account to increase tx nonce.
|
System.Int64 |
delta |
How many to increase the counter. A negative number decreases
the counter. 1 by default.
|
Overrides
See Also
|
Improve this Doc
View Source
IndexBlockHash(Guid, Int64)
Declaration
public override HashDigest<SHA256>? IndexBlockHash(Guid chainId, long index)
Parameters
Type |
Name |
Description |
Guid |
chainId |
|
System.Int64 |
index |
|
Returns
Type |
Description |
System.Nullable<HashDigest<SHA256>> |
|
Overrides
|
Improve this Doc
View Source
IterateBlockHashes()
Declaration
public override IEnumerable<HashDigest<SHA256>> IterateBlockHashes()
Returns
Overrides
|
Improve this Doc
View Source
IterateIndex(Guid, Int32, Nullable<Int32>)
Declaration
public override IEnumerable<HashDigest<SHA256>> IterateIndex(Guid chainId, int offset, int? limit)
Parameters
Type |
Name |
Description |
Guid |
chainId |
|
System.Int32 |
offset |
|
System.Nullable<System.Int32> |
limit |
|
Returns
Overrides
|
Improve this Doc
View Source
IterateStagedTransactionIds()
Declaration
public override IEnumerable<TxId> IterateStagedTransactionIds()
Returns
Type |
Description |
IEnumerable<TxId> |
Staged TxIds.
|
Overrides
|
Improve this Doc
View Source
IterateStateReferences(Guid, Address)
Gets pairs of a state reference and a corresponding Index of
the requested address
in the specified chainId
.
Declaration
public override IEnumerable<Tuple<HashDigest<SHA256>, long>> IterateStateReferences(Guid chainId, Address address)
Parameters
Type |
Name |
Description |
Guid |
chainId |
The chain ID.
|
Address |
address |
The Address to get state references.
|
Returns
Type |
Description |
IEnumerable<Tuple<HashDigest<SHA256>, System.Int64>> |
Ordered pairs of a state reference and a corresponding
Index. The highest index (i.e., the closest to the tip) goes
first and the lowest index (i.e., the closest to the genesis) goes last.
|
Overrides
See Also
|
Improve this Doc
View Source
IterateTransactionIds()
Declaration
public override IEnumerable<TxId> IterateTransactionIds()
Returns
Type |
Description |
IEnumerable<TxId> |
|
Overrides
|
Improve this Doc
View Source
ListAddresses(Guid)
Lists all addresses that have ever had states.
Declaration
public override IEnumerable<Address> ListAddresses(Guid chainId)
Parameters
Type |
Name |
Description |
Guid |
chainId |
The ID of the chain to list addresses.
|
Returns
Type |
Description |
IEnumerable<Address> |
All addresses in an arbitrary order. The order might
be vary for each call.
|
Overrides
|
Improve this Doc
View Source
ListChainIds()
Lists existing chain IDs.
Declaration
public override IEnumerable<Guid> ListChainIds()
Returns
Type |
Description |
IEnumerable<Guid> |
Existing chain IDs.
|
Overrides
|
Improve this Doc
View Source
ListTxNonces(Guid)
Declaration
public override IEnumerable<KeyValuePair<Address, long>> ListTxNonces(Guid chainId)
Parameters
Type |
Name |
Description |
Guid |
chainId |
The ID of the chain to list Addresses and their
Transaction<T> nonces.
|
Returns
Type |
Description |
IEnumerable<KeyValuePair<Address, System.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.)
|
Overrides
See Also
|
Improve this Doc
View Source
PutBlock<T>(Block<T>)
Declaration
public override void PutBlock<T>(Block<T> block)
where T : IAction, new()
Parameters
Type |
Name |
Description |
Block<T> |
block |
|
Type Parameters
Overrides
Libplanet.Store.BaseStore.PutBlock<T>(Libplanet.Blocks.Block<T>)
|
Improve this Doc
View Source
PutTransaction<T>(Transaction<T>)
Declaration
public override void PutTransaction<T>(Transaction<T> tx)
where T : IAction, new()
Parameters
Type Parameters
Overrides
Libplanet.Store.BaseStore.PutTransaction<T>(Libplanet.Tx.Transaction<T>)
|
Improve this Doc
View Source
SetBlockStates(HashDigest<SHA256>, AddressStateMap)
Declaration
public override void SetBlockStates(HashDigest<SHA256> blockHash, AddressStateMap states)
Parameters
Overrides
|
Improve this Doc
View Source
SetCanonicalChainId(Guid)
Sets the canonical chain.
Declaration
public override void SetCanonicalChainId(Guid chainId)
Parameters
Type |
Name |
Description |
Guid |
chainId |
The ID of a new canonical chain.
|
Overrides
See Also
|
Improve this Doc
View Source
StageTransactionIds(IImmutableSet<TxId>)
Declaration
public override void StageTransactionIds(IImmutableSet<TxId> txids)
Parameters
Type |
Name |
Description |
IImmutableSet<TxId> |
txids |
TxIds to add to pending list.
|
Overrides
|
Improve this Doc
View Source
StoreStateReference(Guid, IImmutableSet<Address>, HashDigest<SHA256>, Int64)
Declaration
public override void StoreStateReference(Guid chainId, IImmutableSet<Address> addresses, HashDigest<SHA256> hash, long index)
Parameters
Type |
Name |
Description |
Guid |
chainId |
|
IImmutableSet<Address> |
addresses |
|
HashDigest<SHA256> |
hash |
|
System.Int64 |
index |
|
Overrides
|
Improve this Doc
View Source
UnstageTransactionIds(ISet<TxId>)
Declaration
public override void UnstageTransactionIds(ISet<TxId> txids)
Parameters
Type |
Name |
Description |
ISet<TxId> |
txids |
|
Overrides
Implements
IDisposable
See Also