Class BakerPoolStatus

Namespace

Concordium.Sdk.Types

Assembly

Concordium.Sdk.dll

The state of the baker currently registered on the account. Current here means "present". This is the information that is being updated by transactions (and rewards). This is in contrast to "epoch baker" which is the state of the baker that is currently eligible for baking.

public sealed record BakerPoolStatus : IEquatable<BakerPoolStatus>

Inheritance

object

BakerPoolStatus

Implements

IEquatable<BakerPoolStatus>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

From protocol version 7, pool removal has immediate effect, however, the pool may still be present for the current (and possibly next) reward period.

Constructors

BakerPoolStatus(BakerId, AccountAddress, CcdAmount?, CcdAmount?, CcdAmount?, BakerPoolInfo?, CurrentPaydayBakerPoolStatus?, CcdAmount, BakerPoolPendingChange?)

The state of the baker currently registered on the account. Current here means "present". This is the information that is being updated by transactions (and rewards). This is in contrast to "epoch baker" which is the state of the baker that is currently eligible for baking.

public BakerPoolStatus(BakerId BakerId, AccountAddress BakerAddress, CcdAmount? BakerEquityCapital, CcdAmount? DelegatedCapital, CcdAmount? DelegatedCapitalCap, BakerPoolInfo? PoolInfo, CurrentPaydayBakerPoolStatus? CurrentPaydayStatus, CcdAmount AllPoolTotalCapital, BakerPoolPendingChange? BakerStakePendingChange)

Parameters

BakerId BakerId

The 'BakerId' of the pool owner.

BakerAddress AccountAddress

The account address of the pool owner.

BakerEquityCapital CcdAmount?

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

DelegatedCapital CcdAmount?

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

DelegatedCapitalCap CcdAmount?

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

PoolInfo BakerPoolInfo

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

CurrentPaydayStatus CurrentPaydayBakerPoolStatus

Status of the pool in the current reward period. This will be null if the pool is not a baker in the payday (e.g., because they just registered and a new payday has not started yet).

AllPoolTotalCapital CcdAmount

Total capital staked across all pools.

BakerStakePendingChange BakerPoolPendingChange

Any pending change to the baker's stake.

Remarks

From protocol version 7, pool removal has immediate effect, however, the pool may still be present for the current (and possibly next) reward period.

Properties

AllPoolTotalCapital

Total capital staked across all pools.

public CcdAmount AllPoolTotalCapital { get; init; }

Property Value

CcdAmount

BakerAddress

The account address of the pool owner.

public AccountAddress BakerAddress { get; init; }

Property Value

AccountAddress

BakerEquityCapital

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

public CcdAmount? BakerEquityCapital { get; init; }

Property Value

CcdAmount?

BakerId

The 'BakerId' of the pool owner.

public BakerId BakerId { get; init; }

Property Value

BakerId

BakerStakePendingChange

Any pending change to the baker's stake.

public BakerPoolPendingChange? BakerStakePendingChange { get; init; }

Property Value

BakerPoolPendingChange

CurrentPaydayStatus

Status of the pool in the current reward period. This will be null if the pool is not a baker in the payday (e.g., because they just registered and a new payday has not started yet).

public CurrentPaydayBakerPoolStatus? CurrentPaydayStatus { get; init; }

Property Value

CurrentPaydayBakerPoolStatus

DelegatedCapital

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

public CcdAmount? DelegatedCapital { get; init; }

Property Value

CcdAmount?

DelegatedCapitalCap

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

public CcdAmount? DelegatedCapitalCap { get; init; }

Property Value

CcdAmount?

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; init; }

Property Value

BakerPoolInfo