Class BaseStore

Inheritance
Object
BaseStore
FileStore
Implements
Inherited Members
Namespace: Libplanet.Store
Assembly: Libplanet.dll
Syntax
public abstract class BaseStore : IStore

Methods

| Improve this Doc View Source

AppendIndex(String, HashDigest<SHA256>)

Declaration
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract bool DeleteTransaction(TxId txid)
Parameters
Type Name Description
TxId txid
Returns
Type Description
Boolean
| Improve this Doc View Source

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

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

GetBlock<T>(HashDigest<SHA256>)

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

Declaration
public abstract AddressStateMap GetBlockStates(HashDigest<SHA256> blockHash)
Parameters
Type Name Description
HashDigest<SHA256> blockHash
Returns
Type Description
AddressStateMap
| 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(String, Address)

Gets Transaction<T> nonce of the address.

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

IterateIndex(String)

Declaration
public abstract IEnumerable<HashDigest<SHA256>> IterateIndex(string namespace)
Parameters
Type Name Description
String namespace
Returns
Type Description
IEnumerable<HashDigest<SHA256>>
| Improve this Doc View Source

IterateStagedTransactionIds(Boolean)

Iterates staged TxIds.

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

SetBlockStates(HashDigest<SHA256>, AddressStateMap)

Declaration
public abstract 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 abstract 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 abstract 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 abstract void UnstageTransactionIds(ISet<TxId> txids)
Parameters
Type Name Description
ISet<TxId> txids

Implements

Extension Methods