Class Block<T>

Inheritance

Object

Block<T>

Implements

ISerializable

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: Libplanet.Blocks

Assembly: Libplanet.dll

Syntax

[Equals]
public class Block<T> : ISerializable where T : IAction, new()

Type Parameters

Name	Description
T

Constructors

Block(Int64, Int64, Nonce, Nullable<Address>, Nullable<HashDigest<SHA256>>, DateTimeOffset, IEnumerable<Transaction<T>>)

Declaration

public Block(long index, long difficulty, Nonce nonce, Address? miner, HashDigest<SHA256>? previousHash, DateTimeOffset timestamp, IEnumerable<Transaction<T>> transactions)

Parameters

Type	Name	Description
Int64	index
Int64	difficulty
Nonce	nonce
Nullable<Address>	miner
Nullable<HashDigest<SHA256>>	previousHash
DateTimeOffset	timestamp
IEnumerable<Transaction<T>>	transactions

Block(SerializationInfo, StreamingContext)

Declaration

protected Block(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info
StreamingContext	context

Properties

Difficulty

Declaration

[IgnoreDuringEquals]
public long Difficulty { get; }

Property Value

Type	Description
Int64

Hash

Declaration

public HashDigest<SHA256> Hash { get; }

Property Value

Type	Description
HashDigest<SHA256>

Index

Declaration

[IgnoreDuringEquals]
public long Index { get; }

Property Value

Type	Description
Int64

Miner

Declaration

[IgnoreDuringEquals]
public Address? Miner { get; }

Property Value

Type	Description
Nullable<Address>

Nonce

Declaration

[IgnoreDuringEquals]
public Nonce Nonce { get; }

Property Value

Type	Description
Nonce

PreviousHash

Declaration

[IgnoreDuringEquals]
public HashDigest<SHA256>? PreviousHash { get; }

Property Value

Type	Description
Nullable<HashDigest<SHA256>>

Timestamp

Declaration

[IgnoreDuringEquals]
public DateTimeOffset Timestamp { get; }

Property Value

Type	Description
DateTimeOffset

Transactions

Declaration

[IgnoreDuringEquals]
public IEnumerable<Transaction<T>> Transactions { get; }

Property Value

Type	Description
IEnumerable<Transaction<T>>

Methods

Evaluate(DateTimeOffset, AccountStateGetter)

Executes every IAction in the Transactions and gets result states of each step of every Transaction<T>.

It throws an InvalidBlockException or an InvalidTxException if there is any integrity error.

Otherwise it enumerates an ActionEvaluation<T> for each IAction.

Declaration

public IEnumerable<ActionEvaluation<T>> Evaluate(DateTimeOffset currentTime, AccountStateGetter accountStateGetter)

Parameters

Type	Name	Description
DateTimeOffset	currentTime	The current time to validate time-wise conditions.
AccountStateGetter	accountStateGetter	The getter of previous states. This affects the execution of Actions.

Returns

Type	Description
IEnumerable<ActionEvaluation<T>>	An ActionEvaluation<T> for each IAction.

Exceptions

Type	Condition
InvalidBlockTimestampException	Thrown when the Timestamp is invalid, for example, it is the far future than the given currentTime.
InvalidBlockIndexException	Thrown when the Indexis invalid, for example, it is a negative integer.
InvalidBlockDifficultyException	Thrown when the Difficulty is not properly configured, for example, it is too easy.
InvalidBlockPreviousHashException	Thrown when PreviousHash is invalid so that the Block<T>s are not continuous.
InvalidBlockNonceException	Thrown when the Nonce does not satisfy its Difficulty level.
InvalidTxSignatureException	Thrown when its Signature is invalid or not signed by the account who corresponds to its PublicKey.
InvalidTxPublicKeyException	Thrown when its Signer is not derived from its PublicKey.
InvalidTxUpdatedAddressesException	Thrown when any IAction of Transactions tries to update the states of Addresses not included in UpdatedAddresses.

EvaluateActionsPerTx(AccountStateGetter)

Executes every IAction in the Transactions step by step, and emits a pair of a transaction, and an ActionEvaluation<T> for each step.

Declaration

[Pure]
public IEnumerable<(Transaction<T>, ActionEvaluation<T>)> EvaluateActionsPerTx(AccountStateGetter accountStateGetter = null)

Parameters

Type	Name	Description
AccountStateGetter	accountStateGetter	An AccountStateGetter delegate to get a previous state. A null value, which is default, means a constant function that returns null.

Returns

Type	Description
IEnumerable<ValueTuple<Transaction<T>, ActionEvaluation<T>>>	Enumerates pair of a transaction, and ActionEvaluation<T> for each action. The order of pairs are the same to the Transactions and their Actions (e.g., tx¹-act¹, tx¹-act², tx²-act¹, tx²-act², …). Note that each Random object has a unconsumed state.

FromBencodex(Byte[])

Declaration

public static Block<T> FromBencodex(byte[] encoded)

Parameters

Type	Name	Description
Byte[]	encoded

Returns

Type	Description
Block<T>

GetObjectData(SerializationInfo, StreamingContext)

Declaration

public void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info
StreamingContext	context

Mine(Int64, Int64, Address, Nullable<HashDigest<SHA256>>, DateTimeOffset, IEnumerable<Transaction<T>>)

Declaration

public static Block<T> Mine(long index, long difficulty, Address miner, HashDigest<SHA256>? previousHash, DateTimeOffset timestamp, IEnumerable<Transaction<T>> transactions)

Parameters

Type	Name	Description
Int64	index
Int64	difficulty
Address	miner
Nullable<HashDigest<SHA256>>	previousHash
DateTimeOffset	timestamp
IEnumerable<Transaction<T>>	transactions

Returns

Type	Description
Block<T>

ToBencodex(Boolean, Boolean)

Declaration

public byte[] ToBencodex(bool hash, bool transactionData)

Parameters

Type	Name	Description
Boolean	hash
Boolean	transactionData

Returns

Type	Description
Byte[]

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Implements

System.Runtime.Serialization.ISerializable