package tendermint.liquidity.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:11Msg defines the liquidity Msg service.
rpc CreatePool (, )
tx.proto:14Submit a create liquidity pool message.
message
tx.proto:29MsgCreatePool defines an sdk.Msg type that supports submitting a create liquidity pool tx. See: https://github.com/tendermint/liquidity/blob/develop/x/liquidity/spec/04_messages.md
string pool_creator_address = 1
uint32 pool_type_id = 2
id of the target pool type, must match the value in the pool. Only pool-type-id 1 is supported.
repeated deposit_coins = 4
reserve coin pair of the pool to deposit.
message
tx.proto:58MsgCreatePoolResponse defines the Msg/CreatePool response type.
(message has no fields)
rpc DepositWithinBatch (, )
tx.proto:17Submit a deposit to the liquidity pool batch.
message
tx.proto:99MsgDepositWithinBatchResponse defines the Msg/DepositWithinBatch response type.
(message has no fields)
rpc WithdrawWithinBatch (, )
tx.proto:20Submit a withdraw from the liquidity pool batch.
message
tx.proto:135MsgWithdrawWithinBatchResponse defines the Msg/WithdrawWithinBatch response type.
(message has no fields)
rpc Swap (, )
tx.proto:23Submit a swap to the liquidity pool batch.
message
tx.proto:211MsgSwapWithinBatchResponse defines the Msg/Swap response type.
(message has no fields)
service Query
query.proto:13Query defines the gRPC query service for the liquidity module.
rpc LiquidityPools (, )
query.proto:15Get existing liquidity pools.
message
query.proto:404the request type for the QueryLiquidityPools RPC method. Requestable including pagination offset, limit, key.
optional pagination = 1
pagination defines an optional pagination for the request.
message
query.proto:410the response type for the QueryLiquidityPoolsResponse RPC method. This includes a list of all existing liquidity pools and paging results that contain next_key and total count.
repeated pools = 1
optional pagination = 2
pagination defines the pagination in the response. not working on this version.
rpc LiquidityPool (, )
query.proto:37Get specific liquidity pool.
message
query.proto:373the request type for the QueryLiquidityPool RPC method. requestable specified pool_id.
uint64 pool_id = 1
Get specific liquidity pool corresponding to the pool_coin_denom.
message
query.proto:383the request type for the QueryLiquidityByPoolCoinDenomPool RPC method. Requestable specified pool_coin_denom.
string pool_coin_denom = 1
Get specific liquidity pool corresponding to the reserve account.
message
query.proto:388the request type for the QueryLiquidityByReserveAcc RPC method. Requestable specified reserve_acc.
string reserve_acc = 1
rpc LiquidityPoolBatch (, )
query.proto:134Get the pool's current batch.
message
query.proto:393the request type for the QueryLiquidityPoolBatch RPC method. requestable including specified pool_id.
uint64 pool_id = 1
id of the target pool for query
message
query.proto:399the response type for the QueryLiquidityPoolBatchResponse RPC method. Returns the liquidity pool batch that corresponds to the requested pool_id.
optional batch = 1
rpc PoolBatchSwapMsgs (, )
query.proto:166Get all swap messages in the pool's current batch.
message
query.proto:426the request type for the QueryPoolBatchSwapMsgs RPC method. Requestable including specified pool_id and pagination offset, limit, key.
uint64 pool_id = 1
id of the target pool for query
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:442the response type for the QueryPoolBatchSwapMsgs RPC method. This includes list of all currently existing swap messages of the batch and paging results that contain next_key and total count.
repeated swaps = 1
optional pagination = 2
pagination defines the pagination in the response. not working on this version.
rpc PoolBatchSwapMsg (, )
query.proto:198Get a specific swap message in the pool's current batch.
message
query.proto:434the request type for the QueryPoolBatchSwap RPC method. Requestable including specified pool_id and msg_index.
uint64 pool_id = 1
id of the target pool for query
uint64 msg_index = 2
target msg_index of the pool
message
query.proto:449the response type for the QueryPoolBatchSwapMsg RPC method. This includes a batch swap message of the batch.
optional swap = 1
rpc PoolBatchDepositMsgs (, )
query.proto:230Get all deposit messages in the pool's current batch.
message
query.proto:454the request type for the QueryPoolBatchDeposit RPC method. Requestable including specified pool_id and pagination offset, limit, key.
uint64 pool_id = 1
id of the target pool for query
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:470the response type for the QueryPoolBatchDeposit RPC method. This includes a list of all currently existing deposit messages of the batch and paging results that contain next_key and total count.
repeated deposits = 1
optional pagination = 2
pagination defines the pagination in the response. not working on this version.
rpc PoolBatchDepositMsg (, )
query.proto:263Get a specific deposit message in the pool's current batch.
message
query.proto:462the request type for the QueryPoolBatchDeposit RPC method. requestable including specified pool_id and msg_index.
uint64 pool_id = 1
id of the target pool for query
uint64 msg_index = 2
target msg_index of the pool
message
query.proto:477the response type for the QueryPoolBatchDepositMsg RPC method. This includes a batch swap message of the batch.
optional deposit = 1
rpc PoolBatchWithdrawMsgs (, )
query.proto:295Get all withdraw messages in the pool's current batch.
message
query.proto:483the request type for the QueryPoolBatchWithdraw RPC method. Requestable including specified pool_id and pagination offset, limit, key.
uint64 pool_id = 1
id of the target pool for query
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:499the response type for the QueryPoolBatchWithdraw RPC method. This includes a list of all currently existing withdraw messages of the batch and paging results that contain next_key and total count.
repeated withdraws = 1
optional pagination = 2
pagination defines the pagination in the response. Not supported on this version.
rpc PoolBatchWithdrawMsg (, )
query.proto:328Get a specific withdraw message in the pool's current batch.
message
query.proto:491the request type for the QueryPoolBatchWithdraw RPC method. requestable including specified pool_id and msg_index.
uint64 pool_id = 1
id of the target pool for query
uint64 msg_index = 2
target msg_index of the pool
message
query.proto:506the response type for the QueryPoolBatchWithdrawMsg RPC method. This includes a batch swap message of the batch.
optional withdraw = 1
rpc Params (, )
query.proto:360Get all parameters of the liquidity module.
message
query.proto:417QueryParamsRequest is request type for the QueryParams RPC method.
(message has no fields)
message
query.proto:420the response type for the QueryParamsResponse RPC method. This includes current parameter of the liquidity module.
optional params = 1
params holds all the parameters of this module.
message
liquidity.proto:275DepositMsgState defines the state of deposit message that contains state information as it is processed in the next batch or batches.
Used in: , ,
int64 msg_height = 1
height where this message is appended to the batch
uint64 msg_index = 2
index of this deposit message in this liquidity pool
bool executed = 3
true if executed on this batch, false if not executed
bool succeeded = 4
true if executed successfully on this batch, false if failed
bool to_be_deleted = 5
true if ready to be deleted on kvstore, false if not ready to be deleted
optional msg = 6
MsgDepositWithinBatch
message
genesis.proto:20GenesisState defines the liquidity module's genesis state.
optional params = 1
params defines all the parameters for the liquidity module.
repeated pool_records = 2
message
tx.proto:68`MsgDepositWithinBatch defines` an `sdk.Msg` type that supports submitting a deposit request to the batch of the liquidity pool. Deposit is submitted to the batch of the Liquidity pool with the specified `pool_id`, `deposit_coins` for reserve. This request is stacked in the batch of the liquidity pool, is not processed immediately, and is processed in the `endblock` at the same time as other requests. See: https://github.com/tendermint/liquidity/blob/develop/x/liquidity/spec/04_messages.md
Used as request type in: Msg.DepositWithinBatch
Used as field type in:
string depositor_address = 1
uint64 pool_id = 2
id of the target pool
repeated deposit_coins = 3
reserve coin pair of the pool to deposit
message
tx.proto:148`MsgSwapWithinBatch` defines an sdk.Msg type that supports submitting a swap offer request to the batch of the liquidity pool. Submit swap offer to the liquidity pool batch with the specified the `pool_id`, `swap_type_id`, `demand_coin_denom` with the coin and the price you're offering and `offer_coin_fee` must be half of offer coin amount * current `params.swap_fee_rate` and ceil for reservation to pay fees. This request is stacked in the batch of the liquidity pool, is not processed immediately, and is processed in the `endblock` at the same time as other requests. You must request the same fields as the pool. Only the default `swap_type_id` 1 is supported. See: https://github.com/tendermint/liquidity/tree/develop/doc https://github.com/tendermint/liquidity/blob/develop/x/liquidity/spec/04_messages.md
Used as request type in: Msg.Swap
Used as field type in:
string swap_requester_address = 1
address of swap requester
uint64 pool_id = 2
id of swap type, must match the value in the pool. Only `swap_type_id` 1 is supported.
uint32 swap_type_id = 3
id of swap type. Must match the value in the pool.
optional offer_coin = 4
offer sdk.coin for the swap request, must match the denom in the pool.
string demand_coin_denom = 5
denom of demand coin to be exchanged on the swap request, must match the denom in the pool.
optional offer_coin_fee = 6
half of offer coin amount * params.swap_fee_rate and ceil for reservation to pay fees.
string order_price = 7
limit order price for the order, the price is the exchange ratio of X/Y where X is the amount of the first coin and Y is the amount of the second coin when their denoms are sorted alphabetically.
message
tx.proto:109`MsgWithdrawWithinBatch` defines an `sdk.Msg` type that supports submitting a withdraw request to the batch of the liquidity pool. Withdraw is submitted to the batch from the Liquidity pool with the specified `pool_id`, `pool_coin` of the pool. This request is stacked in the batch of the liquidity pool, is not processed immediately, and is processed in the `endblock` at the same time as other requests. See: https://github.com/tendermint/liquidity/blob/develop/x/liquidity/spec/04_messages.md
Used as request type in: Msg.WithdrawWithinBatch
Used as field type in:
string withdrawer_address = 1
uint64 pool_id = 2
id of the target pool
optional pool_coin = 3
message
liquidity.proto:50Params defines the parameters for the liquidity module.
Used in: ,
repeated pool_types = 1
list of available pool types
string min_init_deposit_amount = 2
Minimum number of coins to be deposited to the liquidity pool on pool creation.
string init_pool_coin_mint_amount = 3
Initial mint amount of pool coins upon pool creation.
string max_reserve_coin_amount = 4
Limit the size of each liquidity pool to minimize risk. In development, set to 0 for no limit. In production, set a limit.
repeated pool_creation_fee = 5
Fee paid to create a Liquidity Pool. Set a fee to prevent spamming.
string swap_fee_rate = 6
Swap fee rate for every executed swap.
string withdraw_fee_rate = 7
Reserve coin withdrawal with less proportion by withdrawFeeRate.
string max_order_amount_ratio = 8
Maximum ratio of reserve coins that can be ordered at a swap order.
uint32 unit_batch_height = 9
The smallest unit batch height for every liquidity pool.
bool circuit_breaker_enabled = 10
Circuit breaker enables or disables transaction messages in liquidity module.
message
liquidity.proto:149Pool defines the liquidity pool that contains pool information.
Used in: , ,
uint64 id = 1
id of the pool
uint32 type_id = 2
id of the pool_type
repeated string reserve_coin_denoms = 3
denoms of reserve coin pair of the pool
string reserve_account_address = 4
reserve account address of the pool
string pool_coin_denom = 5
denom of pool coin of the pool
message
liquidity.proto:221PoolBatch defines the batch or batches of a given liquidity pool that contains indexes of deposit, withdraw, and swap messages. Index param increments by 1 if the pool id is same.
Used in: ,
uint64 pool_id = 1
id of the pool
uint64 index = 2
index of this batch
int64 begin_height = 3
height where this batch is started
uint64 deposit_msg_index = 4
last index of DepositMsgStates
uint64 withdraw_msg_index = 5
last index of WithdrawMsgStates
uint64 swap_msg_index = 6
last index of SwapMsgStates
bool executed = 7
true if executed, false if not executed
message
liquidity.proto:188Metadata for the state of each pool for invariant checking after genesis export or import.
Used in:
uint64 pool_id = 1
id of the pool
optional pool_coin_total_supply = 2
pool coin issued at the pool
repeated reserve_coins = 3
reserve coins deposited in the pool
message
genesis.proto:10records the state of each pool after genesis export or import, used to check variables
Used in:
optional pool = 1
optional pool_metadata = 2
optional pool_batch = 3
repeated deposit_msg_states = 4
repeated withdraw_msg_states = 5
repeated swap_msg_states = 6
message
liquidity.proto:13Structure for the pool type to distinguish the characteristics of the reserve pools.
Used in:
uint32 id = 1
This is the id of the pool_type that is used as pool_type_id for pool creation. In this version, only pool-type-id 1 is supported. {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""}
string name = 2
name of the pool type.
uint32 min_reserve_coin_num = 3
minimum number of reserveCoins for LiquidityPoolType, only 2 reserve coins are supported.
uint32 max_reserve_coin_num = 4
maximum number of reserveCoins for LiquidityPoolType, only 2 reserve coins are supported.
string description = 5
description of the pool type.
message
query.proto:378the response type for the QueryLiquidityPoolResponse RPC method. Returns the liquidity pool that corresponds to the requested pool_id.
Used as response type in: Query.LiquidityPool, Query.LiquidityPoolByPoolCoinDenom, Query.LiquidityPoolByReserveAcc
optional pool = 1
message
liquidity.proto:353SwapMsgState defines the state of the swap message that contains state information as the message is processed in the next batch or batches.
Used in: , ,
int64 msg_height = 1
height where this message is appended to the batch
uint64 msg_index = 2
index of this swap message in this liquidity pool
bool executed = 3
true if executed on this batch, false if not executed
bool succeeded = 4
true if executed successfully on this batch, false if failed
bool to_be_deleted = 5
true if ready to be deleted on kvstore, false if not ready to be deleted
int64 order_expiry_height = 6
swap orders are cancelled when current height is equal to or higher than ExpiryHeight
optional exchanged_offer_coin = 7
offer coin exchanged until now
optional remaining_offer_coin = 8
offer coin currently remaining to be exchanged
optional reserved_offer_coin_fee = 9
reserve fee for pays fee in half offer coin
optional msg = 10
MsgSwapWithinBatch
message
liquidity.proto:314WithdrawMsgState defines the state of the withdraw message that contains state information as the message is processed in the next batch or batches.
Used in: , ,
int64 msg_height = 1
height where this message is appended to the batch
uint64 msg_index = 2
index of this withdraw message in this liquidity pool
bool executed = 3
true if executed on this batch, false if not executed
bool succeeded = 4
true if executed successfully on this batch, false if failed
bool to_be_deleted = 5
true if ready to be deleted on kvstore, false if not ready to be deleted
optional msg = 6
MsgWithdrawWithinBatch