Interface IStore

Namespace: Libplanet.Store
Assembly: Libplanet.dll
Syntax
public interface IStore

Methods

| Improve this Doc View Source

AppendIndex(String, HashDigest<SHA256>)

Declaration
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
long CountBlocks()
Returns
Type Description
Int64
| Improve this Doc View Source

CountIndex(String)

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

CountTransactions()

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

DeleteBlock(HashDigest<SHA256>)

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

DeleteTransaction(TxId)

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

Forks state references, which are Hashes that have the state of the Addresses, from sourceNamespace to destinationNamespace.

This method copies state references from sourceNamespace to destinationNamespace and strips addressesToStrip of state references after branchPoint.

Declaration
void ForkStateReferences<T>(string sourceNamespace, string destinationNamespace, Block<T> branchPoint, IImmutableSet<Address> addressesToStrip)
    where T : IAction, new()
Parameters
Type Name Description
String sourceNamespace

The namespace of state references to fork.
String destinationNamespace

The namespace of destination state references.
Block<T> branchPoint

The branch point Block<T> to fork.
IImmutableSet<Address> addressesToStrip

The set of Addresses to strip Hash after forking.
Type Parameters
Name Description
T

An IAction class used with branchPoint.
Exceptions
Type Condition
NamespaceNotFoundException

Thrown when the given sourceNamespace does not exist.
See Also
| Improve this Doc View Source

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

Forks Transaction<T> nonces from sourceNamespace to destinationNamespace.

This method copies Transaction<T> nonces from sourceNamespace to destinationNamespace and strips addressesToStrip of nonces after branchPoint.

Declaration
void ForkTxNonce<T>(string sourceNamespace, string destinationNamespace, Block<T> branchPoint, IImmutableSet<Address> addressesToStrip)
    where T : IAction, new()
Parameters
Type Name Description
String sourceNamespace

The namespace of Transaction<T> nonces to fork.
String destinationNamespace

The namespace of destination Transaction<T> nonces.
Block<T> branchPoint

The branch point Block<T> to fork.
IImmutableSet<Address> addressesToStrip

The set of Addresses to strip Transaction<T> nonces after forking.
Type Parameters
Name Description
T

An IAction class used with branchPoint.
Exceptions
Type Condition
NamespaceNotFoundException

Thrown when the given sourceNamespace does not exist.
See Also
| Improve this Doc View Source

GetBlock<T>(HashDigest<SHA256>)

Declaration
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
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
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
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<T>(String, Block<T>)

Increases Transaction<T> of Signer in the block.

Declaration
void IncreaseTxNonce<T>(string namespace, Block<T> block)
    where T : IAction, new()
Parameters
Type Name Description
String namespace

The namespace to increase Transaction<T> nonce.
Block<T> block

The Block<T> which has the Transaction<T>s.
Type Parameters
Name Description
T

An IAction class used with block.
See Also
| Improve this Doc View Source

IndexBlockHash(String, Int64)

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

IterateIndex(String)

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

IterateStagedTransactionIds()

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

IterateTransactionIds()

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

ListNamespaces()

Lists existing namespaces.

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

Existing namespaces.
| Improve this Doc View Source

LookupStateReference<T>(String, Address, Block<T>)

Looks up a state reference, which is a Hash that has the state of the address.

Declaration
HashDigest<SHA256>? LookupStateReference<T>(string namespace, Address address, Block<T> lookupUntil)
    where T : IAction, new()
Parameters
Type Name Description
String namespace

The namespace to look up a state reference.
Address address

The Address to look up.
Block<T> lookupUntil

The upper bound (i.e., the latest block) of the search range. Block<T>s after lookupUntil are ignored.
Returns
Type Description
Nullable<HashDigest<SHA256>>

A Hash which has the state of the address.
Type Parameters
Name Description
T

An IAction class used with lookupUntil.
See Also
| Improve this Doc View Source

PutBlock<T>(Block<T>)

Puts the given block in to the store.

Declaration
void PutBlock<T>(Block<T> block)
    where T : IAction, new()
Parameters
Type Name Description
Block<T> block

A Block<T> to put into the store.
Type Parameters
Name Description
T

An IAction class used with block.
| Improve this Doc View Source

PutTransaction<T>(Transaction<T>)

Declaration
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
void SetBlockStates(HashDigest<SHA256> blockHash, AddressStateMap states)
Parameters
Type Name Description
HashDigest<SHA256> blockHash
AddressStateMap states
| Improve this Doc View Source

StageTransactionIds(ISet<TxId>)

Declaration
void StageTransactionIds(ISet<TxId> txids)
Parameters
Type Name Description
ISet<TxId> txids
| Improve this Doc View Source

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

Stores a state reference, which is a Hash that has the state of the Address for each updated Addresses by the Transaction<T>s in the block.

Declaration
void StoreStateReference<T>(string namespace, IImmutableSet<Address> addresses, Block<T> block)
    where T : IAction, new()
Parameters
Type Name Description
String namespace

The namespace to store a state reference.
IImmutableSet<Address> addresses

The Addresses to store state reference.
Block<T> block

The Block<T> which has the state of the Address.
Type Parameters
Name Description
T

An IAction class used with block.
See Also
| Improve this Doc View Source

UnstageTransactionIds(ISet<TxId>)

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