package crescent.liquidity.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:13Msg defines the Msg service.
rpc CancelAllOrders (, )
tx.proto:42CancelAllOrders defines a method for cancelling all orders
message
tx.proto:234MsgCancelAllOrders defines an SDK message for cancelling all orders
string orderer = 1
orderer specifies the bech32-encoded address that makes an order
repeated uint64 pair_ids = 2
pair_ids specifies pair ids to cancel orders
message
tx.proto:243MsgCancelAllOrdersResponse defines the Msg/CancelAllOrders response type.
(message has no fields)
rpc CancelOrder (, )
tx.proto:39CancelOrder defines a method for cancelling an order
message
tx.proto:219MsgCancelOrder defines an SDK message for cancelling an order
string orderer = 1
orderer specifies the bech32-encoded address that makes an order
uint64 pair_id = 2
pair_id specifies the pair id
uint64 order_id = 3
order_id specifies the order id
message
tx.proto:231MsgCancelOrderResponse defines the Msg/CancelOrder response type.
(message has no fields)
rpc CreatePair (, )
tx.proto:15CreatePair defines a method for creating a pair
message
tx.proto:46MsgCreatePair defines an SDK message for creating a pair.
string creator = 1
creator specifies the bech32-encoded address that is the pair creator.
string base_coin_denom = 2
base_coin_denom specifies the base coin denom of the pair.
string quote_coin_denom = 3
quote_coin_denom specifies the quote coin denom of the pair.
message
tx.proto:57(message has no fields)
rpc CreatePool (, )
tx.proto:18CreatePool defines a method for creating a pool
message
tx.proto:60MsgCreatePool defines an SDK message for creating a pool.
string creator = 1
creator specifies the bech32-encoded address that is the pool creator
uint64 pair_id = 2
pair_id specifies the pair id.
repeated deposit_coins = 3
deposit_coins specifies the amount of coins to deposit.
message
tx.proto:73MsgCreatePoolResponse defines the Msg/CreatePool response type.
(message has no fields)
rpc CreateRangedPool (, )
tx.proto:21CreateRangePool defines a method for creating a ranged pool
message
tx.proto:76MsgCreateRangedPool defines an SDK message for creating a ranged pool.
string creator = 1
creator specifies the bech32-encoded address that is the pool creator
uint64 pair_id = 2
pair_id specifies the pair id.
repeated deposit_coins = 3
deposit_coins specifies the amount of coins to deposit.
string min_price = 4
string max_price = 5
string initial_price = 6
message
tx.proto:98MsgCreateRangedPoolResponse defines the Msg/CreateRangedPool response type.
(message has no fields)
rpc Deposit (, )
tx.proto:24Deposit defines a method for depositing coins to the pool
message
tx.proto:101MsgDeposit defines an SDK message for depositing coins to the pool
string depositor = 1
depositor specifies the bech32-encoded address that makes a deposit to the pool
uint64 pool_id = 2
pool_id specifies the pool id
repeated deposit_coins = 3
deposit_coins specifies the amount of coins to deposit.
message
tx.proto:114MsgDepositResponse defines the Msg/Deposit response type.
(message has no fields)
rpc LimitOrder (, )
tx.proto:30LimitOrder defines a method for making a limit order
message
tx.proto:132MsgLimitOrder defines an SDK message for making a limit order
string orderer = 1
orderer specifies the bech32-encoded address that makes an order
uint64 pair_id = 2
pair_id specifies the pair id
OrderDirection direction = 3
direction specifies the order direction(buy or sell)
optional offer_coin = 4
offer_coin specifies the amount of coin the orderer offers
string demand_coin_denom = 5
demand_coin_denom specifies the demand coin denom
string price = 6
price specifies the order price
string amount = 7
amount specifies the amount of base coin the orderer wants to buy or sell
optional order_lifespan = 8
order_lifespan specifies the order lifespan
message
tx.proto:159MsgLimitOrderResponse defines the Msg/LimitOrder response type.
(message has no fields)
rpc MMOrder (, )
tx.proto:36MsgMMOrder defines a method for making a MM(market making) order
message
tx.proto:189MsgMMOrder defines an SDK message for making a MM(market making) order.
string orderer = 1
orderer specifies the bech32-encoded address that makes an order
uint64 pair_id = 2
pair_id specifies the pair id
OrderDirection direction = 3
direction specifies the order direction(buy or sell)
optional offer_coin = 4
offer_coin specifies the amount of coin the orderer offers
string demand_coin_denom = 5
demand_coin_denom specifies the demand coin denom
string price = 6
price specifies the order price
string amount = 7
amount specifies the amount of base coin the orderer wants to buy or sell
optional order_lifespan = 8
order_lifespan specifies the order lifespan
message
tx.proto:216MsgMMOrderResponse defines the Msg/MMOrder response type.
(message has no fields)
rpc MarketOrder (, )
tx.proto:33MarketOrder defines a method for making a market order
message
tx.proto:162MsgMarketOrder defines an SDK message for making a market order
string orderer = 1
orderer specifies the bech32-encoded address that makes an order
uint64 pair_id = 2
pair_id specifies the pair id
OrderDirection direction = 3
direction specifies the order direction(buy or sell)
optional offer_coin = 4
offer_coin specifies the amount of coin the orderer offers
string demand_coin_denom = 5
demand_coin_denom specifies the demand coin denom
string amount = 6
amount specifies the amount of base coin the orderer wants to buy or sell
optional order_lifespan = 7
order_lifespan specifies the order lifespan
message
tx.proto:186MsgMarketOrderResponse defines the Msg/MarketOrder response type.
(message has no fields)
rpc Withdraw (, )
tx.proto:27Withdraw defines a method for withdrawing pool coin from the pool
message
tx.proto:117MsgWithdraw defines an SDK message for withdrawing pool coin from the pool
string withdrawer = 1
withdrawer specifies the bech32-encoded address that withdraws pool coin from the pool
uint64 pool_id = 2
pool_id specifies the pool id
optional pool_coin = 3
pool_coin specifies the pool coin that is a proof of liquidity provider for the pool
message
tx.proto:129MsgWithdrawResponse defines the Msg/Withdraw response type.
(message has no fields)
service Query
query.proto:13Query defines the gRPC querier service.
rpc DepositRequest (, )
query.proto:55DepositRequest returns the specific deposit request.
message
query.proto:176QueryDepositRequestRequest is request type for the Query/DepositRequest RPC method.
uint64 pool_id = 1
uint64 id = 2
message
query.proto:182QueryDepositRequestResponse is response type for the Query/DepositRequest RPC method.
optional deposit_request = 1
rpc DepositRequests (, )
query.proto:50DepositRequests returns all deposit requests.
message
query.proto:162QueryDepositRequestsRequest is request type for the Query/DepositRequests RPC method.
uint64 pool_id = 1
optional pagination = 2
message
query.proto:169QueryDepositRequestsResponse is response type for the Query/DepositRequests RPC method.
repeated deposit_requests = 1
optional pagination = 2
rpc NumMMOrders (, )
query.proto:88message
query.proto:255string orderer = 1
uint64 pair_id = 2
message
query.proto:260uint32 num_market_making_orders = 1
rpc Order (, )
query.proto:75Order returns the specific order.
message
query.proto:226QueryOrderRequest is request type for the Query/Order RPC method.
uint64 pair_id = 1
uint64 id = 2
message
query.proto:232QueryOrderResponse is response type for the Query/Order RPC method.
optional order = 1
rpc OrderBooks (, )
query.proto:84message
query.proto:244QueryOrderBooksRequest is request type for the Query/OrderBooks RPC method.
repeated uint64 pair_ids = 1
repeated uint32 price_unit_powers = 2
uint32 num_ticks = 3
message
query.proto:251QueryOrderBooksResponse is response type for Query/OrderBooks RPC method.
repeated pairs = 2
rpc Orders (, )
query.proto:70Orders returns all orders within the pair.
message
query.proto:212QueryOrdersRequest is request type for the Query/Orders RPC method.
uint64 pair_id = 1
optional pagination = 2
rpc OrdersByOrderer (, )
query.proto:80OrdersByOrderer returns orders made by an orderer.
message
query.proto:237QueryOrdersByOrdererRequest is request type for the Query/OrdersByOrderer RPC method.
string orderer = 1
uint64 pair_id = 2
optional pagination = 3
rpc Pair (, )
query.proto:45Pair returns the specific pair.
message
query.proto:152QueryPairRequest is request type for the Query/Pair RPC method.
uint64 pair_id = 1
message
query.proto:157QueryPairResponse is response type for the Query/Pair RPC method.
optional pair = 1
rpc Pairs (, )
query.proto:40Pairs returns all liquidity pairs.
message
query.proto:138QueryPairsRequest is request type for the Query/Pairs RPC method.
repeated string denoms = 1
optional pagination = 2
message
query.proto:145QueryPairsResponse is response type for the Query/Pairs RPC method.
repeated pairs = 1
optional pagination = 2
rpc Params (, )
query.proto:15Params returns parameters of the module.
message
query.proto:94QueryParamsRequest is request type for the Query/Params RPC method.
(message has no fields)
message
query.proto:97QueryParamsResponse is response type for the Query/Params RPC method.
optional params = 1
rpc Pool (, )
query.proto:25Pool returns the specific liquidity pool.
message
query.proto:118QueryPoolRequest is request type for the Query/Pool RPC method.
uint64 pool_id = 1
rpc PoolByPoolCoinDenom (, )
query.proto:35PoolByPoolCoinDenom returns all pools that correspond to the pool coin denom.
message
query.proto:133QueryPoolByPoolCoinDenomRequest is request type for the Query/PoolByPoolCoinDenom RPC method.
string pool_coin_denom = 1
rpc PoolByReserveAddress (, )
query.proto:30PoolByReserveAddress returns all pools that correspond to the reserve account.
message
query.proto:128QueryPoolByReserveAddressRequest is request type for the Query/PoolByReserveAddress RPC method.
string reserve_address = 1
rpc Pools (, )
query.proto:20Pools returns all liquidity pools.
message
query.proto:102QueryPoolsRequest is request type for the Query/Pools RPC method.
uint64 pair_id = 1
string disabled = 2
optional pagination = 3
message
query.proto:111QueryPoolsResponse is response type for the Query/Pools RPC method.
repeated pools = 1
optional pagination = 2
rpc WithdrawRequest (, )
query.proto:65WithdrawRequest returns the specific withdraw request.
message
query.proto:201QueryWithdrawRequestRequest is request type for the Query/WithdrawRequest RPC method.
uint64 pool_id = 1
uint64 id = 2
message
query.proto:207QueryWithdrawRequestResponse is response type for the Query/WithdrawRequest RPC method.
optional withdraw_request = 1
rpc WithdrawRequests (, )
query.proto:60WithdrawRequests returns all withdraw requests.
message
query.proto:187QueryWithdrawRequestsRequest is request type for the Query/WithdrawRequests RPC method.
uint64 pool_id = 1
optional pagination = 2
message
query.proto:194QueryWithdrawRequestsResponse is response type for the Query/WithdrawRequests RPC method.
repeated withdraw_requests = 1
optional pagination = 2
message
liquidity.proto:105DepositRequest defines a deposit request.
Used in: , ,
uint64 id = 1
id specifies the id for the request
uint64 pool_id = 2
pool_id specifies the pool id
int64 msg_height = 3
msg_height specifies the block height when the request is stored for the batch execution
string depositor = 4
depositor specifies the bech32-encoded address that makes a deposit to the pool
repeated deposit_coins = 5
deposit_coins specifies the amount of coins to deposit.
repeated accepted_coins = 6
accepted_coins specifies the amount of coins that are accepted.
optional minted_pool_coin = 7
RequestStatus status = 8
message
genesis.proto:11GenesisState defines the liquidity module's genesis state.
optional params = 1
uint64 last_pair_id = 2
uint64 last_pool_id = 3
repeated pairs = 4
repeated pools = 5
repeated deposit_requests = 6
repeated withdraw_requests = 7
repeated orders = 8
repeated num_market_making_orders_records = 9
message
genesis.proto:33NumMMOrdersRecord holds information about how many MM orders an orderer ordered per pair.
Used in:
string orderer = 1
uint64 pair_id = 2
uint32 num_market_making_orders = 3
message
liquidity.proto:156Order defines an order.
Used in: , ,
OrderType type = 1
type specifies the typo of the order
uint64 id = 2
id specifies the id of the order
uint64 pair_id = 3
pair_id specifies the pair id
int64 msg_height = 4
msg_height specifies the block height when the order is stored for the batch execution
string orderer = 5
orderer specifies the bech32-encoded address that makes an order
OrderDirection direction = 6
direction specifies the order direction; either buy or sell
optional offer_coin = 7
optional remaining_offer_coin = 8
remaining_offer_coin specifies the remaining offer coin
optional received_coin = 9
received_coin specifies the received coin after the swap
string price = 10
price specifies the price that an orderer is willing to swap
string amount = 11
string open_amount = 12
uint64 batch_id = 13
batch_id specifies the pair's batch id when the request is stored
optional expire_at = 14
OrderStatus status = 15
message
query.proto:306Used in:
uint64 pair_id = 1
string base_price = 2
repeated order_books = 3
message
query.proto:313Used in:
string price_unit = 1
repeated sells = 2
repeated buys = 3
message
query.proto:320Used in:
string price = 1
string user_order_amount = 2
string pool_order_amount = 3
OrderDirection enumerates order directions.
Used in: , , ,
ORDER_DIRECTION_UNSPECIFIED = 0
ORDER_DIRECTION_UNSPECIFIED specifies unknown order direction
ORDER_DIRECTION_BUY = 1
ORDER_DIRECTION_BUY specifies buy(swap quote coin to base coin) order direction
ORDER_DIRECTION_SELL = 2
ORDER_DIRECTION_SELL specifies sell(swap base coin to quote coin) order direction
OrderStatus enumerates order statuses.
Used in:
ORDER_STATUS_UNSPECIFIED = 0
ORDER_STATUS_UNSPECIFIED specifies unknown order status
ORDER_STATUS_NOT_EXECUTED = 1
ORDER_STATUS_NOT_EXECUTED indicates the order has not been executed yet
ORDER_STATUS_NOT_MATCHED = 2
ORDER_STATUS_NOT_MATCHED indicates the order has been executed but has no match
ORDER_STATUS_PARTIALLY_MATCHED = 3
ORDER_STATUS_PARTIALLY_MATCHED indicates the order has been partially matched
ORDER_STATUS_COMPLETED = 4
ORDER_STATUS_COMPLETED indicates the order has been fully matched and completed
ORDER_STATUS_CANCELED = 5
ORDER_STATUS_CANCELED indicates the order has been canceled
ORDER_STATUS_EXPIRED = 6
ORDER_STATUS_EXPIRED indicates the order has been expired
OrderType enumerates order types.
Used in:
ORDER_TYPE_UNSPECIFIED = 0
ORDER_TYPE_UNSPECIFIED specifies unknown order type.
ORDER_TYPE_LIMIT = 1
ORDER_TYPE_LIMIT specifies limit order type.
ORDER_TYPE_MARKET = 2
ORDER_TYPE_MARKET specifies market order type.
ORDER_TYPE_MM = 3
ORDER_TYPE_MM specifies MM(market making) order type.
message
liquidity.proto:62Pair defines a coin pair.
Used in: , ,
uint64 id = 1
string base_coin_denom = 2
string quote_coin_denom = 3
string escrow_address = 4
uint64 last_order_id = 5
string last_price = 6
uint64 current_batch_id = 7
message
liquidity.proto:13Params defines the parameters for the liquidity module.
Used in: ,
uint32 batch_size = 1
uint32 tick_precision = 2
string fee_collector_address = 3
string dust_collector_address = 4
string min_initial_pool_coin_supply = 5
repeated pair_creation_fee = 6
repeated pool_creation_fee = 7
string min_initial_deposit_amount = 8
string max_price_limit_ratio = 9
uint32 max_num_market_making_order_ticks = 10
uint32 max_num_market_making_orders_per_pair = 11
optional max_order_lifespan = 12
string swap_fee_rate = 13
string withdraw_fee_rate = 14
uint64 deposit_extra_gas = 15
uint64 withdraw_extra_gas = 16
uint64 order_extra_gas = 17
uint32 max_num_active_pools_per_pair = 18
message
liquidity.proto:80Pool defines generic liquidity pool object which can be either a basic pool or a ranged pool.
Used in:
PoolType type = 1
uint64 id = 2
uint64 pair_id = 3
string creator = 4
string reserve_address = 5
string pool_coin_denom = 6
string min_price = 7
string max_price = 8
uint64 last_deposit_request_id = 9
uint64 last_withdraw_request_id = 10
bool disabled = 11
message
query.proto:300Used in:
optional base_coin = 1
optional quote_coin = 2
message
query.proto:269PoolResponse defines a custom pool response message.
Used in: ,
PoolType type = 1
uint64 id = 2
uint64 pair_id = 3
string creator = 4
string reserve_address = 5
string pool_coin_denom = 6
string pool_coin_supply = 7
string min_price = 8
string max_price = 9
string price = 10
optional balances = 11
uint64 last_deposit_request_id = 12
uint64 last_withdraw_request_id = 13
bool disabled = 14
PoolType enumerates pool types.
Used in: ,
POOL_TYPE_UNSPECIFIED = 0
POOL_TYPE_UNSPECIFIED specifies unknown pool type
POOL_TYPE_BASIC = 1
POOL_TYPE_BASIC specifies the basic pool type
POOL_TYPE_RANGED = 2
POOL_TYPE_RANGED specifies the ranged pool type
message
query.proto:219QueryOrdersResponse is response type for the Query/Orders RPC method.
Used as response type in: Query.Orders, Query.OrdersByOrderer
repeated orders = 1
optional pagination = 2
message
query.proto:123QueryPoolResponse is response type for the Query/Pool RPC method.
Used as response type in: Query.Pool, Query.PoolByPoolCoinDenom, Query.PoolByReserveAddress
optional pool = 1
RequestStatus enumerates request statuses.
Used in: ,
REQUEST_STATUS_UNSPECIFIED = 0
REQUEST_STATUS_UNSPECIFIED specifies unknown request status
REQUEST_STATUS_NOT_EXECUTED = 1
REQUEST_STATUS_NOT_EXECUTED indicates the request is not executed yet
REQUEST_STATUS_SUCCEEDED = 2
REQUEST_STATUS_SUCCEEDED indicates the request has been succeeded
REQUEST_STATUS_FAILED = 3
REQUEST_STATUS_FAILED indicates the request is failed
message
liquidity.proto:132WithdrawRequest defines a withdraw request.
Used in: , ,
uint64 id = 1
id specifies the id for the request
uint64 pool_id = 2
pool_id specifies the pool id
int64 msg_height = 3
msg_height specifies the block height when the request is stored for the batch execution
string withdrawer = 4
withdrawer specifies the bech32-encoded address that withdraws pool coin from the pool
optional pool_coin = 5
pool_coin specifies the pool coin that is a proof of liquidity provider for the pool
repeated withdrawn_coins = 6
withdrawn_coins specifies the amount of coins that are withdrawn.
RequestStatus status = 7