perpetuals

Documentation

Index

• func GeneratePerpetual(optionalModifications ...PerpetualModifierOption) *perptypes.Perpetual
• func MustHumanSizeToBaseQuantums(humanSize string, atomicResolution int32) (baseQuantums uint64)
• type PerpetualModifierOption
  • func WithId(id uint32) PerpetualModifierOption
  • func WithLiquidityTier(liquidityTier uint32) PerpetualModifierOption
  • func WithMarketId(id uint32) PerpetualModifierOption
  • func WithPerpetual(perp perptypes.Perpetual) PerpetualModifierOption
  • func WithTicker(ticker string) PerpetualModifierOption

Functions

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)

Types

type PerpetualModifierOption

type PerpetualModifierOption func(cp *perptypes.Perpetual)

func WithId

func WithId(id uint32) PerpetualModifierOption

func WithLiquidityTier

func WithLiquidityTier(liquidityTier uint32) PerpetualModifierOption

func WithMarketId

func WithMarketId(id uint32) PerpetualModifierOption

func WithPerpetual

func WithPerpetual(perp perptypes.Perpetual) PerpetualModifierOption

func WithTicker

func WithTicker(ticker string) PerpetualModifierOption