threshold.go

package utils

import (
	"fmt"

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

// ZeroThreshold is a threshold that equals to 0
var ZeroThreshold Threshold = NewThreshold(0, 1)

// OneThreshold is a threshold that equals to 1
var OneThreshold Threshold = NewThreshold(1, 1)

// NewThreshold is the constructor for Threshold
func NewThreshold(numerator, denominator int64) Threshold {
	return Threshold{Numerator: numerator, Denominator: denominator}
}

// String returns a string representation of the threshold
func (m Threshold) String() string {
	return fmt.Sprintf("%d/%d", m.Numerator, m.Denominator)
}

// IsMet returns true if share >= threshold * total
func (m Threshold) IsMet(share sdk.Int, total sdk.Int) bool {
	return share.MulRaw(m.Denominator).GTE(total.MulRaw(m.Numerator))
}

// GT returns true if and only if threshold is greater than the given one
func (m Threshold) GT(t Threshold) bool {
	return sdk.NewInt(m.Numerator).MulRaw(t.Denominator).GT(sdk.NewInt(m.Denominator).MulRaw(t.Numerator))
}

// GTE returns true if and only if threshold is greater than or equal to the given one
func (m Threshold) GTE(t Threshold) bool {
	return sdk.NewInt(m.Numerator).MulRaw(t.Denominator).GTE(sdk.NewInt(m.Denominator).MulRaw(t.Numerator))
}

// LT returns true if and only if threshold is less than the given one
func (m Threshold) LT(t Threshold) bool {
	return sdk.NewInt(m.Numerator).MulRaw(t.Denominator).LT(sdk.NewInt(m.Denominator).MulRaw(t.Numerator))
}

// LTE returns true if and only if threshold is less than or equal to the given one
func (m Threshold) LTE(t Threshold) bool {
	return sdk.NewInt(m.Numerator).MulRaw(t.Denominator).LTE(sdk.NewInt(m.Denominator).MulRaw(t.Numerator))
}

// Validate returns an error if threshold is invalid
func (m Threshold) Validate() error {
	if m.Numerator <= 0 {
		return fmt.Errorf("threshold numerator must be a positive integer")
	}

	if m.Denominator <= 0 {
		return fmt.Errorf("threshold denominator must be a positive integer")
	}

	if m.Numerator > m.Denominator {
		return fmt.Errorf("threshold must be <= 1")
	}

	return nil
}