129 lines
4.2 KiB
Go
129 lines
4.2 KiB
Go
package types
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
)
|
|
|
|
type (
|
|
// Commission defines a commission parameters for a given validator.
|
|
Commission struct {
|
|
Rate sdk.Dec `json:"rate"` // the commission rate charged to delegators
|
|
MaxRate sdk.Dec `json:"max_rate"` // maximum commission rate which validator can ever charge
|
|
MaxChangeRate sdk.Dec `json:"max_change_rate"` // maximum daily increase of the validator commission
|
|
UpdateTime time.Time `json:"update_time"` // the last time the commission rate was changed
|
|
}
|
|
|
|
// CommissionMsg defines a commission message to be used for creating a
|
|
// validator.
|
|
CommissionMsg struct {
|
|
Rate sdk.Dec `json:"rate"` // the commission rate charged to delegators
|
|
MaxRate sdk.Dec `json:"max_rate"` // maximum commission rate which validator can ever charge
|
|
MaxChangeRate sdk.Dec `json:"max_change_rate"` // maximum daily increase of the validator commission
|
|
}
|
|
)
|
|
|
|
// NewCommissionMsg returns an initialized validator commission message.
|
|
func NewCommissionMsg(rate, maxRate, maxChangeRate sdk.Dec) CommissionMsg {
|
|
return CommissionMsg{
|
|
Rate: rate,
|
|
MaxRate: maxRate,
|
|
MaxChangeRate: maxChangeRate,
|
|
}
|
|
}
|
|
|
|
// NewCommission returns an initialized validator commission.
|
|
func NewCommission(rate, maxRate, maxChangeRate sdk.Dec) Commission {
|
|
return Commission{
|
|
Rate: rate,
|
|
MaxRate: maxRate,
|
|
MaxChangeRate: maxChangeRate,
|
|
UpdateTime: time.Unix(0, 0).UTC(),
|
|
}
|
|
}
|
|
|
|
// NewCommission returns an initialized validator commission with a specified
|
|
// update time which should be the current block BFT time.
|
|
func NewCommissionWithTime(rate, maxRate, maxChangeRate sdk.Dec, updatedAt time.Time) Commission {
|
|
return Commission{
|
|
Rate: rate,
|
|
MaxRate: maxRate,
|
|
MaxChangeRate: maxChangeRate,
|
|
UpdateTime: updatedAt,
|
|
}
|
|
}
|
|
|
|
// Equal checks if the given Commission object is equal to the receiving
|
|
// Commission object.
|
|
func (c Commission) Equal(c2 Commission) bool {
|
|
return c.Rate.Equal(c2.Rate) &&
|
|
c.MaxRate.Equal(c2.MaxRate) &&
|
|
c.MaxChangeRate.Equal(c2.MaxChangeRate) &&
|
|
c.UpdateTime.Equal(c2.UpdateTime)
|
|
}
|
|
|
|
// String implements the Stringer interface for a Commission.
|
|
func (c Commission) String() string {
|
|
return fmt.Sprintf("rate: %s, maxRate: %s, maxChangeRate: %s, updateTime: %s",
|
|
c.Rate, c.MaxRate, c.MaxChangeRate, c.UpdateTime,
|
|
)
|
|
}
|
|
|
|
// Validate performs basic sanity validation checks of initial commission
|
|
// parameters. If validation fails, an SDK error is returned.
|
|
func (c Commission) Validate() sdk.Error {
|
|
switch {
|
|
case c.MaxRate.LT(sdk.ZeroDec()):
|
|
// max rate cannot be negative
|
|
return ErrCommissionNegative(DefaultCodespace)
|
|
|
|
case c.MaxRate.GT(sdk.OneDec()):
|
|
// max rate cannot be greater than 100%
|
|
return ErrCommissionHuge(DefaultCodespace)
|
|
|
|
case c.Rate.LT(sdk.ZeroDec()):
|
|
// rate cannot be negative
|
|
return ErrCommissionNegative(DefaultCodespace)
|
|
|
|
case c.Rate.GT(c.MaxRate):
|
|
// rate cannot be greater than the max rate
|
|
return ErrCommissionGTMaxRate(DefaultCodespace)
|
|
|
|
case c.MaxChangeRate.LT(sdk.ZeroDec()):
|
|
// change rate cannot be negative
|
|
return ErrCommissionChangeRateNegative(DefaultCodespace)
|
|
|
|
case c.MaxChangeRate.GT(c.MaxRate):
|
|
// change rate cannot be greater than the max rate
|
|
return ErrCommissionChangeRateGTMaxRate(DefaultCodespace)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// ValidateNewRate performs basic sanity validation checks of a new commission
|
|
// rate. If validation fails, an SDK error is returned.
|
|
func (c Commission) ValidateNewRate(newRate sdk.Dec, blockTime time.Time) sdk.Error {
|
|
switch {
|
|
case blockTime.Sub(c.UpdateTime).Hours() < 24:
|
|
// new rate cannot be changed more than once within 24 hours
|
|
return ErrCommissionUpdateTime(DefaultCodespace)
|
|
|
|
case newRate.LT(sdk.ZeroDec()):
|
|
// new rate cannot be negative
|
|
return ErrCommissionNegative(DefaultCodespace)
|
|
|
|
case newRate.GT(c.MaxRate):
|
|
// new rate cannot be greater than the max rate
|
|
return ErrCommissionGTMaxRate(DefaultCodespace)
|
|
|
|
case newRate.Sub(c.Rate).Abs().GT(c.MaxChangeRate):
|
|
// new rate % points change cannot be greater than the max change rate
|
|
return ErrCommissionGTMaxChangeRate(DefaultCodespace)
|
|
}
|
|
|
|
return nil
|
|
}
|