types

package
v0.1.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 26, 2025 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// number of decimal places
	Precision = 18

	// bits required to represent the above precision
	// Ceiling[Log2[10^Precision - 1]]
	DecimalPrecisionBits = 60
)

Variables

View Source 
var (
	ErrInvalidLengthCoin        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowCoin          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupCoin = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var (
	ErrEmptyDecimalStr      = errors.New("decimal string cannot be empty")
	ErrInvalidDecimalLength = errors.New("invalid decimal length")
	ErrInvalidDecimalStr    = errors.New("invalid decimal string")
)

Decimal errors

View Source 
var MaxSortableDec = OneDec().Quo(SmallestDec())

MaxSortableDec is the largest Dec that can be passed into SortableDecBytes() Its negative form is the least Dec that can be passed in.

Functions

func DecEq 

func DecEq(t *testing.T, exp, got Dec) (*testing.T, bool, string, string, string)

intended to be used with require/assert: require.True(DecEq(...))

func DecsEqual 

func DecsEqual(d1s, d2s []Dec) bool

test if two decimal arrays are equal

func DefaultCoinDenomRegex 

func DefaultCoinDenomRegex() string

DefaultCoinDenomRegex returns the default regex string

func GetBaseDenom 

func GetBaseDenom() (string, error)

GetBaseDenom returns the denom of smallest unit registered

func IntEq 

func IntEq(t *testing.T, exp, got Int) (*testing.T, bool, string, string, string)

intended to be used with require/assert: require.True(IntEq(...))

func RegisterDenom 

func RegisterDenom(denom string, unit Dec) error

RegisterDenom registers a denomination with a corresponding unit. If the denomination is already registered, an error will be returned.

func SetCoinDenomRegex 

func SetCoinDenomRegex(reFn func() string)

SetCoinDenomRegex allows for coin's custom validation by overriding the regular expression string used for denom validation.

func SortableDecBytes 

func SortableDecBytes(dec Dec) []byte

SortableDecBytes returns a byte slice representation of a Dec that can be sorted. Left and right pads with 0s so there are 18 digits to left and right of the decimal point. For this reason, there is a maximum and minimum value for this, enforced by ValidSortableDec.

func ValidSortableDec 

func ValidSortableDec(dec Dec) bool

ValidSortableDec ensures that a Dec is within the sortable bounds, a Dec can't have a precision of less than 10^-18. Max sortable decimal was set to the reciprocal of SmallestDec.

func ValidateDenom 

func ValidateDenom(denom string) error

ValidateDenom is the default validation function for Coin.Denom.

Types

type Coin 

type Coin struct {
	Denom  string `protobuf:"bytes,1,opt,name=denom,proto3" json:"denom,omitempty"`
	Amount Int    `protobuf:"bytes,2,opt,name=amount,proto3,customtype=Int" json:"amount"`
}

Coin defines a token with a denomination and an amount.

NOTE: The amount field is an Int which implements the custom method signatures required by gogoproto.

func ConvertCoin 

func ConvertCoin(coin Coin, denom string) (Coin, error)

ConvertCoin attempts to convert a coin to a given denomination. If the given denomination is invalid or if neither denomination is registered, an error is returned.

func NewCoin 

func NewCoin(denom string, amount Int) Coin

NewCoin returns a new coin with a denomination and amount. It will panic if the amount is negative or if the denomination is invalid.

func NewInt64Coin 

func NewInt64Coin(denom string, amount int64) Coin

NewInt64Coin returns a new coin with a denomination and amount. It will panic if the amount is negative.

func NormalizeCoin 

func NormalizeCoin(coin Coin) Coin

NormalizeCoin try to convert a coin to the smallest unit registered, returns original one if failed.

func ParseCoinNormalized 

func ParseCoinNormalized(coinStr string) (coin Coin, err error)

ParseCoinNormalized parses and normalize a cli input for one coin type, returning errors if invalid or on an empty string as well. Expected format: "{amount}{denomination}"

func (Coin) Add 

func (coin Coin) Add(coinB Coin) Coin

Add adds amounts of two coins with same denom. If the coins differ in denom then it panics.

func (Coin) AddAmount 

func (coin Coin) AddAmount(amount Int) Coin

AddAmount adds an amount to the Coin.

func (*Coin) Descriptor 

func (*Coin) Descriptor() ([]byte, []int)

func (*Coin) Equal 

func (this *Coin) Equal(that interface{}) bool

func (*Coin) GetDenom 

func (m *Coin) GetDenom() string

func (Coin) IsEqual 

func (coin Coin) IsEqual(other Coin) bool

IsEqual returns true if the two sets of Coins have the same value

func (Coin) IsGTE 

func (coin Coin) IsGTE(other Coin) bool

IsGTE returns true if they are the same type and the receiver is an equal or greater value

func (Coin) IsLT 

func (coin Coin) IsLT(other Coin) bool

IsLT returns true if they are the same type and the receiver is a smaller value

func (Coin) IsNegative 

func (coin Coin) IsNegative() bool

IsNegative returns true if the coin amount is negative and false otherwise.

TODO: Remove once unsigned integers are used.

func (Coin) IsNil 

func (coin Coin) IsNil() bool

IsNil returns true if the coin amount is nil and false otherwise.

func (Coin) IsPositive 

func (coin Coin) IsPositive() bool

IsPositive returns true if coin amount is positive.

TODO: Remove once unsigned integers are used.

func (Coin) IsValid 

func (coin Coin) IsValid() bool

IsValid returns true if the Coin has a non-negative amount and the denom is valid.

func (Coin) IsZero 

func (coin Coin) IsZero() bool

IsZero returns if this represents no money

func (*Coin) Marshal 

func (m *Coin) Marshal() (dAtA []byte, err error)

func (*Coin) MarshalTo 

func (m *Coin) MarshalTo(dAtA []byte) (int, error)

func (*Coin) MarshalToSizedBuffer 

func (m *Coin) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Coin) ProtoMessage 

