diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml index f13c6bb6d..041212c15 100644 --- a/client/docs/swagger-ui/swagger.yaml +++ b/client/docs/swagger-ui/swagger.yaml @@ -7,7 +7,7 @@ paths: /tendermint/liquidity/v1beta1/params: get: summary: Get all parameters of the liquidity module. - description: It returns all parameters of the liquidity module. + description: Returns all parameters of the liquidity module. operationId: LiquidityQueries responses: '200': @@ -16,7 +16,7 @@ paths: type: object properties: params: - description: params holds all the parameters of this module. + description: Params holds all the parameters of this module. type: object properties: pool_types: @@ -32,7 +32,7 @@ paths: The id of the pool_type to use as pool_type_id for pool creation. - Only pool-type-id 1 is supported + Only pool-type-id 1 is supported. {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""} name: @@ -44,15 +44,15 @@ paths: format: uint32 example: '2' title: >- - min number of reserveCoins for LiquidityPoolType - only 2 is allowed on this spec + minimum number of reserveCoins for LiquidityPoolType + only 2 coins are allowed on this spec max_reserve_coin_num: type: integer format: uint32 example: '2' title: >- - max number of reserveCoins for LiquidityPoolType - only 2 is allowed on this spec + maximum number of reserveCoins for LiquidityPoolType + only 2 coins are allowed on this spec description: type: string title: description of the pool type @@ -66,12 +66,12 @@ paths: example: '1000000' title: >- Minimum number of coins to be deposited to the liquidity - pool upon pool creation + pool on pool creation init_pool_coin_mint_amount: type: string format: sdk.Int example: '1000000' - title: Initial mint amount of pool coin upon pool creation + title: Initial mint amount of pool coin on pool creation max_reserve_coin_amount: type: string format: sdk.Int @@ -79,7 +79,7 @@ paths: title: >- Limit the size of each liquidity pool in the beginning phase of Liquidity Module adoption to minimize risk, 0 - means no limit + means no limit to the maximum reserve coin amount pool_creation_fee: type: array format: sdk.Coins @@ -97,11 +97,9 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the - custom method - - signatures required by gogoproto. - description: Fee to create a Liquidity Pool. + NOTE: The amount field is an Int that implements the + custom method signatures required by gogoproto. + description: Fee to create a Liquidity Pool swap_fee_rate: type: string format: sdk.Dec @@ -125,10 +123,9 @@ paths: type: integer format: uint32 example: '1' - title: The smallest unit batch height for every liquidity pool + title: The smallest unit batch height for each liquidity pool description: >- - the response type for the QueryParamsResponse RPC method. This - includes current parameter of the liquidity module. + The response type for the QueryParamsResponse RPC method. This response includes current parameter of the liquidity module. default: description: An unexpected error response. schema: @@ -160,7 +157,7 @@ paths: /tendermint/liquidity/v1beta1/pools: get: summary: Get existing liquidity pools. - description: It returns list of all liquidity pools with pagination result. + description: Returns a list of all liquidity pools with pagination result. operationId: LiquidityPools responses: '200': @@ -200,11 +197,11 @@ paths: type: string example: >- poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 - title: denom of pool coin of the pool + title: denom of pool coins in the pool title: The liquidity pool information pagination: description: >- - pagination defines the pagination in the response. not working + Pagination defines the pagination in the response. Not working on this version. type: object properties: @@ -219,13 +216,11 @@ paths: format: uint64 title: >- total is total number of results available if - PageRequest.count_total - - was set, its value is undefined otherwise + PageRequest.count_total was set, its value is undefined otherwise description: >- - the response type for the QueryLiquidityPoolsResponse RPC method. - This includes list of all liquidity pools currently existed and - paging results containing next_key and total count. + The response type for the QueryLiquidityPoolsResponse RPC method. + This response includes a list of all existing liquidity pools and + paging results that contain the next_key and total count. '500': description: Internal Server Error schema: {} @@ -261,44 +256,38 @@ paths: parameters: - name: pagination.key description: |- - key is a value returned in PageResponse.next_key to begin - querying the next page most efficiently. Only one of offset or key - should be set. + Key is a value that is returned in PageResponse.next_key to begin + querying the next page most efficiently. Set either offset or key. in: query required: false type: string format: byte - name: pagination.offset description: >- - offset is a numeric offset that can be used when key is unavailable. - - It is less efficient than using key. Only one of offset or key - should - - be set. + Set either offset or key. When key is unavailable, use offset. Offset is less efficient than using key. in: query required: false type: string format: uint64 - name: pagination.limit description: >- - limit is the total number of results to be returned in the result + Limit is the total number of results to be returned in the result page. - If left empty it will default to a value to be set by each app. + If left empty, the default is a value that is set by each app. in: query required: false type: string format: uint64 - name: pagination.count_total description: >- - count_total is set to true to indicate that the result set should + count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in UIs. - count_total is only respected when offset is used. It is ignored + count_total is respected only when offset is used and is ignored when key is set. @@ -313,7 +302,7 @@ paths: '/tendermint/liquidity/v1beta1/pools/{pool_id}': get: summary: Get specific liquidity pool. - description: It returns the liquidity pool corresponding to the pool_id. + description: Returns the liquidity pool that corresponds to the pool_id. operationId: LiquidityPool responses: '200': @@ -354,8 +343,8 @@ paths: title: denom of pool coin of the pool title: The liquidity pool information description: >- - the response type for the QueryLiquidityPoolResponse RPC method. - It returns the liquidity pool corresponding to the requested + The response type for the QueryLiquidityPoolResponse RPC method. + Returns the liquidity pool that corresponds to the requested pool_id. '400': description: Bad Request @@ -413,7 +402,7 @@ paths: '/tendermint/liquidity/v1beta1/pools/{pool_id}/batch': get: summary: Get the pool's current batch. - description: It returns the current batch of the pool corresponding to the pool_id. + description: Returns the current batch of the pool that corresponds to the pool_id. operationId: LiquidityPoolBatch responses: '200': @@ -438,7 +427,7 @@ paths: type: string format: int64 example: '1000' - title: height where this batch is begun + title: block height when this batch began deposit_msg_index: type: string format: uint64 @@ -464,7 +453,7 @@ paths: param increments by 1 if the pool id exists. description: >- the response type for the QueryLiquidityPoolBatchResponse RPC - method. It returns the liquidity pool batch corresponding to the + method. Returns the liquidity pool batch that corresponds to the requested pool_id. '400': description: Bad Request @@ -524,7 +513,7 @@ paths: get: summary: Get all deposit messages in the pool's current batch. description: >- - It returns list of all deposit messages in the current batch of the pool + Returns a list of all deposit messages in the current batch of the pool with pagination result. operationId: PoolBatchDepositMsgs responses: @@ -542,7 +531,7 @@ paths: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -600,7 +589,7 @@ paths: amount. - NOTE: The amount field is an Int which implements + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -608,13 +597,13 @@ paths: description: >- `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports submitting a deposit requests to the liquidity - pool batch + pool batch. The deposit is submitted with the specified `pool_id` - and reserve `deposit_coins` + and reserve `deposit_coins`. The deposit requests are stacked in the liquidity pool - batch and are not immediately processed + batch and are not immediately processed. Batch deposit requests are processed in the `endblock` at the same time as other requests. @@ -628,8 +617,7 @@ paths: the next batch or batches pagination: description: >- - pagination defines the pagination in the response. not working - on this version. + pagination defines the pagination in the response. Not supported in this version. type: object properties: next_key: @@ -649,7 +637,7 @@ paths: description: >- the response type for the QueryPoolBatchDeposit RPC method. This includes a list of all currently existing deposit messages of the - batch and paging results containing next_key and total count. + batch and paging results that contains next_key and total count. '400': description: Bad Request schema: {} @@ -702,8 +690,7 @@ paths: - name: pagination.key description: |- key is a value returned in PageResponse.next_key to begin - querying the next page most efficiently. Only one of offset or key - should be set. + querying the next page most efficiently. Set only one of offset or key. in: query required: false type: string @@ -712,10 +699,7 @@ paths: description: >- offset is a numeric offset that can be used when key is unavailable. - It is less efficient than using key. Only one of offset or key - should - - be set. + Offset is less efficient than using key. Set only one of offset or key. in: query required: false type: string @@ -738,7 +722,7 @@ paths: a count of the total number of items available for pagination in UIs. - count_total is only respected when offset is used. It is ignored + count_total is respected only when offset is used. count_total is ignored when key is set. @@ -754,7 +738,7 @@ paths: get: summary: Get specific deposit message in the pool's current batch. description: >- - It returns the deposit message corresponding to the msg_index in the + Returns the deposit message that corresponds to the msg_index in the pool's current batch. operationId: PoolBatchDepositMsg responses: @@ -770,7 +754,7 @@ paths: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -826,7 +810,7 @@ paths: amount. - NOTE: The amount field is an Int which implements + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -834,13 +818,13 @@ paths: description: >- `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports submitting a deposit requests to the liquidity - pool batch + pool batch. The deposit is submitted with the specified `pool_id` and - reserve `deposit_coins` + reserve `deposit_coins`. The deposit requests are stacked in the liquidity pool - batch and are not immediately processed + batch and are not immediately processed. Batch deposit requests are processed in the `endblock` at the same time as other requests. @@ -849,12 +833,10 @@ paths: See: https://github.com/tendermint/liquidity/blob/develop/x/liquidity/spec/04_messages.md title: >- - DepositMsgState defines the state of the deposit message that - contains the state information as it is processed in the next - batch or batches + DepositMsgState defines the state of the deposit message as it is processed in the next batch or batches title: >- the response type for the QueryPoolBatchDepositMsg RPC method. - This includes a batch swap message of the batch + This response includes a batch swap message of the batch '400': description: Bad Request schema: {} @@ -920,7 +902,7 @@ paths: get: summary: Get all swap messages in the pool's current batch. description: >- - It returns list of all swap messages in the current batch of the pool + Returns a list of all swap messages in the current batch of the pool with pagination result. operationId: PoolBatchSwapMsgs responses: @@ -938,7 +920,7 @@ paths: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -967,8 +949,7 @@ paths: format: int64 example: '1000' title: >- - swap orders are cancelled when current height is equal - or higher than ExpiryHeight + swap orders are cancelled when current block height is equal to or higher than ExpiryHeight exchanged_offer_coin: type: object properties: @@ -980,7 +961,7 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1000,7 +981,7 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1020,7 +1001,7 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1061,7 +1042,7 @@ paths: amount. - NOTE: The amount field is an Int which implements + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1087,7 +1068,7 @@ paths: amount. - NOTE: The amount field is an Int which implements + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1111,25 +1092,25 @@ paths: are sorted alphabetically description: >- `MsgSwapWithinBatch` defines an sdk.Msg type that - submits a swap offer request to the liquidity pool batch + submits a swap offer request to the liquidity pool batch. 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 + offering. The `offer_coin_fee` must be half of the offer coin amount * current `params.swap_fee_rate` for reservation - to pay fees + to pay fees. This request is added to the pool and executed at the - end of the batch (`endblock`) + end of the batch (`endblock`). You must submit the request using the same fields as the - pool + pool. - Only the default `swap_type_id`1 is supported + Only the default `swap_type_id`1 is supported. The detailed swap algorithm is shown here. @@ -1165,7 +1146,7 @@ paths: description: >- the response type for the QueryPoolBatchSwapMsgs RPC method. This includes list of all currently existing swap messages of the batch - and paging results containing next_key and total count. + and paging results that contains next_key and total count. '400': description: Bad Request schema: {} @@ -1248,7 +1229,7 @@ paths: format: uint64 - name: pagination.count_total description: >- - count_total is set to true to indicate that the result set should + count_total is set to true to indicate that the result set should include a count of the total number of items available for pagination in @@ -1270,8 +1251,8 @@ paths: get: summary: Get specific swap message in the pool's current batch. description: >- - It returns the swap message corresponding to the msg_index in the pool's - current batch + Returns the swap message that corresponds to the msg_index in the pool's + current batch. operationId: PoolBatchSwapMsg responses: '200': @@ -1286,7 +1267,7 @@ paths: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -1313,8 +1294,7 @@ paths: format: int64 example: '1000' title: >- - swap orders are cancelled when current height is equal or - higher than ExpiryHeight + swap orders are cancelled when current block height is equal to or higher than ExpiryHeight exchanged_offer_coin: type: object properties: @@ -1326,7 +1306,7 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1346,7 +1326,7 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1366,7 +1346,7 @@ paths: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1407,7 +1387,7 @@ paths: amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1433,7 +1413,7 @@ paths: amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1457,25 +1437,25 @@ paths: are sorted alphabetically description: >- `MsgSwapWithinBatch` defines an sdk.Msg type that submits - a swap offer request to the liquidity pool batch + a swap offer request to the liquidity pool batch. 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 + offering. The `offer_coin_fee` must be half of the offer coin amount * current `params.swap_fee_rate` for reservation to pay - fees + fees. This request is added to the pool and executed at the end of the batch (`endblock`) You must submit the request using the same fields as the - pool + pool. - Only the default `swap_type_id`1 is supported + Only the default `swap_type_id`1 is supported. The detailed swap algorithm is shown here. @@ -1556,7 +1536,7 @@ paths: get: summary: Get all withdraw messages in the pool's current batch. description: >- - It returns list of all withdraw messages in the current batch of the + Returns a list of all withdraw messages in the current batch of the pool with pagination result. operationId: PoolBatchWithdrawMsgs responses: @@ -1574,7 +1554,7 @@ paths: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -1624,7 +1604,7 @@ paths: amount. - NOTE: The amount field is an Int which implements + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1635,15 +1615,13 @@ paths: amount: '1000' description: >- `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that - submits a withdraw request to the liquidity pool batch + submits a withdraw request to the liquidity pool batch. Withdraw submit to the batch from the Liquidity pool - with the specified `pool_id`, `pool_coin` of the pool + with the specified `pool_id`, `pool_coin` of the pool. - this requests are stacked in the batch of the liquidity - pool, not immediately processed and - - processed in the `endblock` at once with other requests. + This request is stacked in the batch of the liquidity + pool and is not immediately processed. Batch withdraw requests are processed in the `endblock` at the same time as other requests. See: @@ -1675,7 +1653,7 @@ paths: description: >- the response type for the QueryPoolBatchWithdraw RPC method. This includes a list of all currently existing withdraw messages of the - batch and paging results containing next_key and total count. + batch and paging results that contains next_key and total count. '400': description: Bad Request schema: {} @@ -1780,7 +1758,7 @@ paths: get: summary: Get specific withdraw message in the pool's current batch. description: >- - It returns the withdraw message corresponding to the msg_index in the + Returns the withdraw message that corresponds to the msg_index in the pool's current batch. operationId: PoolBatchWithdrawMsg responses: @@ -1796,7 +1774,7 @@ paths: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -1844,7 +1822,7 @@ paths: amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -1855,15 +1833,13 @@ paths: amount: '1000' description: >- `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that - submits a withdraw request to the liquidity pool batch + submits a withdraw request to the liquidity pool batch. Withdraw submit to the batch from the Liquidity pool with - the specified `pool_id`, `pool_coin` of the pool - - this requests are stacked in the batch of the liquidity - pool, not immediately processed and + the specified `pool_id`, `pool_coin` of the pool. - processed in the `endblock` at once with other requests. + This request is stacked in the batch of the liquidity + pool and is not immediately processed. Batch withdraw requests are processed in the `endblock` at the same time as other requests. See: @@ -1874,7 +1850,7 @@ paths: batch or batches title: >- the response type for the QueryPoolBatchWithdrawMsg RPC method. - This includes a batch swap message of the batch + This response includes a batch swap message of the batch '400': description: Bad Request schema: {} @@ -2015,7 +1991,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. google.protobuf.Any: type: object @@ -2052,7 +2028,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -2105,20 +2081,20 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. title: reserve coin pair of the pool to deposit description: >- `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports - submitting a deposit requests to the liquidity pool batch + submitting a deposit request to the liquidity pool batch. The deposit is submitted with the specified `pool_id` and reserve - `deposit_coins` + `deposit_coins`. The deposit requests are stacked in the liquidity pool batch and are - not immediately processed + not immediately processed. Batch deposit requests are processed in the `endblock` at the same time as other requests. @@ -2160,18 +2136,18 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. title: reserve coin pair of the pool to deposit description: >- `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports submitting - a deposit requests to the liquidity pool batch + a deposit request to the liquidity pool batch. The deposit is submitted with the specified `pool_id` and reserve - `deposit_coins` + `deposit_coins`. The deposit requests are stacked in the liquidity pool batch and are not - immediately processed + immediately processed. Batch deposit requests are processed in the `endblock` at the same time as other requests. @@ -2208,7 +2184,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. format: sdk.Coin example: @@ -2230,7 +2206,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. format: sdk.Coin example: @@ -2266,7 +2242,7 @@ definitions: You must submit the request using the same fields as the pool - Only the default `swap_type_id`1 is supported + Only the default `swap_type_id` 1 is supported The detailed swap algorithm is shown here. @@ -2297,7 +2273,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. format: sdk.Coin example: @@ -2305,15 +2281,15 @@ definitions: amount: '1000' description: >- `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that submits a withdraw - request to the liquidity pool batch + request to the liquidity pool batch. Withdraw submit to the batch from the Liquidity pool with the specified - `pool_id`, `pool_coin` of the pool + `pool_id`, `pool_coin` of the pool. - this requests are stacked in the batch of the liquidity pool, not - immediately processed and + Requests are stacked in the batch of the liquidity pool, they are not + immediately processed. - processed in the `endblock` at once with other requests. + Requests are processed in the `endblock` at the same time as other requests. See: @@ -2332,7 +2308,7 @@ definitions: example: '1' title: >- The id of the pool_type to use as pool_type_id for pool - creation. + creation Only pool-type-id 1 is supported @@ -2397,7 +2373,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. description: Fee to create a Liquidity Pool. swap_fee_rate: @@ -2469,7 +2445,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this batch is begun + title: block height when this batch began deposit_msg_index: type: string format: uint64 @@ -2550,7 +2526,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this batch is begun + title: block height when this batch began deposit_msg_index: type: string format: uint64 @@ -2576,7 +2552,7 @@ definitions: increments by 1 if the pool id exists. description: >- the response type for the QueryLiquidityPoolBatchResponse RPC method. It - returns the liquidity pool batch corresponding to the requested pool_id. + returns the liquidity pool batch that corresponds to the requested pool_id. tendermint.liquidity.v1beta1.QueryLiquidityPoolResponse: type: object properties: @@ -2614,7 +2590,7 @@ definitions: title: The liquidity pool information description: >- the response type for the QueryLiquidityPoolResponse RPC method. It - returns the liquidity pool corresponding to the requested pool_id. + returns the liquidity pool that corresponds to the requested pool_id. tendermint.liquidity.v1beta1.QueryLiquidityPoolsResponse: type: object properties: @@ -2675,7 +2651,7 @@ definitions: description: >- the response type for the QueryLiquidityPoolsResponse RPC method. This includes list of all liquidity pools currently existed and paging results - containing next_key and total count. + that contains next_key and total count. tendermint.liquidity.v1beta1.QueryParamsResponse: type: object properties: @@ -2760,7 +2736,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -2786,8 +2762,7 @@ definitions: example: '1' title: The smallest unit batch height for every liquidity pool description: >- - the response type for the QueryParamsResponse RPC method. This includes - current parameter of the liquidity module. + The response type for the QueryParamsResponse RPC method. This response includes the current parameter of the liquidity module. tendermint.liquidity.v1beta1.QueryPoolBatchDepositMsgResponse: type: object properties: @@ -2798,7 +2773,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -2851,20 +2826,20 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. title: reserve coin pair of the pool to deposit description: >- `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports - submitting a deposit requests to the liquidity pool batch + submitting a deposit request to the liquidity pool batch. The deposit is submitted with the specified `pool_id` and reserve - `deposit_coins` + `deposit_coins`. The deposit requests are stacked in the liquidity pool batch and - are not immediately processed + are not immediately processed. Batch deposit requests are processed in the `endblock` at the same time as other requests. @@ -2890,7 +2865,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -2943,20 +2918,20 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. title: reserve coin pair of the pool to deposit description: >- `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports - submitting a deposit requests to the liquidity pool batch + submitting a deposit request to the liquidity pool batch. The deposit is submitted with the specified `pool_id` and - reserve `deposit_coins` + reserve `deposit_coins`. The deposit requests are stacked in the liquidity pool batch and - are not immediately processed + are not immediately processed. Batch deposit requests are processed in the `endblock` at the same time as other requests. @@ -2989,9 +2964,9 @@ definitions: was set, its value is undefined otherwise description: >- - the response type for the QueryPoolBatchDeposit RPC method. This includes - a list of all currently existing deposit messages of the batch and paging - results containing next_key and total count. + the response type for the QueryPoolBatchDeposit RPC method. This response includes + a list of all existing deposit messages of the batch and paging + results that contain next_key and total count. tendermint.liquidity.v1beta1.QueryPoolBatchSwapMsgResponse: type: object properties: @@ -3002,7 +2977,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -3027,7 +3002,7 @@ definitions: format: int64 example: '1000' title: >- - swap orders are cancelled when current height is equal or higher + swap orders are cancelled when current height is equal to or higher than ExpiryHeight exchanged_offer_coin: type: object @@ -3040,7 +3015,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3060,7 +3035,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3080,7 +3055,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3120,7 +3095,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3145,7 +3120,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3195,7 +3170,7 @@ definitions: SwapMsgState defines the state of swap message that contains state information as it is processed in the next batch or batches title: >- - the response type for the QueryPoolBatchSwapMsg RPC method. This includes + the response type for the QueryPoolBatchSwapMsg RPC method. This response includes a batch swap message of the batch tendermint.liquidity.v1beta1.QueryPoolBatchSwapMsgsResponse: type: object @@ -3209,7 +3184,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -3234,7 +3209,7 @@ definitions: format: int64 example: '1000' title: >- - swap orders are cancelled when current height is equal or higher + swap orders are cancelled when current height is equal to or higher than ExpiryHeight exchanged_offer_coin: type: object @@ -3247,7 +3222,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3267,7 +3242,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3287,7 +3262,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3327,7 +3302,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3352,7 +3327,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3422,9 +3397,9 @@ definitions: was set, its value is undefined otherwise description: >- - the response type for the QueryPoolBatchSwapMsgs RPC method. This includes - list of all currently existing swap messages of the batch and paging - results containing next_key and total count. + the response type for the QueryPoolBatchSwapMsgs RPC method. This response includes a + list of all existing swap messages of the batch and paging + results that contain next_key and total count. tendermint.liquidity.v1beta1.QueryPoolBatchWithdrawMsgResponse: type: object properties: @@ -3435,7 +3410,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -3480,7 +3455,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3491,15 +3466,13 @@ definitions: amount: '1000' description: >- `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that submits a - withdraw request to the liquidity pool batch + withdraw request to the liquidity pool batch. Withdraw submit to the batch from the Liquidity pool with the - specified `pool_id`, `pool_coin` of the pool - - this requests are stacked in the batch of the liquidity pool, not - immediately processed and + specified `pool_id`, `pool_coin` of the pool. - processed in the `endblock` at once with other requests. + The requests are stacked in the liquidity pool batch and are + not immediately processed. Withdraw requests are processed in the `endblock` at the same time as other requests. See: @@ -3523,7 +3496,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -3568,7 +3541,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3579,15 +3552,12 @@ definitions: amount: '1000' description: >- `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that submits - a withdraw request to the liquidity pool batch + a withdraw request to the liquidity pool batch. Withdraw submit to the batch from the Liquidity pool with the - specified `pool_id`, `pool_coin` of the pool + specified `pool_id`, `pool_coin` of the pool. - this requests are stacked in the batch of the liquidity pool, - not immediately processed and - - processed in the `endblock` at once with other requests. + This request is stacked in the batch of the liquidity pool and is not immediately processed. This request is processed in the `endblock` at the same time as other requests. See: @@ -3617,9 +3587,9 @@ definitions: was set, its value is undefined otherwise description: >- - the response type for the QueryPoolBatchWithdraw RPC method. This includes + the response type for the QueryPoolBatchWithdraw RPC method. This response includes a list of all currently existing withdraw messages of the batch and paging - results containing next_key and total count. + results that contains next_key and total count. tendermint.liquidity.v1beta1.SwapMsgState: type: object properties: @@ -3627,7 +3597,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -3652,7 +3622,7 @@ definitions: format: int64 example: '1000' title: >- - swap orders are cancelled when current height is equal or higher than + swap orders are cancelled when current height is equal to or higher than ExpiryHeight exchanged_offer_coin: type: object @@ -3664,7 +3634,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. format: sdk.Coin example: @@ -3681,7 +3651,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. format: sdk.Coin example: @@ -3698,7 +3668,7 @@ definitions: description: |- Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom method + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. format: sdk.Coin example: @@ -3736,7 +3706,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3761,7 +3731,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3817,7 +3787,7 @@ definitions: type: string format: int64 example: '1000' - title: height where this message is appended to the batch + title: block height when this message is appended to the batch msg_index: type: string format: uint64 @@ -3862,7 +3832,7 @@ definitions: Coin defines a token with a denomination and an amount. - NOTE: The amount field is an Int which implements the custom + NOTE: The amount field is an Int that implements the custom method signatures required by gogoproto. @@ -3873,15 +3843,13 @@ definitions: amount: '1000' description: >- `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that submits a - withdraw request to the liquidity pool batch + withdraw request to the liquidity pool batch. Withdraw submit to the batch from the Liquidity pool with the - specified `pool_id`, `pool_coin` of the pool - - this requests are stacked in the batch of the liquidity pool, not - immediately processed and + specified `pool_id`, `pool_coin` of the pool. - processed in the `endblock` at once with other requests. + This request is stacked in the batch of the liquidity pool and is not + immediately processed. The request is processed in the `endblock` at the same time as other requests. See: