Class DefaultStore

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Inheritance

System.Object

BaseStore

DefaultStore

Implements

IStore

IDisposable

Inherited Members

BaseStore.GetBlock(BlockHash)

BaseStore.GetBlockIndex(BlockHash)

BaseStore.GetFirstTxIdBlockHashIndex(TxId)

BaseStore.SerializeTxExecution(TxExecution)

BaseStore.DeserializeTxExecution(BlockHash, TxId, IValue, ILogger)

Namespace: Libplanet.Store

Assembly: Libplanet.Store.dll

Syntax

public class DefaultStore : BaseStore, IStore

Constructors

DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)

Creates a new DefaultStore.

Declaration

public DefaultStore(string path, bool journal = true, int indexCacheSize = 50000, int blockCacheSize = 512, int txCacheSize = 1024, int evidenceCacheSize = 1024, bool flush = true, bool readOnly = false)

Parameters

Type	Name	Description
System.String	path	The path of the directory where the storage files will be saved. If the path is null, the database is created in memory.
System.Boolean	journal	Enables or disables double write check to ensure durability.
System.Int32	indexCacheSize	Max number of pages in the index cache.
System.Int32	blockCacheSize	The capacity of the block cache.
System.Int32	txCacheSize	The capacity of the transaction cache.
System.Int32	evidenceCacheSize	The capacity of the evidence 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.

See Also

IStore

Methods

AppendIndex(Guid, BlockHash)

Appends a block to a chain.

Declaration

public override long AppendIndex(Guid chainId, BlockHash hash)

Parameters

Type	Name	Description
Guid	chainId	The ID of a chain to append a block to.
BlockHash	hash	The hash of a block to append. Assumes the block is already put into the store.

Returns

Type	Description
System.Int64	The index of the appended block.

Overrides

BaseStore.AppendIndex(Guid, BlockHash)

See Also

IStore

ContainsBlock(BlockHash)

Determines whether the IStore contains Block the specified blockHash.

Declaration