func (*Coin) ProtoMessage()

func (*Coin) Reset 

func (m *Coin) Reset()

func (*Coin) Size 

func (m *Coin) Size() (n int)

func (Coin) String 

func (coin Coin) String() string

String provides a human-readable representation of a coin

func (Coin) Sub 

func (coin Coin) Sub(coinB Coin) Coin

Sub subtracts amounts of two coins with same denom. If the coins differ in denom then it panics.

func (Coin) SubAmount 

func (coin Coin) SubAmount(amount Int) Coin

SubAmount subtracts an amount from the Coin.

func (*Coin) Unmarshal 

func (m *Coin) Unmarshal(dAtA []byte) error

func (Coin) Validate 

func (coin Coin) Validate() error

Validate returns an error if the Coin has a negative amount or if the denom is invalid.

func (*Coin) XXX_DiscardUnknown 

func (m *Coin) XXX_DiscardUnknown()

func (*Coin) XXX_Marshal 

func (m *Coin) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Coin) XXX_Merge 

func (m *Coin) XXX_Merge(src proto.Message)

func (*Coin) XXX_Size 

func (m *Coin) XXX_Size() int

func (*Coin) XXX_Unmarshal 

func (m *Coin) XXX_Unmarshal(b []byte) error

type Coins 

type Coins []Coin

Coins is a set of Coin, one per currency

func NewCoins 

func NewCoins(coins ...Coin) Coins

NewCoins constructs a new coin set. The provided coins will be sanitized by removing zero coins and sorting the coin set. A panic will occur if the coin set is not valid.

func NormalizeCoins 

func NormalizeCoins(coins []DecCoin) Coins

NormalizeCoins normalize and truncate a list of decimal coins

func ParseCoinsNormalized 

func ParseCoinsNormalized(coinStr string) (Coins, error)

ParseCoinsNormalized will parse out a list of coins separated by commas, and normalize them by converting to the smallest unit. If the parsing is successful, the provided coins will be sanitized by removing zero coins and sorting the coin set. Lastly a validation of the coin set is executed. If the check passes, ParseCoinsNormalized will return the sanitized coins. Otherwise, it will return an error. If an empty string is provided to ParseCoinsNormalized, it returns nil Coins. ParseCoinsNormalized supports decimal coins as inputs, and truncate them to int after converted to the smallest unit. Expected format: "{amount0}{denomination},...,{amountN}{denominationN}"

func (Coins) Add 

func (coins Coins) Add(coinsB ...Coin) Coins

Add adds two sets of coins.

e.g. {2A} + {A, 2B} = {3A, 2B} {2A} + {0B} = {2A}

NOTE: Add operates under the invariant that coins are sorted by denominations.

CONTRACT: Add will never return Coins where one Coin has a non-positive amount. In otherwords, IsValid will always return true. The function panics if `coins` or `coinsB` are not sorted (ascending).

func (Coins) AmountOf 

func (coins Coins) AmountOf(denom string) Int

AmountOf returns the amount of a denom from coins

func (Coins) AmountOfNoDenomValidation 

func (coins Coins) AmountOfNoDenomValidation(denom string) Int

AmountOfNoDenomValidation returns the amount of a denom from coins without validating the denomination.

func (Coins) DenomsSubsetOf 

func (coins Coins) DenomsSubsetOf(coinsB Coins) bool

DenomsSubsetOf returns true if receiver's denom set is subset of coinsB's denoms.

func (Coins) Empty 

func (coins Coins) Empty() bool

Empty returns true if there are no coins and false otherwise.

func (Coins) GetDenomByIndex 

func (coins Coins) GetDenomByIndex(i int) string

GetDenomByIndex returns the Denom of the certain coin to make the findDup generic

func (Coins) IsAllGT 

func (coins Coins) IsAllGT(coinsB Coins) bool

IsAllGT returns true if for every denom in coinsB, the denom is present at a greater amount in coins.

func (Coins) IsAllGTE 

func (coins Coins) IsAllGTE(coinsB Coins) bool

IsAllGTE returns false if for any denom in coinsB, the denom is present at a smaller amount in coins; else returns true.

func (Coins) IsAllLT 

func (coins Coins) IsAllLT(coinsB Coins) bool

IsAllLT returns True iff for every denom in coins, the denom is present at a smaller amount in coinsB.

func (Coins) IsAllLTE 

func (coins Coins) IsAllLTE(coinsB Coins) bool

IsAllLTE returns true iff for every denom in coins, the denom is present at a smaller or equal amount in coinsB.

func (Coins) IsAllPositive 

func (coins Coins) IsAllPositive() bool

IsAllPositive returns true if there is at least one coin and all currencies have a positive value.

func (Coins) IsAnyGT 

func (coins Coins) IsAnyGT(coinsB Coins) bool

IsAnyGT returns true iff for any denom in coins, the denom is present at a greater amount in coinsB.

