osmoutils

package module
v0.0.0-...-9a9376b Latest Latest
Warning

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

 Go to latest Published: Jul 16, 2023 License: Apache-2.0 Imports: 31 Imported by: 30

Documentation

Index

Constants

View Source 
const IbcAcknowledgementErrorType = "ibc-acknowledgement-error"

Variables

View Source 
var (
	ErrNoValuesInRange = errors.New("No values in range")
)
View Source 
var PercoUtilsExtraAccountTypes map[reflect.Type]struct{}

PercoUtilsExtraAccountTypes is a map of extra account types that can be overridden. This is defined as a global variable so it can be modified in the chain's app.go and used here without having to import the chain. Specifically, this is used for compatibility with Percosis' Cosmos SDK fork

View Source 
var ProposalFlags = []string{
	cli.FlagTitle,
	cli.FlagDescription,
	cli.FlagDeposit,
}

Functions

func AddDecCoinArrays 

func AddDecCoinArrays(decCoinsArrayA []sdk.DecCoins, decCoinsArrayB []sdk.DecCoins) ([]sdk.DecCoins, error)

AddDecCoinArrays adds the contents of the second param from the first (decCoinsArrayA + decCoinsArrayB) Note that this takes in two _arrays_ of DecCoins, meaning that each term itself is of type DecCoins (i.e. an array of DecCoin).

func ApplyFuncIfNoError 

func ApplyFuncIfNoError(ctx sdk.Context, f func(ctx sdk.Context) error) (err error)

This function lets you run the function f, but if theres an error or panic drop the state machine change and log the error. If there is no error, proceeds as normal (but with some slowdown due to SDK store weirdness) Try to avoid usage of iterators in f.

If its an out of gas panic, this function will also panic like in normal tx execution flow. This is still safe for beginblock / endblock code though, as they do not have out of gas panics.

func CanCreateModuleAccountAtAddr 

func CanCreateModuleAccountAtAddr(ctx sdk.Context, ak AccountKeeper, addr sdk.AccAddress) error

CanCreateModuleAccountAtAddr tells us if we can safely make a module account at a given address. By collision resistance of the address (given API safe construction), the only way for an account to be already be at this address is if its claimed by the same pre-image from the correct module, or some SDK command breaks assumptions and creates an account at designated address. This function checks if there is an account at that address, and runs some safety checks to be extra-sure its not a user account (e.g. non-zero sequence, pubkey, of fore-seen account types). If there is no account, or if we believe its not a user-spendable account, we allow module account creation at the address. else, we do not.

TODO: This is generally from an SDK design flaw code based off wasmd code: https://github.com/CosmWasm/wasmd/pull/996 Its _mandatory_ that the caller do the API safe construction to generate a module account addr, namely, address.Module(ModuleName, {key})

func CoinsDenoms 

func CoinsDenoms(coins sdk.Coins) []string

TODO: Get this into the SDK https://github.com/cosmos/cosmos-sdk/issues/12538

func CollapseDecCoinsArray 

func CollapseDecCoinsArray(decCoinsArray []sdk.DecCoins) sdk.DecCoins

CollapseDecCoinsArray takes an array of DecCoins and returns the sum of all the DecCoins in the array.

func Contains 

func Contains[T comparable](slice []T, item T) bool

Contains returns true if the slice contains the item, false otherwise.

func ContainsDuplicate 

func ContainsDuplicate[T any](arr []T) bool

ContainsDuplicate checks if there are any duplicate elements in the slice.

func ContainsDuplicateDeepEqual 

func ContainsDuplicateDeepEqual[T any](multihops []T) bool

ContainsDuplicateDeepEqual returns true if there are duplicates in the slice by performing deep comparison. This is useful for comparing matrices or slices of pointers. Returns false if there are no deep equal duplicates.

func ConvertCoinsToDecCoins 

func ConvertCoinsToDecCoins(coins sdk.Coins) sdk.DecCoins

ConvertCoinsToDecCoins takes sdk.Coins and converts it to sdk.DecCoins

func CreateModuleAccount 

func CreateModuleAccount(ctx sdk.Context, ak AccountKeeper, addr sdk.AccAddress) error

CreateModuleAccount creates a module account at the provided address. It overrides an account if it exists at that address, with a non-zero sequence number & pubkey Contract: addr is derived from `address.Module(ModuleName, key)`

func CreateRandomAccounts 

func CreateRandomAccounts(numAccts int) []sdk.AccAddress

CreateRandomAccounts is a function return a list of randomly generated AccAddresses

func DefaultFeeString 

func DefaultFeeString(cfg network.Config) string

func DeleteAllKeysFromPrefix 

