market

Documentation

Index

• Constants
• func ErrExceedsDailySwapLimit(codespace sdk.CodespaceType, denom string) sdk.Error
• func ErrInsufficientSwapCoins(codespace sdk.CodespaceType, rval sdk.Int) sdk.Error
• func ErrNoEffectivePrice(codespace sdk.CodespaceType, denom string) sdk.Error
• func ErrRecursiveSwap(codespace sdk.CodespaceType, denom string) sdk.Error
• func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState)
• func NewHandler(k Keeper) sdk.Handler
• func RegisterCodec(cdc *codec.Codec)
• func ValidateGenesis(data GenesisState) error
• type GenesisState
  • func DefaultGenesisState() GenesisState
  • func ExportGenesis(ctx sdk.Context, keeper Keeper) GenesisState
  • func NewGenesisState(params Params) GenesisState
• type Keeper
  • func NewKeeper(ok oracle.Keeper, mk mint.Keeper, paramspace params.Subspace) Keeper
  • func (k Keeper) GetParams(ctx sdk.Context) Params
  • func (k Keeper) SetParams(ctx sdk.Context, params Params)
  • func (k Keeper) SwapCoins(ctx sdk.Context, offerCoin sdk.Coin, askDenom string) (sdk.Coin, sdk.Error)
  • func (k Keeper) SwapDecCoins(ctx sdk.Context, offerCoin sdk.DecCoin, askDenom string) (sdk.DecCoin, sdk.Error)
• type MsgSwap
  • func NewMsgSwap(traderAddress sdk.AccAddress, offerCoin sdk.Coin, askCoin string) MsgSwap
  • func (msg MsgSwap) GetSignBytes() []byte
  • func (msg MsgSwap) GetSigners() []sdk.AccAddress
  • func (msg MsgSwap) Route() string
  • func (msg MsgSwap) String() string
  • func (msg MsgSwap) Type() string
  • func (msg MsgSwap) ValidateBasic() sdk.Error
• type Params
  • func DefaultParams() Params
  • func NewParams(dailySwapLimit sdk.Dec) Params
  • func (params Params) String() string

Constants

const (
	// ModuleName is the name of the market module
	ModuleName = "market"

	// StoreKey is the string store representation
	StoreKey = ModuleName

	// RouterKey is the msg router key for the market module
	RouterKey = ModuleName

	// DefaultParamspace is for the paramspace notation
	DefaultParamspace = ModuleName
)

const (
	DefaultCodespace sdk.CodespaceType = "market"

	CodeInsufficientSwap sdk.CodeType = 1
	CodeNoEffectivePrice sdk.CodeType = 2
	CodeRecursiveSwap    sdk.CodeType = 3
	CodeExceedsSwapLimit sdk.CodeType = 4
)

market error codes

Functions

func ErrExceedsDailySwapLimit

func ErrExceedsDailySwapLimit(codespace sdk.CodespaceType, denom string) sdk.Error

ErrExceedsDailySwapLimit called when the coin swap exceeds the daily swap limit

func ErrInsufficientSwapCoins

func ErrInsufficientSwapCoins(codespace sdk.CodespaceType, rval sdk.Int) sdk.Error

ErrInsufficientSwapCoins called when not enough coins are being requested for a swap

func ErrNoEffectivePrice

func ErrNoEffectivePrice(codespace sdk.CodespaceType, denom string) sdk.Error

ErrNoEffectivePrice called when a price for the asset is not registered with the oracle

func ErrRecursiveSwap

func ErrRecursiveSwap(codespace sdk.CodespaceType, denom string) sdk.Error

ErrRecursiveSwap called when Ask and Offer coin denominatioins are equal

func InitGenesis

func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState)

new oracle genesis

func NewHandler

func NewHandler(k Keeper) sdk.Handler

NewHandler creates a new handler for all market type messages.

func RegisterCodec