e.g. {2A, 3B}.IsAnyGT{A} = true {2A, 3B}.IsAnyGT{5C} = false {}.IsAnyGT{5C} = false {2A, 3B}.IsAnyGT{} = false

func (Coins) IsAnyGTE 

func (coins Coins) IsAnyGTE(coinsB Coins) bool

IsAnyGTE returns true iff coins contains at least one denom that is present at a greater or equal amount in coinsB; it returns false otherwise.

NOTE: IsAnyGTE operates under the invariant that both coin sets are sorted by denominations and there exists no zero coins.

func (Coins) IsAnyNegative 

func (coins Coins) IsAnyNegative() bool

IsAnyNegative returns true if there is at least one coin whose amount is negative; returns false otherwise. It returns false if the coin set is empty too.

TODO: Remove once unsigned integers are used.

func (Coins) IsAnyNil 

func (coins Coins) IsAnyNil() bool

IsAnyNil returns true if there is at least one coin whose amount is nil; returns false otherwise. It returns false if the coin set is empty too.

func (Coins) IsEqual 

func (coins Coins) IsEqual(coinsB Coins) bool

IsEqual returns true if the two sets of Coins have the same value

func (Coins) IsValid 

func (coins Coins) IsValid() bool

IsValid calls Validate and returns true when the Coins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates).

func (Coins) IsZero 

func (coins Coins) IsZero() bool

IsZero returns true if there are no coins or all coins are zero.

func (Coins) Len 

func (coins Coins) Len() int

Len implements sort.Interface for Coins

func (Coins) Less 

func (coins Coins) Less(i, j int) bool

Less implements sort.Interface for Coins

func (Coins) MarshalJSON 

func (coins Coins) MarshalJSON() ([]byte, error)

MarshalJSON implements a custom JSON marshaller for the Coins type to allow nil Coins to be encoded as an empty array.

func (Coins) Max 

func (coins Coins) Max(coinsB Coins) Coins

Max takes two valid Coins inputs and returns a valid Coins result where for every denom D, AmountOf(D) of the result is the maximum of AmountOf(D) of the inputs. Note that the result might be not be equal to either input. For any valid Coins a, b, and c, the following are always true: 

a.IsAllLTE(a.Max(b))
b.IsAllLTE(a.Max(b))
a.IsAllLTE(c) && b.IsAllLTE(c) == a.Max(b).IsAllLTE(c)
a.Add(b...).IsEqual(a.Min(b).Add(a.Max(b)...))

E.g. {1A, 3B, 2C}.Max({4A, 2B, 2C} == {4A, 3B, 2C}) {2A, 3B}.Max({1B, 4C}) == {2A, 3B, 4C} {1A, 2B}.Max({}) == {1A, 2B}

func (Coins) Min 

func (coins Coins) Min(coinsB Coins) Coins

Min takes two valid Coins inputs and returns a valid Coins result where for every denom D, AmountOf(D) of the result is the minimum of AmountOf(D) of the inputs. Note that the result might be not be equal to either input. For any valid Coins a, b, and c, the following are always true: 

a.Min(b).IsAllLTE(a)
a.Min(b).IsAllLTE(b)
c.IsAllLTE(a) && c.IsAllLTE(b) == c.IsAllLTE(a.Min(b))
a.Add(b...).IsEqual(a.Min(b).Add(a.Max(b)...))

E.g. {1A, 3B, 2C}.Min({4A, 2B, 2C} == {1A, 2B, 2C}) {2A, 3B}.Min({1B, 4C}) == {1B} {1A, 2B}.Min({3C}) == empty

See also DecCoins.Intersect().

func (Coins) SafeSub 

func (coins Coins) SafeSub(coinsB Coins) (Coins, bool)

SafeSub performs the same arithmetic as Sub but returns a boolean if any negative coin amount was returned. The function panics if `coins` or `coinsB` are not sorted (ascending).

func (Coins) Sort 

func (coins Coins) Sort() Coins

Sort is a helper function to sort the set of coins in-place

func (Coins) String 

func (coins Coins) String() string

func (Coins) Sub 

func (coins Coins) Sub(coinsB Coins) Coins

Sub subtracts a set of coins from another.

e.g. {2A, 3B} - {A} = {A, 3B} {2A} - {0B} = {2A} {A, B} - {A} = {B}

CONTRACT: Sub will never return Coins where one Coin has a non-positive amount. In otherwords, IsValid will always return true.

func (Coins) Swap 

func (coins Coins) Swap(i, j int)

Swap implements sort.Interface for Coins

func (Coins) Validate 

func (coins Coins) Validate() error

Validate checks that the Coins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates). Otherwise, it returns an error.

type CustomProtobufType 

type CustomProtobufType interface {
	Marshal() ([]byte, error)
	MarshalTo(data []byte) (n int, err error)
	Unmarshal(data []byte) error
	Size() int

	MarshalJSON() ([]byte, error)
	UnmarshalJSON(data []byte) error
}

CustomProtobufType defines the interface custom gogo proto types must implement in order to be used as a "customtype" extension.

ref: https://github.com/gogo/protobuf/blob/master/custom_types.md

type Dec 

type Dec struct {
	// contains filtered or unexported fields
}

NOTE: never use new(Dec) or else we will panic unmarshalling into the nil embedded big.Int

func GetDenomUnit 

func GetDenomUnit(denom string) (Dec, bool)