func DeleteAllKeysFromPrefix(ctx sdk.Context, store store.KVStore, prefixKey []byte)

DeleteAllKeysFromPrefix deletes all store records that contains the given prefixKey.

func Filter 

func Filter[T interface{}](filter func(T) bool, s []T) []T

func FormatFixedLengthU64 

func FormatFixedLengthU64(d uint64) string

func FormatTimeString 

func FormatTimeString(t time.Time) string

func GatherAllKeysFromStore 

func GatherAllKeysFromStore(storeObj store.KVStore) []string

func GatherValuesFromStore 

func GatherValuesFromStore[T any](storeObj store.KVStore, keyStart []byte, keyEnd []byte, parseValue func([]byte) (T, error)) ([]T, error)

func GatherValuesFromStorePrefix 

func GatherValuesFromStorePrefix[T any](storeObj store.KVStore, prefix []byte, parseValue func([]byte) (T, error)) ([]T, error)

GatherValuesFromStorePrefix is a decorator around GatherValuesFromStorePrefixWithKeyParser. It overwrites the parse function to disable parsing keys, only keeping values

func GatherValuesFromStorePrefixWithKeyParser 

func GatherValuesFromStorePrefixWithKeyParser[T any](storeObj store.KVStore, prefix []byte, parse func(key []byte, value []byte) (T, error)) ([]T, error)

GatherValuesFromStorePrefixWithKeyParser is a helper function that gathers values from a given store prefix. While iterating through the entries, it parses both key and the value using the provided parse function to return the desired type. Returns error if: - the parse function returns an error. - internal database error

func Get 

func Get(store store.KVStore, key []byte, result proto.Message) (found bool, err error)

Get returns a value at key by mutating the result parameter. Returns true if the value was found and the result mutated correctly. If the value is not in the store, returns false. Returns error only when database or serialization errors occur. (And when an error occurs, returns false)

func GetDec 

func GetDec(store store.KVStore, key []byte) (sdk.Dec, error)

GetDec gets dec value from store at key. Returns error if: - database error occurs. - no value at given key is found.

func GetFirstValueAfterPrefixInclusive 

func GetFirstValueAfterPrefixInclusive[T any](storeObj store.KVStore, keyStart []byte, parseValue func([]byte) (T, error)) (T, error)

func GetFirstValueInRange 

func GetFirstValueInRange[T any](storeObj store.KVStore, keyStart []byte, keyEnd []byte, reverseIterate bool, parseValue func([]byte) (T, error)) (T, error)

func GetIterValuesWithStop 

func GetIterValuesWithStop[T any](
	storeObj store.KVStore,
	keyStart []byte,
	keyEnd []byte,
	reverse bool,
	stopFn func([]byte) bool,
	parseValue func([]byte) (T, error),
) ([]T, error)

func GetRandomSubset 

func GetRandomSubset[T any](slice []T) []T

GetRandomSubset returns a random subset of the given slice

func GetValuesUntilDerivedStop 

func GetValuesUntilDerivedStop[T any](storeObj store.KVStore, keyStart []byte, stopFn func([]byte) bool, parseValue func([]byte) (T, error)) ([]T, error)

func HasAnyAtPrefix 

func HasAnyAtPrefix[T any](storeObj store.KVStore, prefix []byte, parseValue func([]byte) (T, error)) (bool, error)

HasAnyAtPrefix returns true if there is at least one value in the given prefix.

func IsAckError 

func IsAckError(acknowledgement []byte) bool

IsAckError checks an IBC acknowledgement to see if it's an error. This is a replacement for ack.Success() which is currently not working on some circumstances

func IsOutOfGasError 

func IsOutOfGasError(err any) (bool, string)

