Class BaseStore

Inheritance
Object
BaseStore
BaseBlockStatesStore
Implements
IDisposable
Namespace: Libplanet.Store
Assembly: Libplanet.dll
Syntax
public abstract class BaseStore : object, IStore, IDisposable

Methods

| Improve this Doc View Source

AppendIndex(Guid, HashDigest<SHA256>)

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

ContainsBlock(HashDigest<SHA256>)

Determines whether the IStore contains Block<T> the specified blockHash.

Declaration
public abstract bool ContainsBlock(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash

The HashDigest<T> of the Block<T> to check if it is in the IStore.
Returns
Type Description
Boolean

true if the IStore contains Block<T> with the specified blockHash; otherwise, false.
| Improve this Doc View Source

ContainsTransaction(TxId)

Determines whether the IStore contains Transaction<T> the specified txId.

Declaration
public abstract bool ContainsTransaction(TxId txId)
Parameters
Type Name Description
TxId txId

The TxId of the Transaction<T> to check if it is in the IStore.
Returns
Type Description
Boolean

true if the IStore contains Transaction<T> with the specified txId; otherwise, false.
| Improve this Doc View Source

CountBlocks()

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

CountIndex(Guid)

Declaration
public abstract long CountIndex(Guid chainId)
Parameters
Type Name Description
Guid chainId
Returns
Type Description
Int64
| Improve this Doc View Source

CountTransactions()

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

DeleteBlock(HashDigest<SHA256>)

Declaration
public abstract bool DeleteBlock(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash
Returns
Type Description
Boolean
| 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 abstract void DeleteChainId(Guid chainId)
Parameters
Type Name Description
Guid chainId

The ID of chain to delete.
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.

| Improve this Doc View Source

DeleteTransaction(TxId)

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

Dispose()

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

ForkBlockIndexes(Guid, Guid, HashDigest<SHA256>)

Forks block indexes from sourceChainId to destinationChainId.

Declaration
public abstract 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.
Exceptions
Type Condition
ChainIdNotFoundException

Thrown when the given sourceChainId does not exist.
See Also
AppendIndex(Guid, HashDigest<SHA256>)
| Improve this Doc View Source

GetBlock<T>(HashDigest<SHA256>)

Gets the corresponding stored Block<T> to the given blockHash.

Declaration
public Block<T> GetBlock<T>(HashDigest<SHA256> blockHash)
    where T : IAction, new()
Parameters
Type Name Description
HashDigest<SHA256> blockHash

Hash to find.
Returns
Type Description
Block<T>

A found block, or null if no block having such blockHash is stored.
Type Parameters
Name Description
T

An IAction type. It should match to Block<T>'s type parameter.
| Improve this Doc View Source

GetBlockDigest(HashDigest<SHA256>)

Gets the corresponding stored BlockDigest to the given blockHash.

Declaration
public abstract BlockDigest? GetBlockDigest(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash

Hash to find.
Returns
Type Description
Nullable<BlockDigest>

A found BlockDigest, or null if no block having such blockHash is stored.
| Improve this Doc View Source

GetBlockIndex(HashDigest<SHA256>)

Gets a stored block's Index by its Hash.

Declaration
public long? GetBlockIndex(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash

Hash to find.
Returns
Type Description
Nullable<Int64>

A found block's Index, or null if no block having such blockHash is stored.
Remarks

It provides only limited information, but can be called without any type parameter unlike GetBlock<T>(HashDigest<SHA256>).

| Improve this Doc View Source

GetCanonicalChainId()

Gets the ID of the current canonical chain.

Declaration
public abstract Guid? GetCanonicalChainId()
Returns
Type Description
Nullable<Guid>

The ID of the current canonical chain. Maybe null.
See Also
| Improve this Doc View Source

GetTransaction<T>(TxId)

Declaration
public abstract 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(Guid, Address)

Gets Transaction<T> nonce of the address.

Declaration
public abstract long GetTxNonce(Guid chainId, Address address)
Parameters
Type Name Description
Guid chainId

The ID of the chain 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(Guid, Address, Int64)

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

Declaration
public abstract 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.
Int64 delta

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

IndexBlockHash(Guid, Int64)

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

IterateBlockHashes()

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

IterateIndexes(Guid, Int32, Nullable<Int32>)

Declaration
public abstract IEnumerable<HashDigest<SHA256>> IterateIndexes(Guid chainId, int offset, int? limit)
Parameters
Type Name Description
Guid chainId
Int32 offset
Nullable<Int32> limit
Returns
Type Description
IEnumerable<HashDigest<SHA256>>
| Improve this Doc View Source

IterateStagedTransactionIds()

Iterates staged TxIds.

Declaration
public abstract IEnumerable<TxId> IterateStagedTransactionIds()
Returns
Type Description
IEnumerable<TxId>

Staged TxIds.
| Improve this Doc View Source

IterateTransactionIds()

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

ListChainIds()

Lists existing chain IDs.

Declaration
public abstract IEnumerable<Guid> ListChainIds()
Returns
Type Description
IEnumerable<Guid>

Existing chain IDs.
| Improve this Doc View Source

ListTxNonces(Guid)

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

Declaration
public abstract 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, 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 abstract 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 abstract 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

SetCanonicalChainId(Guid)

Sets the canonical chain.

Declaration
public abstract void SetCanonicalChainId(Guid chainId)
Parameters
Type Name Description
Guid chainId

The ID of a new canonical chain.
See Also
| Improve this Doc View Source

StageTransactionIds(IImmutableSet<TxId>)

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

Declaration
public abstract void StageTransactionIds(IImmutableSet<TxId> txids)
Parameters
Type Name Description
IImmutableSet<TxId> txids

TxIds to add to pending list.
| Improve this Doc View Source

UnstageTransactionIds(ISet<TxId>)

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

Implements

IDisposable