GetDenomUnit returns a unit for a given denomination if it exists. A boolean is returned if the denomination is registered.

func MaxDec 

func MaxDec(d1, d2 Dec) Dec

maximum decimal between two

func MinDec 

func MinDec(d1, d2 Dec) Dec

minimum decimal between two

func MustNewDecFromStr 

func MustNewDecFromStr(s string) Dec

Decimal from string, panic on error

func NewDec 

func NewDec(i int64) Dec

create a new Dec from integer assuming whole number

func NewDecFromBigInt 

func NewDecFromBigInt(i *big.Int) Dec

create a new Dec from big integer assuming whole numbers CONTRACT: prec <= Precision

func NewDecFromBigIntWithPrec 

func NewDecFromBigIntWithPrec(i *big.Int, prec int64) Dec

create a new Dec from big integer assuming whole numbers CONTRACT: prec <= Precision

func NewDecFromInt 

func NewDecFromInt(i Int) Dec

create a new Dec from big integer assuming whole numbers CONTRACT: prec <= Precision

func NewDecFromIntWithPrec 

func NewDecFromIntWithPrec(i Int, prec int64) Dec

create a new Dec from big integer with decimal place at prec CONTRACT: prec <= Precision

func NewDecFromStr 

func NewDecFromStr(str string) (Dec, error)

create a decimal from an input decimal string. valid must come in the form: 

(-) whole integers (.) decimal integers

examples of acceptable input include: 

-123.456
456.7890
345
-456789

NOTE - An error will return if more decimal places are provided in the string than the constant Precision.

CONTRACT - This function does not mutate the input str.

func NewDecWithPrec 

func NewDecWithPrec(i, prec int64) Dec

create a new Dec from integer with decimal place at prec CONTRACT: prec <= Precision

func OneDec 

func OneDec() Dec

func SmallestDec 

func SmallestDec() Dec

func ZeroDec 

func ZeroDec() Dec

func (Dec) Abs 

func (d Dec) Abs() Dec

func (Dec) Add 

func (d Dec) Add(d2 Dec) Dec

addition

func (Dec) ApproxRoot 

func (d Dec) ApproxRoot(root uint64) (guess Dec, err error)

ApproxRoot returns an approximate estimation of a Dec's positive real nth root using Newton's method (where n is positive). The algorithm starts with some guess and computes the sequence of improved guesses until an answer converges to an approximate answer. It returns `|d|.ApproxRoot() * -1` if input is negative. A maximum number of 100 iterations is used a backup boundary condition for cases where the answer never converges enough to satisfy the main condition.

func (Dec) ApproxSqrt 

func (d Dec) ApproxSqrt() (Dec, error)

