perpetuals

package
v1.1.1 Latest Latest
Warning

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

Go to latest
Published: Jul 10, 2025 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreatePerpInfo

func CreatePerpInfo(
	id uint32,
	atomicResolution int32,
	price uint64,
	priceExponent int32,
) perptypes.PerpInfo

func GeneratePerpetual

func GeneratePerpetual(optionalModifications ...PerpetualModifierOption) *perptypes.Perpetual

GeneratePerpetual returns a `Perpetual` object set to default values. Passing in `PerpetualModifierOption` methods alters the value of the `Perpetual` returned. It will start with the default, valid `Perpetual` value defined within the method and make the requested modifications before returning the object.

Example usage: `GeneratePerpetual(WithId(10))` This will start with the default `Perpetual` object defined within the method and return the newly-created object after overriding the values of `Id` to 10.

func MustHumanSizeToBaseQuantums

func MustHumanSizeToBaseQuantums(
	humanSize string,
	atomicResolution int32,
) (baseQuantums uint64)

MustHumanSizeToBaseQuantums converts a human-readable size to quantums. It uses the inverse of the exponent to convert the human size to quantums, since the exponent applies to the quantums to derive the human-readable size.

func SetUpDefaultPerpOIsForTest

func SetUpDefaultPerpOIsForTest(
	t testing.TB,
	ctx sdk.Context,
	k perptypes.PerpetualsKeeper,
	perps []perptypes.Perpetual,
)

Helper function to set up default open interest for input perpetuals.

Types

type PerpetualModifierOption

type PerpetualModifierOption func(cp *perptypes.Perpetual)

func WithAtomicResolution

func WithAtomicResolution(atomicResolution int32) PerpetualModifierOption

func WithId

func WithLiquidityTier

func WithLiquidityTier(liquidityTier uint32) PerpetualModifierOption

func WithMarketId

func WithMarketId(id uint32) PerpetualModifierOption

func WithTicker

func WithTicker(ticker string) PerpetualModifierOption

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL