cosmos-sdk/x/stake/types/pool.go

package types

import (
	"bytes"
	"fmt"

	sdk "github.com/cosmos/cosmos-sdk/types"
)

// Pool - dynamic parameters of the current state
type Pool struct {
	LooseTokens       int64   `json:"loose_tokens"`        // tokens not associated with any validator
	UnbondedTokens    int64   `json:"unbonded_tokens"`     // reserve of unbonded tokens held with validators
	UnbondingTokens   int64   `json:"unbonding_tokens"`    // tokens moving from bonded to unbonded pool
	BondedTokens      int64   `json:"bonded_tokens"`       // reserve of bonded tokens
	UnbondedShares    sdk.Rat `json:"unbonded_shares"`     // sum of all shares distributed for the Unbonded Pool
	UnbondingShares   sdk.Rat `json:"unbonding_shares"`    // shares moving from Bonded to Unbonded Pool
	BondedShares      sdk.Rat `json:"bonded_shares"`       // sum of all shares distributed for the Bonded Pool
	InflationLastTime int64   `json:"inflation_last_time"` // block which the last inflation was processed // TODO make time
	Inflation         sdk.Rat `json:"inflation"`           // current annual inflation rate

	DateLastCommissionReset int64 `json:"date_last_commission_reset"` // unix timestamp for last commission accounting reset (daily)

	// Fee Related
	PrevBondedShares sdk.Rat `json:"prev_bonded_shares"` // last recorded bonded shares - for fee calculations
}

// nolint
func (p Pool) Equal(p2 Pool) bool {
	bz1 := MsgCdc.MustMarshalBinary(&p)
	bz2 := MsgCdc.MustMarshalBinary(&p2)
	return bytes.Equal(bz1, bz2)
}

// initial pool for testing
func InitialPool() Pool {
	return Pool{
		LooseTokens:             0,
		BondedTokens:            0,
		UnbondingTokens:         0,
		UnbondedTokens:          0,
		BondedShares:            sdk.ZeroRat(),
		UnbondingShares:         sdk.ZeroRat(),
		UnbondedShares:          sdk.ZeroRat(),
		InflationLastTime:       0,
		Inflation:               sdk.NewRat(7, 100),
		DateLastCommissionReset: 0,
		PrevBondedShares:        sdk.ZeroRat(),
	}
}

//____________________________________________________________________

// Sum total of all staking tokens in the pool
func (p Pool) TokenSupply() int64 {
	return p.LooseTokens + p.UnbondedTokens + p.UnbondingTokens + p.BondedTokens
}

//____________________________________________________________________

// get the bond ratio of the global state
func (p Pool) BondedRatio() sdk.Rat {
	if p.TokenSupply() > 0 {
		return sdk.NewRat(p.BondedTokens, p.TokenSupply())
	}
	return sdk.ZeroRat()
}

// get the exchange rate of bonded token per issued share
func (p Pool) BondedShareExRate() sdk.Rat {
	if p.BondedShares.IsZero() {
		return sdk.OneRat()
	}
	return sdk.NewRat(p.BondedTokens).Quo(p.BondedShares)
}

// get the exchange rate of unbonding tokens held in validators per issued share
func (p Pool) UnbondingShareExRate() sdk.Rat {
	if p.UnbondingShares.IsZero() {
		return sdk.OneRat()
	}
	return sdk.NewRat(p.UnbondingTokens).Quo(p.UnbondingShares)
}

// get the exchange rate of unbonded tokens held in validators per issued share
func (p Pool) UnbondedShareExRate() sdk.Rat {
	if p.UnbondedShares.IsZero() {
		return sdk.OneRat()
	}
	return sdk.NewRat(p.UnbondedTokens).Quo(p.UnbondedShares)
}

//_______________________________________________________________________

func (p Pool) addTokensUnbonded(amount int64) (p2 Pool, issuedShares PoolShares) {
	issuedSharesAmount := sdk.NewRat(amount).Quo(p.UnbondedShareExRate()) // tokens * (shares/tokens)
	p.UnbondedShares = p.UnbondedShares.Add(issuedSharesAmount)
	p.UnbondedTokens += amount
	p.LooseTokens -= amount
	if p.LooseTokens < 0 {
		panic(fmt.Sprintf("sanity check: loose tokens negative, pool: %v", p))
	}
	return p, NewUnbondedShares(issuedSharesAmount)
}

func (p Pool) removeSharesUnbonded(shares sdk.Rat) (p2 Pool, removedTokens int64) {
	removedTokens = p.UnbondedShareExRate().Mul(shares).RoundInt64() // (tokens/shares) * shares
	p.UnbondedShares = p.UnbondedShares.Sub(shares)
	p.UnbondedTokens -= removedTokens
	p.LooseTokens += removedTokens
	if p.UnbondedTokens < 0 {
		panic(fmt.Sprintf("sanity check: unbonded tokens negative, pool: %v", p))
	}
	return p, removedTokens
}

func (p Pool) addTokensUnbonding(amount int64) (p2 Pool, issuedShares PoolShares) {
	issuedSharesAmount := sdk.NewRat(amount).Quo(p.UnbondingShareExRate()) // tokens * (shares/tokens)
	p.UnbondingShares = p.UnbondingShares.Add(issuedSharesAmount)
	p.UnbondingTokens += amount
	p.LooseTokens -= amount
	if p.LooseTokens < 0 {
		panic(fmt.Sprintf("sanity check: loose tokens negative, pool: %v", p))
	}
	return p, NewUnbondingShares(issuedSharesAmount)
}

func (p Pool) removeSharesUnbonding(shares sdk.Rat) (p2 Pool, removedTokens int64) {
	removedTokens = p.UnbondingShareExRate().Mul(shares).RoundInt64() // (tokens/shares) * shares
	p.UnbondingShares = p.UnbondingShares.Sub(shares)
	p.UnbondingTokens -= removedTokens
	p.LooseTokens += removedTokens
	if p.UnbondedTokens < 0 {
		panic(fmt.Sprintf("sanity check: unbonding tokens negative, pool: %v", p))
	}
	return p, removedTokens
}

func (p Pool) addTokensBonded(amount int64) (p2 Pool, issuedShares PoolShares) {
	issuedSharesAmount := sdk.NewRat(amount).Quo(p.BondedShareExRate()) // tokens * (shares/tokens)
	p.BondedShares = p.BondedShares.Add(issuedSharesAmount)
	p.BondedTokens += amount
	p.LooseTokens -= amount
	if p.LooseTokens < 0 {
		panic(fmt.Sprintf("sanity check: loose tokens negative, pool: %v", p))
	}
	return p, NewBondedShares(issuedSharesAmount)
}

func (p Pool) removeSharesBonded(shares sdk.Rat) (p2 Pool, removedTokens int64) {
	removedTokens = p.BondedShareExRate().Mul(shares).RoundInt64() // (tokens/shares) * shares
	p.BondedShares = p.BondedShares.Sub(shares)
	p.BondedTokens -= removedTokens
	p.LooseTokens += removedTokens
	if p.UnbondedTokens < 0 {
		panic(fmt.Sprintf("sanity check: bonded tokens negative, pool: %v", p))
	}
	return p, removedTokens
}