ApproxSqrt is a wrapper around ApproxRoot for the common special case of finding the square root of a number. It returns -(sqrt(abs(d)) if input is negative.

func (Dec) BigInt 

func (d Dec) BigInt() *big.Int

BigInt returns a copy of the underlying big.Int.

func (Dec) Ceil 

func (d Dec) Ceil() Dec

Ceil returns the smallest interger value (as a decimal) that is greater than or equal to the given decimal.

func (Dec) Equal 

func (d Dec) Equal(d2 Dec) bool

func (Dec) Float64 

func (d Dec) Float64() (float64, error)

Float64 returns the float64 representation of a Dec. Will return the error if the conversion failed.

func (Dec) Format 

func (d Dec) Format(s fmt.State, _ rune)

format decimal state

func (Dec) GT 

func (d Dec) GT(d2 Dec) bool

func (Dec) GTE 

func (d Dec) GTE(d2 Dec) bool

func (Dec) IsInteger 

func (d Dec) IsInteger() bool

is integer, e.g. decimals are zero

func (Dec) IsNegative 

func (d Dec) IsNegative() bool

func (Dec) IsNil 

func (d Dec) IsNil() bool

func (Dec) IsPositive 

func (d Dec) IsPositive() bool

func (Dec) IsZero 

func (d Dec) IsZero() bool

func (Dec) LT 

func (d Dec) LT(d2 Dec) bool

func (Dec) LTE 

func (d Dec) LTE(d2 Dec) bool

func (Dec) Marshal 

func (d Dec) Marshal() ([]byte, error)

Marshal implements the gogo proto custom type interface.

func (Dec) MarshalAmino 

func (d Dec) MarshalAmino() ([]byte, error)

Override Amino binary serialization by proxying to protobuf.

func (Dec) MarshalJSON 

func (d Dec) MarshalJSON() ([]byte, error)

MarshalJSON marshals the decimal

func (*Dec) MarshalTo 

func (d *Dec) MarshalTo(data []byte) (n int, err error)

MarshalTo implements the gogo proto custom type interface.

func (Dec) MarshalYAML 

func (d Dec) MarshalYAML() (interface{}, error)

MarshalYAML returns the YAML representation.

func (Dec) Mul 

func (d Dec) Mul(d2 Dec) Dec

multiplication

func (Dec) MulInt 

func (d Dec) MulInt(i Int) Dec

multiplication

func (Dec) MulInt64 

func (d Dec) MulInt64(i int64) Dec

MulInt64 - multiplication with int64

func (Dec) MulTruncate 

func (d Dec) MulTruncate(d2 Dec) Dec

multiplication truncate

func (Dec) MustFloat64 

func (d Dec) MustFloat64() float64

MustFloat64 returns the float64 representation of a Dec. Would panic if the conversion failed.

func (Dec) Neg 

func (d Dec) Neg() Dec

func (Dec) Power 

func (d Dec) Power(power uint64) Dec

Power returns a the result of raising to a positive integer power

func (Dec) Quo 

func (d Dec) Quo(d2 Dec) Dec

quotient

func (Dec) QuoInt 

func (d Dec) QuoInt(i Int) Dec

quotient

func (Dec) QuoInt64 

func (d Dec) QuoInt64(i int64) Dec

QuoInt64 - quotient with int64

func (Dec) QuoRoundUp 

func (d Dec) QuoRoundUp(d2 Dec) Dec

quotient, round up

func (Dec) QuoTruncate 

func (d Dec) QuoTruncate(d2 Dec) Dec

quotient truncate

func (Dec) RoundInt 

func (d Dec) RoundInt() Int

RoundInt round the decimal using bankers rounding

func (Dec) RoundInt64 

func (d Dec) RoundInt64() int64

RoundInt64 rounds the decimal using bankers rounding

func (*Dec) Size 

func (d *Dec) Size() int

Size implements the gogo proto custom type interface.

func (Dec) String 

func (d Dec) String() string

func (Dec) Sub 

func (d Dec) Sub(d2 Dec) Dec

subtraction

func (Dec) TruncateDec 

func (d Dec) TruncateDec() Dec

TruncateDec truncates the decimals from the number and returns a Dec

func (Dec) TruncateInt 

func (d Dec) TruncateInt() Int

TruncateInt truncates the decimals from the number and returns an Int

func (Dec) TruncateInt64 

func (d Dec) TruncateInt64() int64

TruncateInt64 truncates the decimals from the number and returns an int64

func (*Dec) Unmarshal 

func (d *Dec) Unmarshal(data []byte) error

Unmarshal implements the gogo proto custom type interface.

func (*Dec) UnmarshalAmino 

func (d *Dec) UnmarshalAmino(bz []byte) error

func (*Dec) UnmarshalJSON 

func (d *Dec) UnmarshalJSON(bz []byte) error

UnmarshalJSON defines custom decoding scheme

type DecCoin 

type DecCoin struct {
	Denom  string `protobuf:"bytes,1,opt,name=denom,proto3" json:"denom,omitempty"`
	Amount Dec    `protobuf:"bytes,2,opt,name=amount,proto3,customtype=Dec" json:"amount"`
}

DecCoin defines a token with a denomination and a decimal amount.

NOTE: The amount field is an Dec which implements the custom method signatures required by gogoproto.

func ConvertDecCoin 

func ConvertDecCoin(coin DecCoin, denom string) (DecCoin, error)

ConvertDecCoin attempts to convert a decimal coin to a given denomination. If the given denomination is invalid or if neither denomination is registered, an error is returned.

func NewDecCoin 

func NewDecCoin(denom string, amount Int) DecCoin

NewDecCoin creates a new DecCoin instance from an Int.

func NewDecCoinFromCoin 

func NewDecCoinFromCoin(coin Coin) DecCoin

NewDecCoinFromCoin creates a new DecCoin from a Coin.

func NewDecCoinFromDec 

func NewDecCoinFromDec(denom string, amount Dec) DecCoin

NewDecCoinFromDec creates a new DecCoin instance from a Dec.

func NewInt64DecCoin 

func NewInt64DecCoin(denom string, amount int64) DecCoin

NewInt64DecCoin returns a new DecCoin with a denomination and amount. It will panic if the amount is negative or denom is invalid.

func NormalizeDecCoin 

func NormalizeDecCoin(coin DecCoin) DecCoin

NormalizeDecCoin try to convert a decimal coin to the smallest unit registered, returns original one if failed.

func ParseDecCoin 

func ParseDecCoin(coinStr string) (coin DecCoin, err error)

ParseDecCoin parses a decimal coin from a string, returning an error if invalid. An empty string is considered invalid.

func (DecCoin) Add 

func (coin DecCoin) Add(coinB DecCoin) DecCoin

Add adds amounts of two decimal coins with same denom.

func (*DecCoin) Descriptor 

func (*DecCoin) Descriptor() ([]byte, []int)

func (*DecCoin) Equal 

func (this *DecCoin) Equal(that interface{}) bool

func (*DecCoin) GetDenom 

func (m *DecCoin) GetDenom() string

func (DecCoin) IsEqual 

func (coin DecCoin) IsEqual(other DecCoin) bool

IsEqual returns true if the two sets of Coins have the same value.

func (DecCoin) IsGTE 

func (coin DecCoin) IsGTE(other DecCoin) bool

IsGTE returns true if they are the same type and the receiver is an equal or greater value.

func (DecCoin) IsLT 

func (coin DecCoin) IsLT(other DecCoin) bool

IsLT returns true if they are the same type and the receiver is a smaller value.

func (DecCoin) IsNegative 

func (coin DecCoin) IsNegative() bool

IsNegative returns true if the coin amount is negative and false otherwise.

TODO: Remove once unsigned integers are used.

func (DecCoin) IsPositive 

func (coin DecCoin) IsPositive() bool

IsPositive returns true if coin amount is positive.

TODO: Remove once unsigned integers are used.

func (DecCoin) IsValid 

func (coin DecCoin) IsValid() bool

IsValid returns true if the DecCoin has a non-negative amount and the denom is valid.

func (DecCoin) IsZero 

func (coin DecCoin) IsZero() bool

IsZero returns if the DecCoin amount is zero.

func (*DecCoin) Marshal 

func (m *DecCoin) Marshal() (dAtA []byte, err error)

func (*DecCoin) MarshalTo 

func (m *DecCoin) MarshalTo(dAtA []byte) (int, error)

func (*DecCoin) MarshalToSizedBuffer 

func (m *DecCoin) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DecCoin) ProtoMessage 

