package kava.swap.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:11Msg defines the swap Msg service.
rpc Deposit (, )
tx.proto:13Deposit defines a method for depositing liquidity into a pool
message
tx.proto:23MsgDeposit represents a message for depositing liquidity into a pool
string depositor = 1
depositor represents the address to deposit funds from
optional token_a = 2
token_a represents one token of deposit pair
optional token_b = 3
token_b represents one token of deposit pair
string slippage = 4
slippage represents the max decimal percentage price change
int64 deadline = 5
deadline represents the unix timestamp to complete the deposit by
message
tx.proto:43MsgDepositResponse defines the Msg/Deposit response type.
(message has no fields)
rpc Withdraw (, )
tx.proto:15Withdraw defines a method for withdrawing liquidity into a pool
message
tx.proto:46MsgWithdraw represents a message for withdrawing liquidity from a pool
string from = 1
from represents the address we are withdrawing for
string shares = 2
shares represents the amount of shares to withdraw
optional min_token_a = 3
min_token_a represents the minimum a token to withdraw
optional min_token_b = 4
min_token_a represents the minimum a token to withdraw
int64 deadline = 5
deadline represents the unix timestamp to complete the withdraw by
message
tx.proto:65MsgWithdrawResponse defines the Msg/Withdraw response type.
(message has no fields)
rpc SwapExactForTokens (, )
tx.proto:17SwapExactForTokens represents a message for trading exact coinA for coinB
message
tx.proto:68MsgSwapExactForTokens represents a message for trading exact coinA for coinB
string requester = 1
represents the address swaping the tokens
optional exact_token_a = 2
exact_token_a represents the exact amount to swap for token_b
optional token_b = 3
token_b represents the desired token_b to swap for
string slippage = 4
slippage represents the maximum change in token_b allowed
int64 deadline = 5
deadline represents the unix timestamp to complete the swap by
message
tx.proto:89MsgSwapExactForTokensResponse defines the Msg/SwapExactForTokens response type.
(message has no fields)
rpc SwapForExactTokens (, )
tx.proto:19SwapForExactTokens represents a message for trading coinA for an exact coinB
message
tx.proto:93MsgSwapForExactTokens represents a message for trading coinA for an exact coinB
string requester = 1
represents the address swaping the tokens
optional token_a = 2
token_a represents the desired token_a to swap for
optional exact_token_b = 3
exact_token_b represents the exact token b amount to swap for token a
string slippage = 4
slippage represents the maximum change in token_a allowed
int64 deadline = 5
deadline represents the unix timestamp to complete the swap by
message
tx.proto:114MsgSwapForExactTokensResponse defines the Msg/SwapForExactTokensResponse response type.
(message has no fields)
service Query
query.proto:14Query defines the gRPC querier service for swap module
rpc Params (, )
query.proto:16Params queries all parameters of the swap module.
message
query.proto:30QueryParamsRequest defines the request type for querying x/swap parameters.
(message has no fields)
message
query.proto:35QueryParamsResponse defines the response type for querying x/swap parameters.
optional params = 1
params represents the swap module parameters
rpc Pools (, )
query.proto:20Pools queries pools based on pool ID
message
query.proto:43QueryPoolsRequest is the request type for the Query/Pools RPC method.
string pool_id = 1
pool_id filters pools by id
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:51QueryPoolsResponse is the response type for the Query/Pools RPC method.
repeated pools = 1
pools represents returned pools
optional pagination = 2
pagination defines the pagination in the response.
rpc Deposits (, )
query.proto:24Deposits queries deposit details based on owner address and pool
message
query.proto:78QueryDepositsRequest is the request type for the Query/Deposits RPC method.
string owner = 1
owner optionally filters deposits by owner
string pool_id = 2
pool_id optionally fitlers deposits by pool id
optional pagination = 3
pagination defines an optional pagination for the request.
message
query.proto:90QueryDepositsResponse is the response type for the Query/Deposits RPC method.
repeated deposits = 1
deposits returns the deposits matching the requested parameters
optional pagination = 2
pagination defines the pagination in the response.
message
swap.proto:28AllowedPool defines a pool that is allowed to be created
Used in:
string token_a = 1
token_a represents the a token allowed
string token_b = 2
token_b represents the b token allowed
message
query.proto:100DepositResponse defines a single deposit query response type.
Used in:
string depositor = 1
depositor represents the owner of the deposit
string pool_id = 2
pool_id represents the pool the deposit is for
string shares_owned = 3
shares_owned presents the shares owned by the depositor for the pool
repeated shares_value = 4
shares_value represents the coin value of the shares_owned
message
genesis.proto:10GenesisState defines the swap module's genesis state.
optional params = 1
params defines all the parameters related to swap
repeated pool_records = 2
pool_records defines the available pools
repeated share_records = 3
share_records defines the owned shares of each pool
message
swap.proto:11Params defines the parameters for the swap module.
Used in: ,
repeated allowed_pools = 1
allowed_pools defines that pools that are allowed to be created
string swap_fee = 2
swap_fee defines the swap fee for all pools
message
swap.proto:39PoolRecord represents the state of a liquidity pool and is used to store the state of a denominated pool
Used in:
string pool_id = 1
pool_id represents the unique id of the pool
optional reserves_a = 2
reserves_a is the a token coin reserves
optional reserves_b = 3
reserves_b is the a token coin reserves
string total_shares = 4
total_shares is the total distrubuted shares of the pool
message
query.proto:59Pool represents the state of a single pool
Used in:
string name = 1
name represents the name of the pool
repeated coins = 2
coins represents the total reserves of the pool
string total_shares = 3
total_shares represents the total shares of the pool
message
swap.proto:55ShareRecord stores the shares owned for a depositor and pool
Used in:
bytes depositor = 1
depositor represents the owner of the shares
string pool_id = 2
pool_id represents the pool the shares belong to
string shares_owned = 3
shares_owned represents the number of shares owned by depsoitor for the pool_id