Frustratingly, this has to return the error descriptor, not an actual error itself because the SDK errors here are not actually errors. (They don't implement error interface)

func MakeNew 

func MakeNew[T any]() T

MakeNew makes a new instance of generic T. if T is a pointer, makes a new instance of the underlying struct via reflection, and then a pointer to it.

func Max 

func Max(values ...interface{}) interface{}

Max returns the maximum value among the given values of any type that supports comparison.

func MergeSlices 

func MergeSlices[T any](slice1, slice2 []T, less LessFunc[T]) []T

MergeSlices efficiently merges two sorted slices into a single sorted slice. The resulting slice contains all elements from slice1 and slice2, sorted according to the less function. The input slices must be sorted in ascending order according to the less function. The less function takes two elements of type T and returns a boolean value indicating whether the first element is less than the second element. The function returns a new slice containing all elements from slice1 and slice2, sorted according to the less function. The function does not modify the input slices.

func MinCoins 

func MinCoins(coinsA sdk.Coins, coinsB sdk.Coins) sdk.Coins

MinCoins returns the minimum of each denom between both coins. For now it assumes they have the same denoms. TODO: Replace with method in SDK once we update our version

func MustExtractDenomFromPacketOnRecv 

func MustExtractDenomFromPacketOnRecv(packet ibcexported.PacketI) string

MustExtractDenomFromPacketOnRecv takes a packet with a valid ICS20 token data in the Data field and returns the denom as represented in the local chain. If the data cannot be unmarshalled this function will panic

func MustGet 

func MustGet(store store.KVStore, key []byte, result proto.Message)

MustGet gets key from store by mutating result Panics on any error.

func MustGetDec 

func MustGetDec(store store.KVStore, key []byte) sdk.Dec

MustGetDec gets dec value from store at key. Panics on any error.

func MustSet 

func MustSet(storeObj store.KVStore, key []byte, value proto.Message)

MustSet runs store.Set(key, proto.Marshal(value)) but panics on any error.

func MustSetDec 

func MustSetDec(store store.KVStore, key []byte, value sdk.Dec)

MustSetDec sets dec value to store at key. Panics on any error.

func NewEmitErrorAcknowledgement 

func NewEmitErrorAcknowledgement(ctx sdk.Context, err error, errorContexts ...string) channeltypes.Acknowledgement

NewEmitErrorAcknowledgement creates a new error acknowledgement after having emitted an event with the details of the error.

func NewModuleAddressWithPrefix 

func NewModuleAddressWithPrefix(moduleName, prefix string, identifier []byte) sdk.AccAddress

NewModuleAddressWithPrefix returns a new module address with the given prefix and identifier.

func ParseSdkDecFromString 

func ParseSdkDecFromString(s string, separator string) ([]sdk.Dec, error)

func ParseSdkIntFromString 

func ParseSdkIntFromString(s string, separator string) ([]sdk.Int, error)

func ParseTimeString 

func ParseTimeString(s string) (time.Time, error)

Parses a string encoded using FormatTimeString back into a time.Time

func ParseUint64SliceFromString 

func ParseUint64SliceFromString(s string, separator string) ([]uint64, error)

func PrintPanicRecoveryError 

func PrintPanicRecoveryError(ctx sdk.Context, recoveryError interface{})

PrintPanicRecoveryError error logs the recoveryError, along with the stacktrace, if it can be parsed. If not emits them to stdout.

func ReverseSlice 

func ReverseSlice[T any](s []T) []T

ReverseSlice reverses the input slice in place. Does mutate argument.

func SortSlice 

func SortSlice[T constraints.Ordered](s []T)

SortSlice sorts a slice of type T elements that implement constraints.Ordered. Mutates input slice s

func SubDecCoinArrays 

func SubDecCoinArrays(decCoinsArrayA []sdk.DecCoins, decCoinsArrayB []sdk.DecCoins) ([]sdk.DecCoins, error)

SubDecCoinArrays subtracts the contents of the second param from the first (decCoinsArrayA - decCoinsArrayB) Note that this takes in two _arrays_ of DecCoins, meaning that each term itself is of type DecCoins (i.e. an array of DecCoin).

func Uint64ToBytes 

func Uint64ToBytes(i uint64) []byte

func Uint64ToString 

func Uint64ToString(i uint64) string

Types

type AccountKeeper 

type AccountKeeper interface {
	NewAccount(sdk.Context, authtypes.AccountI) authtypes.AccountI

	GetAccount(ctx sdk.Context, addr sdk.AccAddress) authtypes.AccountI
	SetAccount(ctx sdk.Context, acc authtypes.AccountI)
}

type DecNotFoundError 

type DecNotFoundError struct {
	Key string
}

func (DecNotFoundError) Error 

func (e DecNotFoundError) Error() string

type LessFunc 

type LessFunc[T any] func(a, b T) bool

type Proposal 

type Proposal struct {
	Title       string
	Description string
	Deposit     string
}

func ParseProposalFlags 

func ParseProposalFlags(fs *pflag.FlagSet) (*Proposal, error)

Source Files

View all Source files

Directories

Path Synopsis
package accumulator allows one to define an accumulator to accommodate constant-rate (linear) distribution mechanisms with constant runtime and linear memory
 package accumulator allows one to define an accumulator to accommodate constant-rate (linear) distribution mechanisms with constant runtime and linear memory
package partialord allows one to define partial orderings, and derive a total ordering
 package partialord allows one to define partial orderings, and derive a total ordering
internal/dag
Package dag implements a simple Directed Acyclical Graph (DAG) for deterministic topological sorts
 Package dag implements a simple Directed Acyclical Graph (DAG) for deterministic topological sorts
legacy/v101

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.