func (*DecCoin) ProtoMessage()

func (*DecCoin) Reset 

func (m *DecCoin) Reset()

func (*DecCoin) Size 

func (m *DecCoin) Size() (n int)

func (DecCoin) String 

func (coin DecCoin) String() string

String implements the Stringer interface for DecCoin. It returns a human-readable representation of a decimal coin.

func (DecCoin) Sub 

func (coin DecCoin) Sub(coinB DecCoin) DecCoin

Sub subtracts amounts of two decimal coins with same denom.

func (DecCoin) TruncateDecimal 

func (coin DecCoin) TruncateDecimal() (Coin, DecCoin)

TruncateDecimal returns a Coin with a truncated decimal and a DecCoin for the change. Note, the change may be zero.

func (*DecCoin) Unmarshal 

func (m *DecCoin) Unmarshal(dAtA []byte) error

func (DecCoin) Validate 

func (coin DecCoin) Validate() error

Validate returns an error if the DecCoin has a negative amount or if the denom is invalid.

func (*DecCoin) XXX_DiscardUnknown 

func (m *DecCoin) XXX_DiscardUnknown()

func (*DecCoin) XXX_Marshal 

func (m *DecCoin) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DecCoin) XXX_Merge 

func (m *DecCoin) XXX_Merge(src proto.Message)

func (*DecCoin) XXX_Size 

func (m *DecCoin) XXX_Size() int

func (*DecCoin) XXX_Unmarshal 

func (m *DecCoin) XXX_Unmarshal(b []byte) error

type DecCoins 

type DecCoins []DecCoin

DecCoins defines a slice of coins with decimal values

func NewDecCoins 

func NewDecCoins(decCoins ...DecCoin) DecCoins

NewDecCoins constructs a new coin set with with decimal values from DecCoins. The provided coins will be sanitized by removing zero coins and sorting the coin set. A panic will occur if the coin set is not valid.

func NewDecCoinsFromCoins 

func NewDecCoinsFromCoins(coins ...Coin) DecCoins

NewDecCoinsFromCoins constructs a new coin set with decimal values from regular Coins.

func ParseDecCoins 

func ParseDecCoins(coinsStr string) (DecCoins, error)

ParseDecCoins will parse out a list of decimal coins separated by commas. If the parsing is successuful, the provided coins will be sanitized by removing zero coins and sorting the coin set. Lastly a validation of the coin set is executed. If the check passes, ParseDecCoins will return the sanitized coins. Otherwise it will return an error. If an empty string is provided to ParseDecCoins, it returns nil Coins. Expected format: "{amount0}{denomination},...,{amountN}{denominationN}"

func (DecCoins) Add 

func (coins DecCoins) Add(coinsB ...DecCoin) DecCoins

Add adds two sets of DecCoins.

NOTE: Add operates under the invariant that coins are sorted by denominations.

CONTRACT: Add will never return Coins where one Coin has a non-positive amount. In otherwords, IsValid will always return true.

func (DecCoins) AmountOf 

func (coins DecCoins) AmountOf(denom string) Dec

AmountOf returns the amount of a denom from deccoins

func (DecCoins) Empty 

func (coins DecCoins) Empty() bool

Empty returns true if there are no coins and false otherwise.

func (DecCoins) GetDenomByIndex 

func (coins DecCoins) GetDenomByIndex(i int) string

GetDenomByIndex returns the Denom to make the findDup generic

func (DecCoins) Intersect 

func (coins DecCoins) Intersect(coinsB DecCoins) DecCoins

Intersect will return a new set of coins which contains the minimum DecCoin for common denoms found in both `coins` and `coinsB`. For denoms not common to both `coins` and `coinsB` the minimum is considered to be 0, thus they are not added to the final set. In other words, trim any denom amount from coin which exceeds that of coinB, such that (coin.Intersect(coinB)).IsLTE(coinB). See also Coins.Min().

func (DecCoins) IsAllPositive 

func (coins DecCoins) IsAllPositive() bool

IsAllPositive returns true if there is at least one coin and all currencies have a positive value.

TODO: Remove once unsigned integers are used.

func (DecCoins) IsAnyNegative 

func (coins DecCoins) IsAnyNegative() bool

IsAnyNegative returns true if there is at least one coin whose amount is negative; returns false otherwise. It returns false if the DecCoins set is empty too.

TODO: Remove once unsigned integers are used.

func (DecCoins) IsEqual 

func (coins DecCoins) IsEqual(coinsB DecCoins) bool

IsEqual returns true if the two sets of DecCoins have the same value.

func (DecCoins) IsValid 

func (coins DecCoins) IsValid() bool

IsValid calls Validate and returns true when the DecCoins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates).

func (DecCoins) IsZero 

func (coins DecCoins) IsZero() bool

IsZero returns whether all coins are zero

func (DecCoins) Len 

func (coins DecCoins) Len() int

Len implements sort.Interface for DecCoins

func (DecCoins) Less 

func (coins DecCoins) Less(i, j int) bool

Less implements sort.Interface for DecCoins

func (DecCoins) MulDec 