func RegisterCodec(cdc *codec.Codec)

RegisterCodec concretes types on codec codec

func ValidateGenesis

func ValidateGenesis(data GenesisState) error

ValidateGenesis validates the provided oracle genesis state to ensure the expected invariants holds. (i.e. params in correct bounds, no duplicate validators)

Types

type GenesisState

type GenesisState struct {
	Params Params `json:"params"` // market params
}

GenesisState - all distribution state that must be provided at genesis

func DefaultGenesisState

func DefaultGenesisState() GenesisState

get raw genesis raw message for testing

func ExportGenesis

func ExportGenesis(ctx sdk.Context, keeper Keeper) GenesisState

ExportGenesis returns a GenesisState for a given context and keeper. The GenesisState will contain the pool, and validator/delegator distribution info's

func NewGenesisState

func NewGenesisState(params Params) GenesisState

type Keeper

type Keeper struct {
	// contains filtered or unexported fields
}

Keeper holds data structures for the market module

func NewKeeper

func NewKeeper(ok oracle.Keeper, mk mint.Keeper, paramspace params.Subspace) Keeper

NewKeeper creates a new Keeper for the market module

func (Keeper) GetParams

func (k Keeper) GetParams(ctx sdk.Context) Params

GetParams get budget params from the global param store

func (Keeper) SetParams

func (k Keeper) SetParams(ctx sdk.Context, params Params)

SetParams set budget params from the global param store

func (Keeper) SwapCoins

func (k Keeper) SwapCoins(ctx sdk.Context, offerCoin sdk.Coin, askDenom string) (sdk.Coin, sdk.Error)

SwapCoins returns the amount of asked coins should be returned for a given offerCoin at the effective exchange rate registered with the oracle. Returns an Error if the swap is recursive, or the coins to be traded are unknown by the oracle, or the amount to trade is too small.

func (Keeper) SwapDecCoins

func (k Keeper) SwapDecCoins(ctx sdk.Context, offerCoin sdk.DecCoin, askDenom string) (sdk.DecCoin, sdk.Error)

SwapDecCoins returns the amount of asked DecCoins should be returned for a given offerCoin at the effective exchange rate registered with the oracle. Similar to SwapCoins, but operates over sdk.DecCoins for convinience and accuracy.

type MsgSwap

type MsgSwap struct {
	Trader    sdk.AccAddress `json:"trader"`     // Address of the trader
	OfferCoin sdk.Coin       `json:"offer_coin"` // Coin being offered
	AskDenom  string         `json:"ask_denom"`  // Denom of the coin to swap to
}

MsgSwap contains a swap request

func NewMsgSwap

func NewMsgSwap(traderAddress sdk.AccAddress, offerCoin sdk.Coin, askCoin string) MsgSwap

NewMsgSwap creates a MsgSwap instance

func (MsgSwap) GetSignBytes

func (msg MsgSwap) GetSignBytes() []byte

GetSignBytes Implements Msg

func (MsgSwap) GetSigners

func (msg MsgSwap) GetSigners() []sdk.AccAddress

GetSigners Implements Msg

func (MsgSwap) Route

func (msg MsgSwap) Route() string

Route Implements Msg

func (MsgSwap) String

func (msg MsgSwap) String() string

String Implements Msg

func (MsgSwap) Type

func (msg MsgSwap) Type() string

Type implements sdk.Msg

func (MsgSwap) ValidateBasic

func (msg MsgSwap) ValidateBasic() sdk.Error

ValidateBasic Implements Msg

type Params

type Params struct {
	DailySwapLimit sdk.Dec `json:"daily_swap_limit"` // daily % inflation cap on a currency from swaps
}

Params market parameters

func DefaultParams

func DefaultParams() Params

DefaultParams creates default market module parameters

func NewParams

func NewParams(dailySwapLimit sdk.Dec) Params

NewParams creates a new param instance

func (Params) String

func (params Params) String() string