Class VoteMetadata

Represents a vote metadata from a validator for consensus.

Inheritance
Object
VoteMetadata
Implements
Bencodex.IBencodable
Inherited Members
Namespace: Libplanet.Types.Consensus
Assembly: Libplanet.Types.dll
Syntax
public class VoteMetadata : IVoteMetadata, IEquatable<VoteMetadata>, IBencodable

Constructors

| Improve this Doc View Source

VoteMetadata(IValue)

Represents a vote metadata from a validator for consensus.

Declaration
public VoteMetadata(IValue bencoded)
Parameters
Type Name Description
Bencodex.Types.IValue bencoded
| Improve this Doc View Source

VoteMetadata(Int64, Int32, BlockHash, DateTimeOffset, PublicKey, VoteFlag)

Creates a VoteMetadata instance.

Declaration
public VoteMetadata(long height, int round, BlockHash blockHash, DateTimeOffset timestamp, PublicKey validatorPublicKey, VoteFlag flag)
Parameters
Type Name Description
Int64 height

Height of the vote target block.
Int32 round

Round of the vote in given height.
BlockHash blockHash

BlockHash of the block in vote.
DateTimeOffset timestamp

The time at which the voting took place.
PublicKey validatorPublicKey

PublicKey of the validator made the vote.
VoteFlag flag

VoteFlag for the vote's status.
Exceptions
Type Condition
ArgumentException

Thrown for any of the following reasons:

  • Either height or round is negative.
  • Given blockHash is null when flag is either Null or Unknown.

Properties

| Improve this Doc View Source

Bencoded

Represents a vote metadata from a validator for consensus.

Declaration
[JsonIgnore]
public IValue Bencoded { get; }
Property Value
Type Description
Bencodex.Types.IValue
| Improve this Doc View Source

BlockHash

BlockHash of the block in vote. If default, vote nil.

Declaration
public BlockHash BlockHash { get; }
Property Value
Type Description
BlockHash
| Improve this Doc View Source

Flag

The VoteFlag indicating the type of a Vote.

Declaration
public VoteFlag Flag { get; }
Property Value
Type Description
VoteFlag
| Improve this Doc View Source

Height

Height of the vote target block.

Declaration
public long Height { get; }
Property Value
Type Description
Int64
| Improve this Doc View Source

Round

Round of the vote in given height.

Declaration
public int Round { get; }
Property Value
Type Description
Int32
| Improve this Doc View Source

Timestamp

The time at which the voting took place.

Declaration
public DateTimeOffset Timestamp { get; }
Property Value
Type Description
DateTimeOffset
| Improve this Doc View Source

ValidatorPublicKey

The PublicKey of the validator that voted.

Declaration
public PublicKey ValidatorPublicKey { get; }
Property Value
Type Description
PublicKey

Methods

| Improve this Doc View Source

Equals(VoteMetadata)

Represents a vote metadata from a validator for consensus.

Declaration
public bool Equals(VoteMetadata other)
Parameters
Type Name Description
VoteMetadata other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Object)

Represents a vote metadata from a validator for consensus.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj
Returns
Type Description
Boolean
Overrides
| Improve this Doc View Source

GetHashCode()

Represents a vote metadata from a validator for consensus.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

Sign(PrivateKey)

Signs a VoteMetadata to create a Vote using given signer.

Declaration
public Vote Sign(PrivateKey signer)
Parameters
Type Name Description
PrivateKey signer

The PrivateKey to sign the data with. This can be null to create an unsigned Vote instance.
Returns
Type Description
Vote

A Vote with a (possibly null) signature.

Implements

Bencodex.IBencodable