func (coins DecCoins) MulDec(d Dec) DecCoins

MulDec multiplies all the coins by a decimal.

CONTRACT: No zero coins will be returned.

func (DecCoins) MulDecTruncate 

func (coins DecCoins) MulDecTruncate(d Dec) DecCoins

MulDecTruncate multiplies all the decimal coins by a decimal, truncating. It panics if d is zero.

CONTRACT: No zero coins will be returned.

func (DecCoins) QuoDec 

func (coins DecCoins) QuoDec(d Dec) DecCoins

QuoDec divides all the decimal coins by a decimal. It panics if d is zero.

CONTRACT: No zero coins will be returned.

func (DecCoins) QuoDecTruncate 

func (coins DecCoins) QuoDecTruncate(d Dec) DecCoins

QuoDecTruncate divides all the decimal coins by a decimal, truncating. It panics if d is zero.

CONTRACT: No zero coins will be returned.

func (DecCoins) SafeSub 

func (coins DecCoins) SafeSub(coinsB DecCoins) (DecCoins, bool)

SafeSub performs the same arithmetic as Sub but returns a boolean if any negative coin amount was returned.

func (DecCoins) Sort 

func (coins DecCoins) Sort() DecCoins

Sort is a helper function to sort the set of decimal coins in-place.

func (DecCoins) String 

func (coins DecCoins) String() string

String implements the Stringer interface for DecCoins. It returns a human-readable representation of decimal coins.

func (DecCoins) Sub 

func (coins DecCoins) Sub(coinsB DecCoins) DecCoins

Sub subtracts a set of DecCoins from another (adds the inverse).

func (DecCoins) Swap 

func (coins DecCoins) Swap(i, j int)

Swap implements sort.Interface for DecCoins

func (DecCoins) TruncateDecimal 

func (coins DecCoins) TruncateDecimal() (truncatedCoins Coins, changeCoins DecCoins)

TruncateDecimal returns the coins with truncated decimals and returns the change. Note, it will not return any zero-amount coins in either the truncated or change coins.

func (DecCoins) Validate 

func (coins DecCoins) Validate() error

Validate checks that the DecCoins are sorted, have positive amount, with a valid and unique denomination (i.e no duplicates). Otherwise, it returns an error.

type DecProto 

type DecProto struct {
	Dec Dec `protobuf:"bytes,1,opt,name=dec,proto3,customtype=Dec" json:"dec"`
}

DecProto defines a Protobuf wrapper around a Dec object.

func (*DecProto) Descriptor 

func (*DecProto) Descriptor() ([]byte, []int)

func (*DecProto) Marshal 

func (m *DecProto) Marshal() (dAtA []byte, err error)

func (*DecProto) MarshalTo 

func (m *DecProto) MarshalTo(dAtA []byte) (int, error)

func (*DecProto) MarshalToSizedBuffer 

func (m *DecProto) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*DecProto) ProtoMessage 

func (*DecProto) ProtoMessage()

func (*DecProto) Reset 

func (m *DecProto) Reset()

func (*DecProto) Size 

func (m *DecProto) Size() (n int)

func (DecProto) String 

func (dp DecProto) String() string

func (*DecProto) Unmarshal 

func (m *DecProto) Unmarshal(dAtA []byte) error

func (*DecProto) XXX_DiscardUnknown 

func (m *DecProto) XXX_DiscardUnknown()

func (*DecProto) XXX_Marshal 

func (m *DecProto) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*DecProto) XXX_Merge 

func (m *DecProto) XXX_Merge(src proto.Message)

func (*DecProto) XXX_Size 

func (m *DecProto) XXX_Size() int

func (*DecProto) XXX_Unmarshal 

func (m *DecProto) XXX_Unmarshal(b []byte) error

type Int 

type Int struct {
	// contains filtered or unexported fields
}

Int wraps big.Int with a 257 bit range bound Checks overflow, underflow and division by zero Exists in range from -(2^256 - 1) to 2^256 - 1

func MaxInt 

func MaxInt(i, i2 Int) Int

MaxInt returns the maximum between two integers.

func MinInt 

func MinInt(i1, i2 Int) Int

return the minimum of the ints

func NewInt 

func NewInt(n int64) Int

NewInt constructs Int from int64

func NewIntFromBigInt 

func NewIntFromBigInt(i *big.Int) Int

NewIntFromBigInt constructs Int from big.Int. If the provided big.Int is nil, it returns an empty instance. This function panics if the bit length is > 256.

func NewIntFromString 

func NewIntFromString(s string) (res Int, ok bool)

NewIntFromString constructs Int from string

func NewIntFromUint64 

func NewIntFromUint64(n uint64) Int

NewIntFromUint64 constructs an Int from a uint64.

func NewIntWithDecimal 

func NewIntWithDecimal(n int64, dec int) Int

NewIntWithDecimal constructs Int with decimal Result value is n*10^dec

func OneInt 

func OneInt() Int

OneInt returns Int value with one

func ZeroInt 

func ZeroInt() Int

ZeroInt returns Int value with zero

func (Int) Abs 

func (i Int) Abs() Int

Abs returns the absolute value of Int.

func (Int) Add 

func (i Int) Add(i2 Int) (res Int)

Add adds Int from another

func (Int) AddRaw 

func (i Int) AddRaw(i2 int64) Int

AddRaw adds int64 to Int

func (Int) BigInt 

func (i Int) BigInt() *big.Int

