rest

Documentation

Index

• Constants
• func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)
• type PostCreateDepositReq
• type PostCreateSwapExactForTokensReq
• type PostCreateSwapForExactTokensReq
• type PostCreateWithdrawReq

Constants

const (
	RestPool  = "pool"
	RestOwner = "owner"
)

REST variable names nolint

Functions

func RegisterRoutes

func RegisterRoutes(cliCtx context.CLIContext, r *mux.Router)

RegisterRoutes registers swap-related REST handlers to a router

Types

type PostCreateDepositReq

type PostCreateDepositReq struct {
	BaseReq  rest.BaseReq   `json:"base_req" yaml:"base_req"`
	From     sdk.AccAddress `json:"from" yaml:"from"`
	TokenA   sdk.Coin       `json:"token_a" yaml:"token_a"`
	TokenB   sdk.Coin       `json:"token_b" yaml:"token_b"`
	Slippage sdk.Dec        `json:"slippage" yaml:"slippage"`
	Deadline int64          `json:"deadline" yaml:"deadline"`
}

PostCreateDepositReq defines the properties of a deposit create request's body

type PostCreateSwapExactForTokensReq

type PostCreateSwapExactForTokensReq struct {
	BaseReq     rest.BaseReq   `json:"base_req" yaml:"base_req"`
	Requester   sdk.AccAddress `json:"requester" yaml:"requester"`
	ExactTokenA sdk.Coin       `json:"exact_token_a" yaml:"exact_token_a"`
	TokenB      sdk.Coin       `json:"token_b" yaml:"token_b"`
	Slippage    sdk.Dec        `json:"slippage" yaml:"slippage"`
	Deadline    int64          `json:"deadline" yaml:"deadline"`
}

PostCreateSwapExactForTokensReq trades an exact coinA for coinB

type PostCreateSwapForExactTokensReq

type PostCreateSwapForExactTokensReq struct {
	BaseReq     rest.BaseReq   `json:"base_req" yaml:"base_req"`
	Requester   sdk.AccAddress `json:"requester" yaml:"requester"`
	TokenA      sdk.Coin       `json:"exact_token_a" yaml:"exact_token_a"`
	ExactTokenB sdk.Coin       `json:"token_b" yaml:"token_b"`
	Slippage    sdk.Dec        `json:"slippage" yaml:"slippage"`
	Deadline    int64          `json:"deadline" yaml:"deadline"`
}

PostCreateSwapForExactTokensReq trades an exact coinA for coinB

type PostCreateWithdrawReq

type PostCreateWithdrawReq struct {
	BaseReq   rest.BaseReq   `json:"base_req" yaml:"base_req"`
	From      sdk.AccAddress `json:"from" yaml:"from"`
	Shares    sdk.Int        `json:"shares" yaml:"shares"`
	MinTokenA sdk.Coin       `json:"token_a" yaml:"token_a"`
	MinTokenB sdk.Coin       `json:"token_b" yaml:"token_b"`
	Deadline  int64          `json:"deadline" yaml:"deadline"`
}

PostCreateWithdrawReq defines the properties of a withdraw create request's body