Class ProposalClaimMetadata

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Inheritance

Object

ProposalClaimMetadata

Implements

IEquatable<ProposalClaimMetadata>

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Libplanet.Consensus

Assembly: Libplanet.dll

Syntax

public class ProposalClaimMetadata : IEquatable<ProposalClaimMetadata>

Constructors

| Improve this Doc View Source

ProposalClaimMetadata(Dictionary)

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Declaration

public ProposalClaimMetadata(Dictionary encoded)

Parameters

Type	Name	Description
Bencodex.Types.Dictionary	encoded

| Improve this Doc View Source

ProposalClaimMetadata(Int64, Int32, BlockHash, DateTimeOffset, PublicKey)

Instantiates ProposalClaimMetadata with given parameters.

Declaration

public ProposalClaimMetadata(long height, int round, BlockHash blockHash, DateTimeOffset timestamp, PublicKey validatorPublicKey)

Parameters

Type	Name	Description
Int64	height	A height of given claim values.
Int32	round	A round of given claim values.
BlockHash	blockHash	A BlockHash of given proposal to claim.
DateTimeOffset	timestamp	The time at which the proposal took place.
PublicKey	validatorPublicKey	a PublicKey of proposing validator.

Exceptions

Type	Condition
ArgumentOutOfRangeException	This can be thrown in following reasons: Given `height` is less than 0. Given `round` is less than 0.

Properties

| Improve this Doc View Source

BlockHash

The BlockHash of Proposal to claim.

Declaration

public BlockHash BlockHash { get; }

Property Value

Type	Description
BlockHash

| Improve this Doc View Source

ByteArray

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Declaration

public ImmutableArray<byte> ByteArray { get; }

Property Value

Type	Description
ImmutableArray<Byte>

| Improve this Doc View Source

Encoded

A Bencodex-encoded value of ProposalMetadata.

Declaration

[JsonIgnore]
public Dictionary Encoded { get; }

Property Value

Type	Description
Bencodex.Types.Dictionary

| Improve this Doc View Source

Height

A height of given proposal values.

Declaration

public long Height { get; }

Property Value

Type	Description
Int64

| Improve this Doc View Source

Round

A round of given proposal values.

Declaration

public int Round { get; }

Property Value

Type	Description
Int32

| Improve this Doc View Source

Timestamp

The time at which the proposal took place.

Declaration

public DateTimeOffset Timestamp { get; }

Property Value

Type	Description
DateTimeOffset

| Improve this Doc View Source

ValidatorPublicKey

A PublicKey of proposing validator.

Declaration

public PublicKey ValidatorPublicKey { get; }

Property Value

Type	Description
PublicKey

Methods

| Improve this Doc View Source

Equals(ProposalClaimMetadata)

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Declaration

public bool Equals(ProposalClaimMetadata other)

Parameters

Type	Name	Description
ProposalClaimMetadata	other

Returns

Type	Description
Boolean

| Improve this Doc View Source

Equals(Object)

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

| Improve this Doc View Source

GetHashCode()

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

| Improve this Doc View Source

Sign(PrivateKey)

Signs given ProposalMetadata with given signer.

Declaration

public ProposalClaim Sign(PrivateKey signer)

Parameters

Type	Name	Description
PrivateKey	signer	A PrivateKey to sign.

Returns

Type	Description
ProposalClaim	Returns a signed Proposal.

| Improve this Doc View Source

ToByteArray()

A class for constructing ProposalClaim. This class contains proposal claim information in consensus of a height, round and BlockHash. Use Sign(PrivateKey) to create a ProposalClaim.

Declaration

public byte[] ToByteArray()

Returns

Type	Description
Byte[]

Implements

System.IEquatable<T>