BigInt converts Int to big.Int

func (Int) Equal 

func (i Int) Equal(i2 Int) bool

Equal compares two Ints

func (Int) GT 

func (i Int) GT(i2 Int) bool

GT returns true if first Int is greater than second

func (Int) GTE 

func (i Int) GTE(i2 Int) bool

GTE returns true if receiver Int is greater than or equal to the parameter Int.

func (Int) Int64 

func (i Int) Int64() int64

Int64 converts Int to int64 Panics if the value is out of range

func (Int) IsInt64 

func (i Int) IsInt64() bool

IsInt64 returns true if Int64() not panics

func (Int) IsNegative 

func (i Int) IsNegative() bool

IsNegative returns true if Int is negative

func (Int) IsNil 

func (i Int) IsNil() bool

IsNil returns true if Int is uninitialized

func (Int) IsPositive 

func (i Int) IsPositive() bool

IsPositive returns true if Int is positive

func (Int) IsUint64 

func (i Int) IsUint64() bool

IsUint64 returns true if Uint64() not panics

func (Int) IsZero 

func (i Int) IsZero() bool

IsZero returns true if Int is zero

func (Int) LT 

func (i Int) LT(i2 Int) bool

LT returns true if first Int is lesser than second

func (Int) LTE 

func (i Int) LTE(i2 Int) bool

LTE returns true if first Int is less than or equal to second

func (Int) Marshal 

func (i Int) Marshal() ([]byte, error)

Marshal implements the gogo proto custom type interface.

func (Int) MarshalAmino 

func (i Int) MarshalAmino() ([]byte, error)

Override Amino binary serialization by proxying to protobuf.

func (Int) MarshalJSON 

func (i Int) MarshalJSON() ([]byte, error)

MarshalJSON defines custom encoding scheme

func (*Int) MarshalTo 

func (i *Int) MarshalTo(data []byte) (n int, err error)

MarshalTo implements the gogo proto custom type interface.

func (Int) MarshalYAML 

func (i Int) MarshalYAML() (interface{}, error)

MarshalYAML returns the YAML representation.

func (Int) Mod 

func (i Int) Mod(i2 Int) Int

Mod returns remainder after dividing with Int

func (Int) ModRaw 

func (i Int) ModRaw(i2 int64) Int

ModRaw returns remainder after dividing with int64

func (Int) Mul 

func (i Int) Mul(i2 Int) (res Int)

Mul multiples two Ints

func (Int) MulRaw 

func (i Int) MulRaw(i2 int64) Int

MulRaw multipies Int and int64

func (Int) Neg 

func (i Int) Neg() (res Int)

Neg negates Int

func (Int) Quo 

func (i Int) Quo(i2 Int) (res Int)

Quo divides Int with Int

func (Int) QuoRaw 

func (i Int) QuoRaw(i2 int64) Int

QuoRaw divides Int with int64

func (Int) Sign 

func (i Int) Sign() int

Sign returns sign of Int

func (*Int) Size 

func (i *Int) Size() int

Size implements the gogo proto custom type interface.

func (Int) String 

func (i Int) String() string

Human readable string

func (Int) Sub 

func (i Int) Sub(i2 Int) (res Int)

Sub subtracts Int from another

func (Int) SubRaw 

func (i Int) SubRaw(i2 int64) Int

SubRaw subtracts int64 from Int

func (Int) ToDec 

func (i Int) ToDec() Dec

ToDec converts Int to Dec

func (Int) Uint64 

func (i Int) Uint64() uint64

Uint64 converts Int to uint64 Panics if the value is out of range

func (*Int) Unmarshal 

func (i *Int) Unmarshal(data []byte) error

Unmarshal implements the gogo proto custom type interface.

func (*Int) UnmarshalAmino 

func (i *Int) UnmarshalAmino(bz []byte) error

func (*Int) UnmarshalJSON 

func (i *Int) UnmarshalJSON(bz []byte) error

UnmarshalJSON defines custom decoding scheme

type IntProto 

type IntProto struct {
	Int Int `protobuf:"bytes,1,opt,name=int,proto3,customtype=Int" json:"int"`
}

IntProto defines a Protobuf wrapper around an Int object.

func (*IntProto) Descriptor 

func (*IntProto) Descriptor() ([]byte, []int)

func (*IntProto) Marshal 

func (m *IntProto) Marshal() (dAtA []byte, err error)

func (*IntProto) MarshalTo 

func (m *IntProto) MarshalTo(dAtA []byte) (int, error)

func (*IntProto) MarshalToSizedBuffer 

func (m *IntProto) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*IntProto) ProtoMessage 

func (*IntProto) ProtoMessage()

func (*IntProto) Reset 

func (m *IntProto) Reset()

func (*IntProto) Size 

func (m *IntProto) Size() (n int)

func (IntProto) String 

func (ip IntProto) String() string

func (*IntProto) Unmarshal 

func (m *IntProto) Unmarshal(dAtA []byte) error

func (*IntProto) XXX_DiscardUnknown 

func (m *IntProto) XXX_DiscardUnknown()

func (*IntProto) XXX_Marshal 

func (m *IntProto) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*IntProto) XXX_Merge 

func (m *IntProto) XXX_Merge(src proto.Message)

func (*IntProto) XXX_Size 

func (m *IntProto) XXX_Size() int

func (*IntProto) XXX_Unmarshal 

func (m *IntProto) XXX_Unmarshal(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.