public override bool ContainsBlock(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash	The HashDigest<T> of the Block to check if it is in the IStore.

Returns

Type	Description
System.Boolean	true if the IStore contains Block with the specified blockHash; otherwise, false.

Overrides

BaseStore.ContainsBlock(BlockHash)

See Also

IStore

ContainsCommittedEvidence(EvidenceId)

Determines whether the IStore contains EvidenceBase the specified evidenceId as committed.

Declaration

public override bool ContainsCommittedEvidence(EvidenceId evidenceId)

Parameters

Type	Name	Description
EvidenceId	evidenceId	The EvidenceId of the EvidenceBase to check if it is in the IStore and committed.

Returns

Type	Description
System.Boolean	true if the IStore contains EvidenceBase with the specified evidenceId as committed; otherwise, false.

Overrides

BaseStore.ContainsCommittedEvidence(EvidenceId)

See Also

IStore

ContainsPendingEvidence(EvidenceId)

Determines whether the IStore contains EvidenceBase the specified evidenceId as pending.

Declaration

public override bool ContainsPendingEvidence(EvidenceId evidenceId)

Parameters

Type	Name	Description
EvidenceId	evidenceId	The EvidenceId of the EvidenceBase to check if it is in the IStore and pending.

Returns

Type	Description
System.Boolean	true if the IStore contains EvidenceBase with the specified evidenceId as pending; otherwise, false.

Overrides

BaseStore.ContainsPendingEvidence(EvidenceId)

See Also

IStore

ContainsTransaction(TxId)

Determines whether the IStore contains Transaction the specified txId.

Declaration

public override bool ContainsTransaction(TxId txId)

Parameters

Type	Name	Description
TxId	txId	The TxId of the Transaction to check if it is in the IStore.

Returns

Type	Description
System.Boolean	true if the IStore contains Transaction with the specified txId; otherwise, false.

Overrides

BaseStore.ContainsTransaction(TxId)

See Also

IStore

CountBlocks()

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override long CountBlocks()

Returns

Type	Description
System.Int64

Overrides

BaseStore.CountBlocks()

See Also

IStore

CountIndex(Guid)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override long CountIndex(Guid chainId)

Parameters

Type	Name	Description
Guid	chainId

Returns

Type	Description
System.Int64

Overrides

BaseStore.CountIndex(Guid)

See Also

IStore

DeleteBlock(BlockHash)

Removes a block from the store.

Declaration

public override bool DeleteBlock(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash	The hash of a block to remove.

Returns

Type	Description
System.Boolean	false if such block does not exist. Otherwise true.

Overrides

BaseStore.DeleteBlock(BlockHash)

See Also

IStore

DeleteBlockCommit(BlockHash)

Deletes a BlockCommit of given height from store.

Declaration

public override void DeleteBlockCommit(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash	The BlockHash of a BlockCommit to delete.

Overrides

BaseStore.DeleteBlockCommit(BlockHash)

See Also

IStore

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

BaseStore.DeleteChainId(Guid)

Remarks

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

See Also

IStore

DeleteCommittedEvidence(EvidenceId)

Deletes a committed EvidenceBase of given evidenceId from the store.

Declaration

public override void DeleteCommittedEvidence(EvidenceId evidenceId)

Parameters

Type	Name	Description
EvidenceId	evidenceId	The EvidenceId of a committed EvidenceBase to delete.

Overrides

BaseStore.DeleteCommittedEvidence(EvidenceId)

See Also

IStore

DeleteNextStateRootHash(BlockHash)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override void DeleteNextStateRootHash(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash

Overrides

BaseStore.DeleteNextStateRootHash(BlockHash)

See Also

IStore

DeletePendingEvidence(EvidenceId)

Deletes a pending EvidenceBase of given evidenceId from the store.

Declaration

public override void DeletePendingEvidence(EvidenceId evidenceId)

Parameters

Type	Name	Description
EvidenceId	evidenceId	The EvidenceId of a pending EvidenceBase to delete.

Overrides

BaseStore.DeletePendingEvidence(EvidenceId)

See Also

IStore

DeleteTxIdBlockHashIndex(TxId, BlockHash)

Deletes the index for the txId and blockHash.

Declaration

public override void DeleteTxIdBlockHashIndex(TxId txId, BlockHash blockHash)

Parameters

Type	Name	Description
TxId	txId	The TxId of the Transaction.
BlockHash	blockHash	The BlockHash of the Block.

Overrides

BaseStore.DeleteTxIdBlockHashIndex(TxId, BlockHash)

See Also

IStore

Dispose()

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override void Dispose()

Overrides

BaseStore.Dispose()

See Also

IStore

ForkBlockIndexes(Guid, Guid, BlockHash)

Forks block indexes from sourceChainId to destinationChainId.

Declaration

public override void ForkBlockIndexes(Guid sourceChainId, Guid destinationChainId, BlockHash branchpoint)

Parameters

Type	Name	Description
Guid	sourceChainId	The chain ID of block indexes to fork.
Guid	destinationChainId	The chain ID of destination block indexes.
BlockHash	branchpoint	The branchpoint Block to fork.

Overrides

BaseStore.ForkBlockIndexes(Guid, Guid, BlockHash)

See Also

IterateIndexes(Guid, System.Int32, System.Nullable<System.Int32>)

AppendIndex(Guid, BlockHash)

ForkTxNonces(Guid, Guid)

Forks Transaction Nonces from sourceChainId to destinationChainId.

Declaration

public override void ForkTxNonces(Guid sourceChainId, Guid destinationChainId)

Parameters

Type	Name	Description
Guid	sourceChainId	The chain of Transaction Nonces to fork.
Guid	destinationChainId	The chain of destination Transaction Nonces.

Overrides

BaseStore.ForkTxNonces(Guid, Guid)

See Also

IStore

GetBlockCommit(BlockHash)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override BlockCommit GetBlockCommit(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash

Returns

Type	Description
BlockCommit

Overrides

BaseStore.GetBlockCommit(BlockHash)

See Also

IStore

GetBlockCommitHashes()

Gets every BlockHashes of BlockCommits from store.

Declaration

public override IEnumerable<BlockHash> GetBlockCommitHashes()

Returns

Type	Description
IEnumerable<BlockHash>	Returns an of BlockHashes of all BlockCommits.

Overrides

BaseStore.GetBlockCommitHashes()

See Also

IStore

GetBlockDigest(BlockHash)

Gets the corresponding stored BlockDigest to the given blockHash.

Declaration

public override BlockDigest? GetBlockDigest(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash	Hash to find.

Returns

Type	Description
System.Nullable<BlockDigest>	A found BlockDigest, or null if no block having such blockHash is stored.

Overrides

BaseStore.GetBlockDigest(BlockHash)

See Also

IStore

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

BaseStore.GetCanonicalChainId()

See Also

SetCanonicalChainId(Guid)

GetChainBlockCommit(Guid)

Gets a BlockCommit associated with a with chainId as its .

Declaration

public override BlockCommit GetChainBlockCommit(Guid chainId)

Parameters

Type	Name	Description
Guid	chainId	The of the to retrieve BlockCommit.

Returns

Type	Description
BlockCommit	Returns BlockCommit if given chainId is stored and available, otherwise returns null.

Overrides

BaseStore.GetChainBlockCommit(Guid)

See Also

IStore

GetCommittedEvidence(EvidenceId)

Gets every committed EvidenceBase of given evidenceId from the store.

Declaration

public override EvidenceBase GetCommittedEvidence(EvidenceId evidenceId)

Parameters

Type	Name	Description
EvidenceId	evidenceId	The EvidenceId of a committed EvidenceBase to retrieve.

Returns

Type	Description
EvidenceBase	Returns EvidenceBase if given evidenceId is stored, committed and available, otherwise returns null.

Overrides

BaseStore.GetCommittedEvidence(EvidenceId)

See Also

IStore

GetNextStateRootHash(BlockHash)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override HashDigest<SHA256>? GetNextStateRootHash(BlockHash blockHash)

Parameters

Type	Name	Description
BlockHash	blockHash

Returns

Type	Description
System.Nullable<HashDigest<SHA256>>

Overrides

BaseStore.GetNextStateRootHash(BlockHash)

See Also

IStore

GetPendingEvidence(EvidenceId)

Gets every pending EvidenceBase of given evidenceId from the store.

Declaration

public override EvidenceBase GetPendingEvidence(EvidenceId evidenceId)

Parameters

Type	Name	Description
EvidenceId	evidenceId	The EvidenceId of a pending EvidenceBase to retrieve.

Returns

Type	Description
EvidenceBase	Returns EvidenceBase if given evidenceId is stored, pending and available, otherwise returns null.

Overrides

BaseStore.GetPendingEvidence(EvidenceId)

See Also

IStore

GetTransaction(TxId)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override Transaction GetTransaction(TxId txid)

Parameters

Type	Name	Description
TxId	txid

Returns

Type	Description
Transaction

Overrides

BaseStore.GetTransaction(TxId)

See Also

IStore

GetTxExecution(BlockHash, TxId)

Retrieves the recorded transaction execution summary.

Declaration

public override TxExecution GetTxExecution(BlockHash blockHash, TxId txid)

Parameters

Type	Name	Description
BlockHash	blockHash	The Hash of the recorded transaction execution to retrieve.
TxId	txid	The Id of the recorded transaction execution to retrieve.

Returns

Type	Description
TxExecution	The recorded transaction execution summary. If it has been never recorded null is returned instead.

Overrides

BaseStore.GetTxExecution(BlockHash, TxId)

See Also

PutTxExecution(TxExecution)

GetTxNonce(Guid, Address)

Gets Transaction nonce of the address.

Declaration

public override long GetTxNonce(Guid chainId, Address address)

Parameters

Type	Name	Description
Guid	chainId	The ID of the chain to get Transaction nonce.
Address	address	The Address to get Transaction nonce.

Returns

Type	Description
System.Int64	A Transaction nonce. If there is no previous Transaction, return 0.

Overrides

BaseStore.GetTxNonce(Guid, Address)

See Also

IncreaseTxNonce(Guid, Address, System.Int64)

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 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

BaseStore.IncreaseTxNonce(Guid, Address, Int64)

See Also

GetTxNonce(Guid, Address)

IndexBlockHash(Guid, Int64)

Determines the block hash by its index.

Declaration

public override BlockHash? IndexBlockHash(Guid chainId, long index)

Parameters

Type	Name	Description
Guid	chainId	The chain ID of the index that contains the block.
System.Int64	index	The index of the block to query its hash. Negative indices mean the offset from the end. For example, -1 means the topmost block.

Returns

Type	Description
System.Nullable<BlockHash>	The block hash of the index in the chain. If there is no such index, it returns null.

Overrides

BaseStore.IndexBlockHash(Guid, Int64)

See Also

IStore

IterateBlockHashes()

Lists all block hashes in the store, regardless of their belonging chains.

Declaration

public override IEnumerable<BlockHash> IterateBlockHashes()

Returns

Type	Description
IEnumerable<BlockHash>	All block hashes in the store.

Overrides

BaseStore.IterateBlockHashes()

See Also

IStore

IterateIndexes(Guid, Int32, Nullable<Int32>)

Lists all block hashes in chainId.

Declaration

public override IEnumerable<BlockHash> IterateIndexes(Guid chainId, int offset, int? limit)

Parameters

Type	Name	Description
Guid	chainId	The chain ID of the index that contains block hashes to iterate.
System.Int32	offset	The starting point to return block hashes.
System.Nullable<System.Int32>	limit	The maximum number of block hashes to get.

Returns

Type	Description
IEnumerable<BlockHash>	Block hashes in the index of the chainId, in ascending order; the genesis block goes first, and the tip block goes last.

Overrides

BaseStore.IterateIndexes(Guid, Int32, Nullable<Int32>)

See Also

IStore

IteratePendingEvidenceIds()

Gets every EvidenceIds of pending EvidenceBases from the store.

Declaration

public override IEnumerable<EvidenceId> IteratePendingEvidenceIds()

Returns

Type	Description
IEnumerable<EvidenceId>	Returns an of EvidenceIds of all pending EvidenceBases.

Overrides

BaseStore.IteratePendingEvidenceIds()

See Also

IStore

IterateTxIdBlockHashIndex(TxId)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override IEnumerable<BlockHash> IterateTxIdBlockHashIndex(TxId txId)

Parameters

Type	Name	Description
TxId	txId

Returns

Type	Description
IEnumerable<BlockHash>

Overrides

BaseStore.IterateTxIdBlockHashIndex(TxId)

See Also

IStore

ListChainIds()

Lists chain IDs containing at least a single block.

Declaration

public override IEnumerable<Guid> ListChainIds()

Returns

Type	Description
IEnumerable<Guid>	Chain IDs with at least a single block.

Overrides

BaseStore.ListChainIds()

See Also

IStore

ListTxNonces(Guid)

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

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 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

BaseStore.ListTxNonces(Guid)

See Also

GetTxNonce(Guid, Address)

PruneOutdatedChains(Boolean)

Delete all non-canonical chains.

Declaration

public override void PruneOutdatedChains(bool noopWithoutCanon = false)

Parameters

Type	Name	Description
System.Boolean	noopWithoutCanon	Flag to determine whether the function throws exception when the canonical chain is not assigned. false by default. If it set to true, does not throw exception when there is no canonical chain. Otherwise, throws when there is no canonical chain.

Overrides

BaseStore.PruneOutdatedChains(Boolean)

See Also

IStore

PutBlock(Block)

Puts the given block in to the store. If the same block already exists in the store it does nothing.

Declaration

public override void PutBlock(Block block)

Parameters

Type	Name	Description
Block	block	A Block to put into the store.

Overrides

BaseStore.PutBlock(Block)

See Also

IStore

PutBlockCommit(BlockCommit)

Puts a BlockCommit to the store.

Declaration

public override void PutBlockCommit(BlockCommit blockCommit)

Parameters

Type	Name	Description
BlockCommit	blockCommit	A BlockCommit to store.

Overrides

BaseStore.PutBlockCommit(BlockCommit)

See Also

IStore

PutChainBlockCommit(Guid, BlockCommit)

Puts a BlockCommit associated with a with chainId as its . The given BlockCommit should have the same BlockHash as the .

Declaration

public override void PutChainBlockCommit(Guid chainId, BlockCommit blockCommit)

Parameters

Type	Name	Description
Guid	chainId	The of the to store BlockCommit.
BlockCommit	blockCommit	The BlockCommit to store.

Overrides

BaseStore.PutChainBlockCommit(Guid, BlockCommit)

See Also

IStore

PutCommittedEvidence(EvidenceBase)

Puts a EvidenceBase to the store as committed evidence.

Declaration

public override void PutCommittedEvidence(EvidenceBase evidence)

Parameters

Type	Name	Description
EvidenceBase	evidence	A committed EvidenceBase to store.

Overrides

BaseStore.PutCommittedEvidence(EvidenceBase)

See Also

IStore

PutNextStateRootHash(BlockHash, HashDigest<SHA256>)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override void PutNextStateRootHash(BlockHash blockHash, HashDigest<SHA256> nextStateRootHash)

Parameters

Type	Name	Description
BlockHash	blockHash
HashDigest<SHA256>	nextStateRootHash

Overrides

BaseStore.PutNextStateRootHash(BlockHash, HashDigest<SHA256>)

See Also

IStore

PutPendingEvidence(EvidenceBase)

Puts a EvidenceBase to the store as pending evidence.

Declaration

public override void PutPendingEvidence(EvidenceBase evidence)

Parameters

Type	Name	Description
EvidenceBase	evidence	A pending EvidenceBase to store.

Overrides

BaseStore.PutPendingEvidence(EvidenceBase)

See Also

IStore

PutTransaction(Transaction)

The default built-in IStore implementation. This stores data in the file system or in memory. It also uses LiteDB for some complex indices.

DefaultStore and DefaultKeyValueStore-backed TrieStateStore can be instantiated from a URI with default+file: scheme using LoadStore(Uri), e.g.:

• default+file:///var/data/planet/
• default+file:///c:/Users/john/AppData/Local/planet/

The following query string parameters are supported:

journal	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s journal parameter.
index-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s indexCacheSize parameter. 50000 by default.
block-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s blockCacheSize parameter. 512 by default.
tx-cache	Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s txCacheSize parameter. 1024 by default.
flush	true (default) or false. Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s flush parameter.
readonly	true or false (default). Corresponds to DefaultStore(String, Boolean, Int32, Int32, Int32, Int32, Boolean, Boolean)'s readOnly parameter.
states-dir	Corresponds to 's path parameter. It is relative to the URI path, and defaults to states.

Declaration

public override void PutTransaction(Transaction tx)

Parameters

Type	Name	Description
Transaction	tx

Overrides

BaseStore.PutTransaction(Transaction)

See Also

IStore

PutTxExecution(TxExecution)

Records the given txExecution.

Declaration

public override void PutTxExecution(TxExecution txExecution)

Parameters

Type	Name	Description
TxExecution	txExecution	The transaction execution summary to record. Must not be null.

Overrides

BaseStore.PutTxExecution(TxExecution)

Remarks

If there is already the record for the same BlockHash and TxId, the record is silently overwritten.

See Also

GetTxExecution(BlockHash, TxId)

PutTxIdBlockHashIndex(TxId, BlockHash)

Records a index for given pair txId and blockHash. If there exist a record for txId already, it overwrites the record silently.

Declaration

public override void PutTxIdBlockHashIndex(TxId txId, BlockHash blockHash)

Parameters

Type	Name	Description
TxId	txId	The TxId of the Transaction.
BlockHash	blockHash	The BlockHash of the Block.

Overrides

BaseStore.PutTxIdBlockHashIndex(TxId, BlockHash)

See Also

IStore

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

BaseStore.SetCanonicalChainId(Guid)

See Also

GetCanonicalChainId()

Implements

IStore

IDisposable

See Also

IStore