common

README

x/common

The x/common directory holds helper and utility functions to be utilized by other x/ cosmos-sdk modules.

Documentation

Index

• Constants
• func AddrsToStrings(addrs ...sdk.AccAddress) []string
• func CombineErrors(errs ...error) (outErr error)
• func CombineErrorsFromStrings(strs ...string) (err error)
• func CombineErrorsGeneric(errAnySlice any) (out error, ok bool)
• func StringsToAddrs(strs ...string) []sdk.AccAddress
• func ToError(v any) (out error, ok bool)
• func TryCatch(callback func()) func() error

Constants

const (
	TreasuryPoolModuleAccount = "treasury_pool"
	// Precision for int representation in sdk.Int objects
	Precision = int64(1_000_000)
)

Functions

func AddrsToStrings

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

func CombineErrors

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

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

func CombineErrorsGeneric

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

func StringsToAddrs

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

func ToError

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

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.