Interface IBlockChainStates

A minimal interface to get states from a .

Note that implements this interface.

Namespace: Libplanet.Action.State

Assembly: Libplanet.Action.dll

Syntax

public interface IBlockChainStates

Methods

GetBalance(Address, Currency, Nullable<BlockHash>)

Gets address's balance for given currency in the at offset.

Declaration

FungibleAssetValue GetBalance(Address address, Currency currency, BlockHash? offset)

Parameters

Type	Name	Description
Address	address	The owner Address to query.
Currency	currency	The currency type to query.
Nullable<BlockHash>	offset	The BlockHash of the Block to fetch the states from.

Returns

Type	Description
FungibleAssetValue	The address's balance for currency at offset. If absent, returns 0 FungibleAssetValue for currency.

Exceptions

Type	Condition
ArgumentException	Thrown when IBlockState at offset cannot be created.

GetBlockState(Nullable<BlockHash>)

Returns the IBlockState in the at offset.

Declaration

IBlockState GetBlockState(BlockHash? offset)

Parameters

Type	Name	Description
Nullable<BlockHash>	offset	The BlockHash of the Block to create for which to create an IBlockState.

Returns

Type	Description
IBlockState	The IBlockState at offset.

Exceptions

Type	Condition
ArgumentException	Thrown when offset is not null and one of the following is true. Corresponding Block is not found in the IStore. Corresponding Block is found but its state root is not found in the IStateStore.

See Also

IBlockState

GetState(Address, Nullable<BlockHash>)

Gets a state associated to specified address.

Declaration

IValue GetState(Address address, BlockHash? offset)

Parameters

Type	Name	Description
Address	address	The Address of the state to query.
Nullable<BlockHash>	offset	The BlockHash of the Block to fetch the states from.

Returns

Type	Description
Bencodex.Types.IValue	The state associated to specified address. An absent state is represented as null. The returned value must be the same as the single element when retrieved via GetStates(IReadOnlyList<Address>, Nullable<BlockHash>).

Remarks

For performance reasons, it is generally recommended to use GetStates(IReadOnlyList<Address>, Nullable<BlockHash>) with a batch of Addresses instead of iterating over this method.

Exceptions

Type	Condition
ArgumentException	Thrown when offset is not null and one of the following is true. Corresponding Block is not found in the IStore. Corresponding Block is found but its state root is not found in the IStateStore.

GetStates(IReadOnlyList<Address>, Nullable<BlockHash>)

Gets multiple states associated to specified addresses.

Declaration

IReadOnlyList<IValue> GetStates(IReadOnlyList<Address> addresses, BlockHash? offset)

Parameters

Type	Name	Description
IReadOnlyList<Address>	addresses	The Addresses of the states to query.
Nullable<BlockHash>	offset	The BlockHash of the Block to fetch the states from.

Returns

Type	Description
IReadOnlyList<Bencodex.Types.IValue>	The states associated to specified addresses. Associated values are ordered in the same way to the corresponding addresses. Absent states are represented as null. Hence, the returned IReadOnlyList<T> is guarenteeed to be of the same length as addresses with possible null values.

Exceptions

Type	Condition
ArgumentException	Thrown when offset is not null and one of the following is true. Corresponding Block is not found in the IStore. Corresponding Block is found but its state root is not found in the IStateStore.

GetTotalSupply(Currency, Nullable<BlockHash>)

Gets the total supply of a currency in the at offset, and if not found, returns 0.

Declaration

FungibleAssetValue GetTotalSupply(Currency currency, BlockHash? offset)

Parameters

Type	Name	Description
Currency	currency	The currency type to query.
Nullable<BlockHash>	offset	The BlockHash of the Block to fetch the states from.

Returns

Type	Description
FungibleAssetValue	The total supply value of currency at offset in FungibleAssetValue. If absent, returns 0 FungibleAssetValue for currency.

Exceptions

Type	Condition
ArgumentException	Thrown when IBlockState at offset cannot be created.
TotalSupplyNotTrackableException	Thrown when given currency's TotalSupplyTrackable is false.

See Also

GetBlockState(Nullable<BlockHash>)

GetValidatorSet(Nullable<BlockHash>)

Returns the validator set in the at offset.

Declaration

ValidatorSet GetValidatorSet(BlockHash? offset)

Parameters

Type	Name	Description
Nullable<BlockHash>	offset	The BlockHash of the Block to fetch the states from.

Returns

Type	Description
ValidatorSet	The validator set of type ValidatorSet at offset.

Exceptions

Type	Condition
ArgumentException	Thrown when IBlockState at offset cannot be created.

See Also

GetBlockState(Nullable<BlockHash>)