Class PoolInfoResponse

Namespace

Concordium.Grpc.V2

Assembly

Concordium.Sdk.dll

Type for the response of GetPoolInfo. Contains information about a given pool at the end of a given block. From protocol version 7, pool removal has immediate effect, however, the pool may still be present for the current (and possibly next) reward period. In this case, the current_payday_info field will be set, but the equity_capital, delegated_capital, delegated_capital_cap and, pool_info fields will all be absent. The equity_pending_change field will also be absent, as stake changes are immediate.

public sealed class PoolInfoResponse : IMessage<PoolInfoResponse>, IEquatable<PoolInfoResponse>, IDeepCloneable<PoolInfoResponse>, IBufferMessage, IMessage

Inheritance

object

PoolInfoResponse

Implements

IMessage<PoolInfoResponse>

IEquatable<PoolInfoResponse>

IDeepCloneable<PoolInfoResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PoolInfoResponse()

public PoolInfoResponse()

PoolInfoResponse(PoolInfoResponse)

public PoolInfoResponse(PoolInfoResponse other)

Parameters

other PoolInfoResponse

Fields

AddressFieldNumber

Field number for the "address" field.

public const int AddressFieldNumber = 2

Field Value

int

AllPoolTotalCapitalFieldNumber

Field number for the "all_pool_total_capital" field.

public const int AllPoolTotalCapitalFieldNumber = 9

Field Value

int

BakerFieldNumber

Field number for the "baker" field.

public const int BakerFieldNumber = 1

Field Value

int

CurrentPaydayInfoFieldNumber

Field number for the "current_payday_info" field.

public const int CurrentPaydayInfoFieldNumber = 8

Field Value

int

DelegatedCapitalCapFieldNumber

Field number for the "delegated_capital_cap" field.

public const int DelegatedCapitalCapFieldNumber = 5

Field Value

int

DelegatedCapitalFieldNumber

Field number for the "delegated_capital" field.

public const int DelegatedCapitalFieldNumber = 4

Field Value

int

EquityCapitalFieldNumber

Field number for the "equity_capital" field.

public const int EquityCapitalFieldNumber = 3

Field Value

int

EquityPendingChangeFieldNumber

Field number for the "equity_pending_change" field.

public const int EquityPendingChangeFieldNumber = 7

Field Value

int

PoolInfoFieldNumber

Field number for the "pool_info" field.

public const int PoolInfoFieldNumber = 6

Field Value

int

Properties

Address

The account address of the pool owner.

public AccountAddress Address { get; set; }

Property Value

AccountAddress

AllPoolTotalCapital

Total capital staked across all pools, including passive delegation.

public Amount AllPoolTotalCapital { get; set; }

Property Value

Amount

Baker

The 'BakerId' of the pool owner.

public BakerId Baker { get; set; }

Property Value

BakerId

CurrentPaydayInfo

Information of the pool in the current reward period.

public PoolCurrentPaydayInfo CurrentPaydayInfo { get; set; }

Property Value

PoolCurrentPaydayInfo

DelegatedCapital

The capital delegated to the pool by other accounts. Absent if the pool is removed.

public Amount DelegatedCapital { get; set; }

Property Value

Amount

DelegatedCapitalCap

The maximum amount that may be delegated to the pool, accounting for leverage and stake limits. Absent if the pool is removed.

public Amount DelegatedCapitalCap { get; set; }

Property Value

Amount

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

EquityCapital

The equity capital provided by the pool owner. Absent if the pool is removed.

public Amount EquityCapital { get; set; }

Property Value

Amount

EquityPendingChange

Any pending change to the equity capital. This is not used from protocol version 7 onwards, as stake changes are immediate.

public PoolPendingChange EquityPendingChange { get; set; }

Property Value

PoolPendingChange

Parser

public static MessageParser<PoolInfoResponse> Parser { get; }

Property Value

MessageParser<PoolInfoResponse>

PoolInfo

The pool info associated with the pool: open status, metadata URL and commission rates. Absent if the pool is removed.

public BakerPoolInfo PoolInfo { get; set; }

Property Value

BakerPoolInfo

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public PoolInfoResponse Clone()

Returns

PoolInfoResponse

A deep clone of this object.

Equals(PoolInfoResponse)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(PoolInfoResponse other)

Parameters

other PoolInfoResponse

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

MergeFrom(PoolInfoResponse)

Merges the given message into this one.

public void MergeFrom(PoolInfoResponse other)

Parameters

other PoolInfoResponse

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.