common

README

x/common

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

Documentation

Index

• Variables
• func DenomsFromPoolName(pool string) (denoms []string)
• func PoolNameFromDenoms(denoms []string) string
• func RawPoolNameFromDenoms(denoms []string) string
• type AssetPair
  • func NewAssetPairFromStr(pair string) (AssetPair, error)
  • func (pair AssetPair) GetBaseTokenDenom() string
  • func (pair AssetPair) GetQuoteTokenDenom() string
  • func (pair AssetPair) Inverse() AssetPair
  • func (pair AssetPair) IsProperOrder() bool
  • func (pair AssetPair) Name() string
  • func (pair AssetPair) PairID() string
  • func (pair AssetPair) Proper() AssetPair
  • func (pair AssetPair) String() string

Variables

var (
	GovDenom        = "unibi"
	CollDenom       = "uust"
	StableDenom     = "unusd"
	StakeTokenDenom = "stake"
	TestTokenDenom  = "test"

	TreasuryPoolModuleAccount = "treasury_pool"

	PairSeparator = ":"

	WhitelistedColl = []string{CollDenom}

	GovStablePool  = AssetPair{Token0: GovDenom, Token1: StableDenom}
	CollStablePool = AssetPair{Token0: CollDenom, Token1: StableDenom}
	TestStablePool = AssetPair{Token0: TestTokenDenom, Token1: StableDenom}

	ErrInvalidTokenPair = fmt.Errorf("invalid token pair")
)

var (
	PAIR_uBTC_uNUSD = AssetPair{Token0: "uBTC", Token1: "uNUSD"}
	PAIR_uETH_uNUSD = AssetPair{Token0: "uETH", Token1: "uNUSD"}
)

Functions

func DenomsFromPoolName

func DenomsFromPoolName(pool string) (denoms []string)

func PoolNameFromDenoms

func PoolNameFromDenoms(denoms []string) string

PoolNameFromDenoms returns a sorted string representing a pool of assets

func RawPoolNameFromDenoms

func RawPoolNameFromDenoms(denoms []string) string

RawPoolNameFromDenoms returns a string representing a pool of assets in the exact order the denoms were given as args

Types

type AssetPair

type AssetPair struct {
	Token0 string
	Token1 string
}

func NewAssetPairFromStr

func NewAssetPairFromStr(pair string) (AssetPair, error)

func (AssetPair) GetBaseTokenDenom

func (pair AssetPair) GetBaseTokenDenom() string

func (AssetPair) GetQuoteTokenDenom

func (pair AssetPair) GetQuoteTokenDenom() string

func (AssetPair) Inverse

func (pair AssetPair) Inverse() AssetPair

func (AssetPair) IsProperOrder

func (pair AssetPair) IsProperOrder() bool

func (AssetPair) Name

func (pair AssetPair) Name() string

Name is the name of the pool that corresponds to the two assets on this pair.

func (AssetPair) PairID

func (pair AssetPair) PairID() string

func (AssetPair) Proper

func (pair AssetPair) Proper() AssetPair

func (AssetPair) String

func (pair AssetPair) String() string