common

func AddrsToStrings ¶ added in v0.5.2

func AddrsToStrings(addrs ...sdk.AccAddress) []string

func BankersRound ¶ added in v0.21.9

func BankersRound(quo, rem, halfPrecision *big.Int) *big.Int

BankersRound: Banker's rounding is a method commonly used in banking and accounting to reduce roudning bias when processing large volumes of rounded numbers.

1. If the remainder < half precision, round down 2. If the remainder > half precision, round up 3. If remainder == half precision, round to the nearest even number

The name comes from the idea that it provides egalitarian rounding that doesn't consistently favor one party over another (e.g. always rounding up). With this method, rounding errors tend to cancel out rather than accumulating in one direction.

func BigIntPow10 ¶ added in v0.21.0

func BigIntPow10(power int64) *big.Int

BigIntPow10 returns a big int that is a power of 10, e.g. BigIngPow10(3) returns 1000. This function is useful for creating large numbers outside the range of an int64 or 18 decimal precision.

func ChopPrecisionAndRound ¶ added in v0.21.0

func ChopPrecisionAndRound(d *big.Int) *big.Int

ChopPrecisionAndRound: Remove a Precision amount of rightmost digits and perform bankers rounding on the remainder (gaussian rounding) on the digits which have been removed.

Mutates the input. Use the non-mutative version if that is undesired

func Clamp ¶ added in v0.21.9

func Clamp(value sdk.Dec, clampValue sdk.Dec) sdk.Dec

Clamp return the value if it is within the clampValue, otherwise return the clampValue. e.g. Clamp(1.5, 1) = 1, Clamp(-1.5, 1) = -1, Clamp(0.5, 1) = 0.5

func CombineErrors ¶ added in v0.17.0

func CombineErrors(errs ...error) (outErr error)

Combines errors into single error. Error descriptions are ordered the same way they're passed to the function.

func CombineErrorsFromStrings ¶ added in v0.17.0

func CombineErrorsFromStrings(strs ...string) (err error)

func CombineErrorsGeneric ¶ added in v0.17.0

func CombineErrorsGeneric(errAnySlice any) (out error, ok bool)

func MustSqrtBigInt ¶ added in v0.21.0

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

MustSqrtBigInt returns the square root of the input.

• NOTE: MustSqrtBigInt panics if it is called on a negative number because it uses the `big.Int.Sqrt` from the "math/big" package.

func MustSqrtDec ¶ added in v0.21.0

func MustSqrtDec(dec sdk.Dec) sdk.Dec

MustSqrtDec computes the square root of the input decimal using its underlying big.Int. The big.Int.Sqrt method is part of the standard library, thoroughly tested, works at seemingly unbound precision (e.g. for numbers as large as 10**99.

• NOTE, MustSqrtDec panics if it is called on a negative number, similar to the sdk.NewCoin and SqrtBigInt functions. A panic safe version of MustSqrtDec is available in the SqrtDec method.

func ParsePagination ¶ added in v1.0.0

func ParsePagination(
	pageReq *sdkquery.PageRequest,
) (newPageReq *sdkquery.PageRequest, page int, err error)

ParsePagination: Validates and cleans a PageRequest to make setting values less error-prone and use Nibiru-specific defaults.

1. This fn is intended to be used with sdkquery.Paginate, which paginates all of the results in a PrefixStore based on the provided PageRequest.
2. This fn is panic-safe, so it can be used freely throughout the base app.
3. A "page" value of -1 means that a key is given for the prefix store. This means that the PageRequest.Offset will be ignored.

func SqrtBigInt ¶ added in v0.21.0

func SqrtBigInt(i *big.Int) (*big.Int, error)

SqrtInt is the panic-safe version of MustSqrtBigInt

func SqrtDec ¶ added in v0.21.0

func SqrtDec(dec sdk.Dec) (sdk.Dec, error)

SqrtDec computes the square root of the input decimal using its underlying big.Int. SqrtDec is panic-safe and returns an error if the input decimal is negative.

The big.Int.Sqrt method is part of the standard library, thoroughly tested, works at seemingly unbound precision (e.g. for numbers as large as 10**99.

func StringsToAddrs ¶ added in v0.5.2

func StringsToAddrs(strs ...string) []sdk.AccAddress

func ToError ¶ added in v0.17.0

func ToError(v any) (out error, ok bool)

ToError converts a value to an error type if it: (1) is a string, (2) has a String() function (3) is already an error. (4) or is a slice of these cases I.e., the types supported are: string, []string, error, []error, fmt.Stringer, []fmt.Stringer

The type is inferred from try catch blocks at runtime.

func TryCatch ¶ added in v0.17.0

func TryCatch(callback func()) func() error

TryCatch is an implementation of the try-catch block from languages like C++ and JS. given a 'callback' function, TryCatch defers and recovers from any panics or errors, allowing one to safely handle multiple panics in succession.

Typically, you'll write something like: `err := TryCatch(aRiskyFunction)()`

Usage example:

var calmPanic error = TryCatch(func() {
  panic("something crazy")
})()
fmt.Println(calmPanic.Error()) // prints "something crazy"

Note that TryCatch doesn't return an error. It returns a function that returns an error. Only when you call the output of TryCatch will it "feel" like a try-catch block from other languages.

This means that TryCatch can be used to restart go routines that panic as well.