github.com/gravity-devs/liquidity@v1.5.3/client/docs/swagger-ui/swagger.yaml (about) 1 swagger: '2.0' 2 info: 3 title: Cosmos SDK Liquidity Module - REST and gRPC Gateway docs 4 description: 'A REST interface for state queries, transactions' 5 version: 2.3.1 6 paths: 7 /cosmos/liquidity/v1beta1/params: 8 get: 9 summary: Get all parameters of the liquidity module. 10 description: Returns all parameters of the liquidity module. 11 operationId: LiquidityQueries 12 responses: 13 '200': 14 description: A successful response. 15 schema: 16 type: object 17 properties: 18 params: 19 description: params holds all the parameters of this module. 20 type: object 21 properties: 22 pool_types: 23 type: array 24 items: 25 type: object 26 properties: 27 id: 28 type: integer 29 format: uint32 30 example: '1' 31 title: >- 32 This is the id of the pool_type that is used as 33 pool_type_id for pool creation. 34 35 In this version, only pool-type-id 1 is supported. 36 37 {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""} 38 name: 39 type: string 40 example: ConstantProductLiquidityPool 41 description: name of the pool type. 42 min_reserve_coin_num: 43 type: integer 44 format: uint32 45 example: '2' 46 description: >- 47 minimum number of reserveCoins for 48 LiquidityPoolType, only 2 reserve coins are 49 supported. 50 max_reserve_coin_num: 51 type: integer 52 format: uint32 53 example: '2' 54 description: >- 55 maximum number of reserveCoins for 56 LiquidityPoolType, only 2 reserve coins are 57 supported. 58 description: 59 type: string 60 description: description of the pool type. 61 description: >- 62 Structure for the pool type to distinguish the 63 characteristics of the reserve pools. 64 title: list of available pool types 65 min_init_deposit_amount: 66 type: string 67 format: sdk.Int 68 example: '1000000' 69 description: >- 70 Minimum number of coins to be deposited to the liquidity 71 pool on pool creation. 72 init_pool_coin_mint_amount: 73 type: string 74 format: sdk.Int 75 example: '1000000' 76 description: Initial mint amount of pool coins upon pool creation. 77 max_reserve_coin_amount: 78 type: string 79 format: sdk.Int 80 example: '1000000000000' 81 description: >- 82 Limit the size of each liquidity pool to minimize risk. In 83 development, set to 0 for no limit. In production, set a 84 limit. 85 pool_creation_fee: 86 type: array 87 format: sdk.Coins 88 example: 89 - denom: uatom 90 amount: '100000000' 91 items: 92 type: object 93 properties: 94 denom: 95 type: string 96 amount: 97 type: string 98 description: >- 99 Coin defines a token with a denomination and an amount. 100 101 102 NOTE: The amount field is an Int which implements the 103 custom method 104 105 signatures required by gogoproto. 106 description: >- 107 Fee paid to create a Liquidity Pool. Set a fee to prevent 108 spamming. 109 swap_fee_rate: 110 type: string 111 format: sdk.Dec 112 example: '0.003' 113 description: Swap fee rate for every executed swap. 114 withdraw_fee_rate: 115 type: string 116 format: sdk.Dec 117 example: '0.003' 118 description: >- 119 Reserve coin withdrawal with less proportion by 120 withdrawFeeRate. 121 max_order_amount_ratio: 122 type: string 123 format: sdk.Dec 124 example: '0.003' 125 description: >- 126 Maximum ratio of reserve coins that can be ordered at a 127 swap order. 128 unit_batch_height: 129 type: integer 130 format: uint32 131 example: '1' 132 description: The smallest unit batch height for every liquidity pool. 133 circuit_breaker_enabled: 134 type: boolean 135 format: bool 136 example: 'false' 137 description: >- 138 Circuit breaker enables or disables transaction messages 139 in liquidity module. 140 description: >- 141 the response type for the QueryParamsResponse RPC method. This 142 includes current parameter of the liquidity module. 143 default: 144 description: An unexpected error response. 145 schema: 146 type: object 147 properties: 148 error: 149 type: string 150 code: 151 type: integer 152 format: int32 153 message: 154 type: string 155 details: 156 type: array 157 items: 158 type: object 159 properties: 160 type_url: 161 type: string 162 value: 163 type: string 164 format: byte 165 tags: 166 - Query 167 externalDocs: 168 description: Find out more about the params 169 url: >- 170 https://github.com/tendermint/liquidity/blob/develop/x/liquidity/spec/08_params.md 171 /cosmos/liquidity/v1beta1/pools: 172 get: 173 summary: Get existing liquidity pools. 174 description: Returns a list of all liquidity pools with pagination result. 175 operationId: LiquidityPools 176 responses: 177 '200': 178 description: A successful response. 179 schema: 180 type: object 181 properties: 182 pools: 183 type: array 184 items: 185 type: object 186 properties: 187 id: 188 type: string 189 format: uint64 190 example: '1' 191 title: id of the pool 192 type_id: 193 type: integer 194 format: uint32 195 example: '1' 196 title: id of the pool_type 197 reserve_coin_denoms: 198 type: array 199 example: 200 - denomX 201 - denomY 202 items: 203 type: string 204 title: denoms of reserve coin pair of the pool 205 reserve_account_address: 206 type: string 207 format: sdk.AccAddress 208 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 209 title: reserve account address of the pool 210 pool_coin_denom: 211 type: string 212 example: >- 213 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 214 title: denom of pool coin of the pool 215 description: >- 216 Pool defines the liquidity pool that contains pool 217 information. 218 pagination: 219 description: >- 220 pagination defines the pagination in the response. not working 221 on this version. 222 type: object 223 properties: 224 next_key: 225 type: string 226 format: byte 227 title: |- 228 next_key is the key to be passed to PageRequest.key to 229 query the next page most efficiently 230 total: 231 type: string 232 format: uint64 233 title: >- 234 total is total number of results available if 235 PageRequest.count_total 236 237 was set, its value is undefined otherwise 238 description: >- 239 the response type for the QueryLiquidityPoolsResponse RPC method. 240 This includes a list of all existing liquidity pools and paging 241 results that contain next_key and total count. 242 '500': 243 description: Internal Server Error 244 schema: {} 245 examples: 246 application/json: 247 code: 2 248 message: >- 249 rpc error: code = NotFound desc = There are no pools present.: 250 key not found 251 details: [] 252 default: 253 description: An unexpected error response. 254 schema: 255 type: object 256 properties: 257 error: 258 type: string 259 code: 260 type: integer 261 format: int32 262 message: 263 type: string 264 details: 265 type: array 266 items: 267 type: object 268 properties: 269 type_url: 270 type: string 271 value: 272 type: string 273 format: byte 274 parameters: 275 - name: pagination.key 276 description: |- 277 key is a value returned in PageResponse.next_key to begin 278 querying the next page most efficiently. Only one of offset or key 279 should be set. 280 in: query 281 required: false 282 type: string 283 format: byte 284 - name: pagination.offset 285 description: >- 286 offset is a numeric offset that can be used when key is unavailable. 287 288 It is less efficient than using key. Only one of offset or key 289 should 290 291 be set. 292 in: query 293 required: false 294 type: string 295 format: uint64 296 - name: pagination.limit 297 description: >- 298 limit is the total number of results to be returned in the result 299 page. 300 301 If left empty it will default to a value to be set by each app. 302 in: query 303 required: false 304 type: string 305 format: uint64 306 - name: pagination.count_total 307 description: >- 308 count_total is set to true to indicate that the result set should 309 include 310 311 a count of the total number of items available for pagination in 312 UIs. 313 314 count_total is only respected when offset is used. It is ignored 315 when key 316 317 is set. 318 in: query 319 required: false 320 type: boolean 321 tags: 322 - Query 323 externalDocs: 324 description: Find out more about the query and error codes 325 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 326 '/cosmos/liquidity/v1beta1/pools/pool_coin_denom/{pool_coin_denom}': 327 get: 328 summary: Get specific liquidity pool corresponding to the pool_coin_denom. 329 description: It returns the liquidity pool corresponding to the pool_coin_denom. 330 operationId: LiquidityPoolByPoolCoinDenom 331 responses: 332 '200': 333 description: A successful response. 334 schema: 335 type: object 336 properties: 337 pool: 338 type: object 339 properties: 340 id: 341 type: string 342 format: uint64 343 example: '1' 344 title: id of the pool 345 type_id: 346 type: integer 347 format: uint32 348 example: '1' 349 title: id of the pool_type 350 reserve_coin_denoms: 351 type: array 352 example: 353 - denomX 354 - denomY 355 items: 356 type: string 357 title: denoms of reserve coin pair of the pool 358 reserve_account_address: 359 type: string 360 format: sdk.AccAddress 361 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 362 title: reserve account address of the pool 363 pool_coin_denom: 364 type: string 365 example: >- 366 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 367 title: denom of pool coin of the pool 368 description: >- 369 Pool defines the liquidity pool that contains pool 370 information. 371 description: >- 372 the response type for the QueryLiquidityPoolResponse RPC method. 373 Returns the liquidity pool that corresponds to the requested 374 pool_id. 375 '404': 376 description: Not Found 377 schema: {} 378 examples: 379 application/json: 380 code: 5 381 message: >- 382 rpc error: code = NotFound desc = liquidity pool with pool coin 383 denom xx doesn't exist: key not found 384 details: [] 385 '500': 386 description: Internal Server Error 387 schema: {} 388 examples: 389 application/json: 390 code: 2 391 message: >- 392 rpc error: code = NotFound desc = the liquidity pool 393 corresponding to the pool_coin_denom doesn't exist: key not 394 found 395 details: [] 396 default: 397 description: An unexpected error response. 398 schema: 399 type: object 400 properties: 401 error: 402 type: string 403 code: 404 type: integer 405 format: int32 406 message: 407 type: string 408 details: 409 type: array 410 items: 411 type: object 412 properties: 413 type_url: 414 type: string 415 value: 416 type: string 417 format: byte 418 parameters: 419 - name: pool_coin_denom 420 in: path 421 required: true 422 type: string 423 tags: 424 - Query 425 externalDocs: 426 description: Find out more about the query and error codes 427 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 428 '/cosmos/liquidity/v1beta1/pools/reserve_acc/{reserve_acc}': 429 get: 430 summary: Get specific liquidity pool corresponding to the reserve account. 431 description: It returns the liquidity pool corresponding to the reserve account. 432 operationId: LiquidityPoolByReserveAcc 433 responses: 434 '200': 435 description: A successful response. 436 schema: 437 type: object 438 properties: 439 pool: 440 type: object 441 properties: 442 id: 443 type: string 444 format: uint64 445 example: '1' 446 title: id of the pool 447 type_id: 448 type: integer 449 format: uint32 450 example: '1' 451 title: id of the pool_type 452 reserve_coin_denoms: 453 type: array 454 example: 455 - denomX 456 - denomY 457 items: 458 type: string 459 title: denoms of reserve coin pair of the pool 460 reserve_account_address: 461 type: string 462 format: sdk.AccAddress 463 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 464 title: reserve account address of the pool 465 pool_coin_denom: 466 type: string 467 example: >- 468 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 469 title: denom of pool coin of the pool 470 description: >- 471 Pool defines the liquidity pool that contains pool 472 information. 473 description: >- 474 the response type for the QueryLiquidityPoolResponse RPC method. 475 Returns the liquidity pool that corresponds to the requested 476 pool_id. 477 '404': 478 description: Not Found 479 schema: {} 480 examples: 481 application/json: 482 code: 5 483 message: >- 484 rpc error: code = NotFound desc = the reserve account address xx 485 is not valid: key not found 486 details: [] 487 '500': 488 description: Internal Server Error 489 schema: {} 490 examples: 491 application/json: 492 code: 2 493 message: >- 494 rpc error: code = NotFound desc = the liquidity pool 495 corresponding to the reserve account doesn't exist: key not 496 found 497 details: [] 498 default: 499 description: An unexpected error response. 500 schema: 501 type: object 502 properties: 503 error: 504 type: string 505 code: 506 type: integer 507 format: int32 508 message: 509 type: string 510 details: 511 type: array 512 items: 513 type: object 514 properties: 515 type_url: 516 type: string 517 value: 518 type: string 519 format: byte 520 parameters: 521 - name: reserve_acc 522 in: path 523 required: true 524 type: string 525 tags: 526 - Query 527 externalDocs: 528 description: Find out more about the query and error codes 529 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 530 '/cosmos/liquidity/v1beta1/pools/{pool_id}': 531 get: 532 summary: Get specific liquidity pool. 533 description: Returns the liquidity pool that corresponds to the pool_id. 534 operationId: LiquidityPool 535 responses: 536 '200': 537 description: A successful response. 538 schema: 539 type: object 540 properties: 541 pool: 542 type: object 543 properties: 544 id: 545 type: string 546 format: uint64 547 example: '1' 548 title: id of the pool 549 type_id: 550 type: integer 551 format: uint32 552 example: '1' 553 title: id of the pool_type 554 reserve_coin_denoms: 555 type: array 556 example: 557 - denomX 558 - denomY 559 items: 560 type: string 561 title: denoms of reserve coin pair of the pool 562 reserve_account_address: 563 type: string 564 format: sdk.AccAddress 565 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 566 title: reserve account address of the pool 567 pool_coin_denom: 568 type: string 569 example: >- 570 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 571 title: denom of pool coin of the pool 572 description: >- 573 Pool defines the liquidity pool that contains pool 574 information. 575 description: >- 576 the response type for the QueryLiquidityPoolResponse RPC method. 577 Returns the liquidity pool that corresponds to the requested 578 pool_id. 579 '400': 580 description: Bad Request 581 schema: {} 582 examples: 583 application/json: 584 code: 3 585 message: >- 586 type mismatch, parameter: pool_id, error: strconv.ParseUint: 587 parsing *: invalid syntax 588 details: [] 589 '500': 590 description: Internal Server Error 591 schema: {} 592 examples: 593 application/json: 594 code: 2 595 message: >- 596 rpc error: code = NotFound desc = liquidity pool 3 doesn't 597 exist: key not found 598 details: [] 599 default: 600 description: An unexpected error response. 601 schema: 602 type: object 603 properties: 604 error: 605 type: string 606 code: 607 type: integer 608 format: int32 609 message: 610 type: string 611 details: 612 type: array 613 items: 614 type: object 615 properties: 616 type_url: 617 type: string 618 value: 619 type: string 620 format: byte 621 parameters: 622 - name: pool_id 623 in: path 624 required: true 625 type: string 626 format: uint64 627 tags: 628 - Query 629 externalDocs: 630 description: Find out more about the query and error codes 631 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 632 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch': 633 get: 634 summary: Get the pool's current batch. 635 description: Returns the current batch of the pool that corresponds to the pool_id. 636 operationId: LiquidityPoolBatch 637 responses: 638 '200': 639 description: A successful response. 640 schema: 641 type: object 642 properties: 643 batch: 644 type: object 645 properties: 646 pool_id: 647 type: string 648 format: uint64 649 example: '1' 650 title: id of the pool 651 index: 652 type: string 653 format: uint64 654 example: '1' 655 title: index of this batch 656 begin_height: 657 type: string 658 format: int64 659 example: '1000' 660 title: height where this batch is started 661 deposit_msg_index: 662 type: string 663 format: uint64 664 example: '1' 665 title: last index of DepositMsgStates 666 withdraw_msg_index: 667 type: string 668 format: uint64 669 example: '1' 670 title: last index of WithdrawMsgStates 671 swap_msg_index: 672 type: string 673 format: uint64 674 example: '1' 675 title: last index of SwapMsgStates 676 executed: 677 type: boolean 678 example: true 679 title: 'true if executed, false if not executed' 680 description: >- 681 PoolBatch defines the batch or batches of a given liquidity 682 pool that contains indexes of deposit, withdraw, and swap 683 messages. 684 685 Index param increments by 1 if the pool id is same. 686 description: >- 687 the response type for the QueryLiquidityPoolBatchResponse RPC 688 method. Returns the liquidity pool batch that corresponds to the 689 requested pool_id. 690 '400': 691 description: Bad Request 692 schema: {} 693 examples: 694 application/json: 695 code: 3 696 message: >- 697 type mismatch, parameter: pool_id, error: strconv.ParseUint: 698 parsing *: invalid syntax 699 details: [] 700 '500': 701 description: Internal Server Error 702 schema: {} 703 examples: 704 application/json: 705 code: 2 706 message: >- 707 rpc error: code = NotFound desc = liquidity pool 3 doesn't 708 exist: key not found 709 details: [] 710 default: 711 description: An unexpected error response. 712 schema: 713 type: object 714 properties: 715 error: 716 type: string 717 code: 718 type: integer 719 format: int32 720 message: 721 type: string 722 details: 723 type: array 724 items: 725 type: object 726 properties: 727 type_url: 728 type: string 729 value: 730 type: string 731 format: byte 732 parameters: 733 - name: pool_id 734 description: id of the target pool for query 735 in: path 736 required: true 737 type: string 738 format: uint64 739 tags: 740 - Query 741 externalDocs: 742 description: Find out more about the query and error codes 743 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 744 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch/deposits': 745 get: 746 summary: Get all deposit messages in the pool's current batch. 747 description: >- 748 Returns a list of all deposit messages in the current batch of the pool 749 with pagination result. 750 operationId: PoolBatchDepositMsgs 751 responses: 752 '200': 753 description: A successful response. 754 schema: 755 type: object 756 properties: 757 deposits: 758 type: array 759 items: 760 type: object 761 properties: 762 msg_height: 763 type: string 764 format: int64 765 example: '1000' 766 title: height where this message is appended to the batch 767 msg_index: 768 type: string 769 format: uint64 770 example: '1' 771 title: index of this deposit message in this liquidity pool 772 executed: 773 type: boolean 774 example: true 775 title: 'true if executed on this batch, false if not executed' 776 succeeded: 777 type: boolean 778 example: true 779 title: >- 780 true if executed successfully on this batch, false if 781 failed 782 to_be_deleted: 783 type: boolean 784 example: true 785 title: >- 786 true if ready to be deleted on kvstore, false if not 787 ready to be deleted 788 msg: 789 title: MsgDepositWithinBatch 790 type: object 791 properties: 792 depositor_address: 793 type: string 794 format: sdk.AccAddress 795 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 796 description: account address of the origin of this message 797 pool_id: 798 type: string 799 format: uint64 800 example: '1' 801 title: id of the target pool 802 deposit_coins: 803 type: array 804 format: sdk.Coins 805 example: 806 - denom: denomX 807 amount: '1000000' 808 - denom: denomY 809 amount: '2000000' 810 items: 811 type: object 812 properties: 813 denom: 814 type: string 815 amount: 816 type: string 817 description: >- 818 Coin defines a token with a denomination and an 819 amount. 820 821 822 NOTE: The amount field is an Int which implements 823 the custom method 824 825 signatures required by gogoproto. 826 title: reserve coin pair of the pool to deposit 827 description: >- 828 `MsgDepositWithinBatch defines` an `sdk.Msg` type that 829 supports submitting 830 831 a deposit request to the batch of the liquidity pool. 832 833 Deposit is submitted to the batch of the Liquidity pool 834 with the specified 835 836 `pool_id`, `deposit_coins` for reserve. 837 838 This request is stacked in the batch of the liquidity 839 pool, is not processed 840 841 immediately, and is processed in the `endblock` at the 842 same time as other requests. 843 844 845 See: 846 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 847 description: >- 848 DepositMsgState defines the state of deposit message that 849 contains state information as it is processed in the next 850 batch or batches. 851 pagination: 852 description: >- 853 pagination defines the pagination in the response. not working 854 on this version. 855 type: object 856 properties: 857 next_key: 858 type: string 859 format: byte 860 title: |- 861 next_key is the key to be passed to PageRequest.key to 862 query the next page most efficiently 863 total: 864 type: string 865 format: uint64 866 title: >- 867 total is total number of results available if 868 PageRequest.count_total 869 870 was set, its value is undefined otherwise 871 description: >- 872 the response type for the QueryPoolBatchDeposit RPC method. This 873 includes a list of all currently existing deposit messages of the 874 batch and paging results that contain next_key and total count. 875 '400': 876 description: Bad Request 877 schema: {} 878 examples: 879 application/json: 880 code: 3 881 message: >- 882 type mismatch, parameter: pool_id, error: strconv.ParseUint: 883 parsing *: invalid syntax 884 details: [] 885 '500': 886 description: Internal Server Error 887 schema: {} 888 examples: 889 application/json: 890 code: 2 891 message: >- 892 rpc error: code = NotFound desc = liquidity pool 3 doesn't 893 exist: key not found 894 details: [] 895 default: 896 description: An unexpected error response. 897 schema: 898 type: object 899 properties: 900 error: 901 type: string 902 code: 903 type: integer 904 format: int32 905 message: 906 type: string 907 details: 908 type: array 909 items: 910 type: object 911 properties: 912 type_url: 913 type: string 914 value: 915 type: string 916 format: byte 917 parameters: 918 - name: pool_id 919 description: id of the target pool for query 920 in: path 921 required: true 922 type: string 923 format: uint64 924 - name: pagination.key 925 description: |- 926 key is a value returned in PageResponse.next_key to begin 927 querying the next page most efficiently. Only one of offset or key 928 should be set. 929 in: query 930 required: false 931 type: string 932 format: byte 933 - name: pagination.offset 934 description: >- 935 offset is a numeric offset that can be used when key is unavailable. 936 937 It is less efficient than using key. Only one of offset or key 938 should 939 940 be set. 941 in: query 942 required: false 943 type: string 944 format: uint64 945 - name: pagination.limit 946 description: >- 947 limit is the total number of results to be returned in the result 948 page. 949 950 If left empty it will default to a value to be set by each app. 951 in: query 952 required: false 953 type: string 954 format: uint64 955 - name: pagination.count_total 956 description: >- 957 count_total is set to true to indicate that the result set should 958 include 959 960 a count of the total number of items available for pagination in 961 UIs. 962 963 count_total is only respected when offset is used. It is ignored 964 when key 965 966 is set. 967 in: query 968 required: false 969 type: boolean 970 tags: 971 - Query 972 externalDocs: 973 description: Find out more about the query and error codes 974 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 975 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch/deposits/{msg_index}': 976 get: 977 summary: Get a specific deposit message in the pool's current batch. 978 description: >- 979 Returns the deposit message that corresponds to the msg_index in the 980 pool's current batch. 981 operationId: PoolBatchDepositMsg 982 responses: 983 '200': 984 description: A successful response. 985 schema: 986 type: object 987 properties: 988 deposit: 989 type: object 990 properties: 991 msg_height: 992 type: string 993 format: int64 994 example: '1000' 995 title: height where this message is appended to the batch 996 msg_index: 997 type: string 998 format: uint64 999 example: '1' 1000 title: index of this deposit message in this liquidity pool 1001 executed: 1002 type: boolean 1003 example: true 1004 title: 'true if executed on this batch, false if not executed' 1005 succeeded: 1006 type: boolean 1007 example: true 1008 title: >- 1009 true if executed successfully on this batch, false if 1010 failed 1011 to_be_deleted: 1012 type: boolean 1013 example: true 1014 title: >- 1015 true if ready to be deleted on kvstore, false if not ready 1016 to be deleted 1017 msg: 1018 title: MsgDepositWithinBatch 1019 type: object 1020 properties: 1021 depositor_address: 1022 type: string 1023 format: sdk.AccAddress 1024 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 1025 description: account address of the origin of this message 1026 pool_id: 1027 type: string 1028 format: uint64 1029 example: '1' 1030 title: id of the target pool 1031 deposit_coins: 1032 type: array 1033 format: sdk.Coins 1034 example: 1035 - denom: denomX 1036 amount: '1000000' 1037 - denom: denomY 1038 amount: '2000000' 1039 items: 1040 type: object 1041 properties: 1042 denom: 1043 type: string 1044 amount: 1045 type: string 1046 description: >- 1047 Coin defines a token with a denomination and an 1048 amount. 1049 1050 1051 NOTE: The amount field is an Int which implements 1052 the custom method 1053 1054 signatures required by gogoproto. 1055 title: reserve coin pair of the pool to deposit 1056 description: >- 1057 `MsgDepositWithinBatch defines` an `sdk.Msg` type that 1058 supports submitting 1059 1060 a deposit request to the batch of the liquidity pool. 1061 1062 Deposit is submitted to the batch of the Liquidity pool 1063 with the specified 1064 1065 `pool_id`, `deposit_coins` for reserve. 1066 1067 This request is stacked in the batch of the liquidity 1068 pool, is not processed 1069 1070 immediately, and is processed in the `endblock` at the 1071 same time as other requests. 1072 1073 1074 See: 1075 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 1076 description: >- 1077 DepositMsgState defines the state of deposit message that 1078 contains state information as it is processed in the next 1079 batch or batches. 1080 description: >- 1081 the response type for the QueryPoolBatchDepositMsg RPC method. 1082 This includes a batch swap message of the batch. 1083 '400': 1084 description: Bad Request 1085 schema: {} 1086 examples: 1087 application/json: 1088 code: 3 1089 message: >- 1090 type mismatch, parameter: msg_index, error: strconv.ParseUint: 1091 parsing *: invalid syntax 1092 details: [] 1093 '500': 1094 description: Internal Server Error 1095 schema: {} 1096 examples: 1097 application/json: 1098 root: 1099 code: 2 1100 details: [] 1101 message: >- 1102 rpc error: code = NotFound desc = the msg given msg_index 1 1103 doesn't exist or deleted: key not found 1104 default: 1105 description: An unexpected error response. 1106 schema: 1107 type: object 1108 properties: 1109 error: 1110 type: string 1111 code: 1112 type: integer 1113 format: int32 1114 message: 1115 type: string 1116 details: 1117 type: array 1118 items: 1119 type: object 1120 properties: 1121 type_url: 1122 type: string 1123 value: 1124 type: string 1125 format: byte 1126 parameters: 1127 - name: pool_id 1128 description: id of the target pool for query 1129 in: path 1130 required: true 1131 type: string 1132 format: uint64 1133 - name: msg_index 1134 description: target msg_index of the pool 1135 in: path 1136 required: true 1137 type: string 1138 format: uint64 1139 tags: 1140 - Query 1141 externalDocs: 1142 description: Find out more about the query and error codes 1143 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 1144 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch/swaps': 1145 get: 1146 summary: Get all swap messages in the pool's current batch. 1147 description: >- 1148 Returns a list of all swap messages in the current batch of the pool 1149 with pagination result. 1150 operationId: PoolBatchSwapMsgs 1151 responses: 1152 '200': 1153 description: A successful response. 1154 schema: 1155 type: object 1156 properties: 1157 swaps: 1158 type: array 1159 items: 1160 type: object 1161 properties: 1162 msg_height: 1163 type: string 1164 format: int64 1165 example: '1000' 1166 title: height where this message is appended to the batch 1167 msg_index: 1168 type: string 1169 format: uint64 1170 example: '1' 1171 title: index of this swap message in this liquidity pool 1172 executed: 1173 type: boolean 1174 example: true 1175 title: 'true if executed on this batch, false if not executed' 1176 succeeded: 1177 type: boolean 1178 example: true 1179 title: >- 1180 true if executed successfully on this batch, false if 1181 failed 1182 to_be_deleted: 1183 type: boolean 1184 example: true 1185 title: >- 1186 true if ready to be deleted on kvstore, false if not 1187 ready to be deleted 1188 order_expiry_height: 1189 type: string 1190 format: int64 1191 example: '1000' 1192 title: >- 1193 swap orders are cancelled when current height is equal 1194 to or higher than ExpiryHeight 1195 exchanged_offer_coin: 1196 type: object 1197 properties: 1198 denom: 1199 type: string 1200 amount: 1201 type: string 1202 description: >- 1203 Coin defines a token with a denomination and an amount. 1204 1205 1206 NOTE: The amount field is an Int which implements the 1207 custom method 1208 1209 signatures required by gogoproto. 1210 format: sdk.Coin 1211 example: 1212 denom: denomX 1213 amount: '600000' 1214 title: offer coin exchanged until now 1215 remaining_offer_coin: 1216 type: object 1217 properties: 1218 denom: 1219 type: string 1220 amount: 1221 type: string 1222 description: >- 1223 Coin defines a token with a denomination and an amount. 1224 1225 1226 NOTE: The amount field is an Int which implements the 1227 custom method 1228 1229 signatures required by gogoproto. 1230 format: sdk.Coin 1231 example: 1232 denom: denomX 1233 amount: '400000' 1234 title: offer coin currently remaining to be exchanged 1235 reserved_offer_coin_fee: 1236 type: object 1237 properties: 1238 denom: 1239 type: string 1240 amount: 1241 type: string 1242 description: >- 1243 Coin defines a token with a denomination and an amount. 1244 1245 1246 NOTE: The amount field is an Int which implements the 1247 custom method 1248 1249 signatures required by gogoproto. 1250 format: sdk.Coin 1251 example: 1252 denom: denomX 1253 amount: '5000' 1254 title: reserve fee for pays fee in half offer coin 1255 msg: 1256 title: MsgSwapWithinBatch 1257 type: object 1258 properties: 1259 swap_requester_address: 1260 type: string 1261 format: sdk.AccAddress 1262 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 1263 description: account address of the origin of this message 1264 title: address of swap requester 1265 pool_id: 1266 type: string 1267 format: uint64 1268 example: '1' 1269 description: >- 1270 id of swap type, must match the value in the pool. 1271 Only `swap_type_id` 1 is supported. 1272 swap_type_id: 1273 type: integer 1274 format: uint32 1275 example: '1' 1276 description: id of swap type. Must match the value in the pool. 1277 offer_coin: 1278 type: object 1279 properties: 1280 denom: 1281 type: string 1282 amount: 1283 type: string 1284 description: >- 1285 Coin defines a token with a denomination and an 1286 amount. 1287 1288 1289 NOTE: The amount field is an Int which implements 1290 the custom method 1291 1292 signatures required by gogoproto. 1293 format: sdk.Coin 1294 example: 1295 denom: denomX 1296 amount: '1000000' 1297 demand_coin_denom: 1298 type: string 1299 example: denomB 1300 description: >- 1301 denom of demand coin to be exchanged on the swap 1302 request, must match the denom in the pool. 1303 offer_coin_fee: 1304 type: object 1305 properties: 1306 denom: 1307 type: string 1308 amount: 1309 type: string 1310 description: >- 1311 Coin defines a token with a denomination and an 1312 amount. 1313 1314 1315 NOTE: The amount field is an Int which implements 1316 the custom method 1317 1318 signatures required by gogoproto. 1319 format: sdk.Coin 1320 example: 1321 denom: denomX 1322 amount: '5000' 1323 order_price: 1324 type: string 1325 format: sdk.Dec 1326 example: '1.1' 1327 description: >- 1328 limit order price for the order, the price is the 1329 exchange ratio of X/Y 1330 1331 where X is the amount of the first coin and Y is the 1332 amount 1333 1334 of the second coin when their denoms are sorted 1335 alphabetically. 1336 description: >- 1337 `MsgSwapWithinBatch` defines an sdk.Msg type that 1338 supports submitting a swap offer request to the batch of 1339 the liquidity pool. 1340 1341 Submit swap offer to the liquidity pool batch with the 1342 specified the `pool_id`, `swap_type_id`, 1343 1344 `demand_coin_denom` with the coin and the price you're 1345 offering 1346 1347 and `offer_coin_fee` must be half of offer coin amount * 1348 current `params.swap_fee_rate` and ceil for reservation 1349 to pay fees. 1350 1351 This request is stacked in the batch of the liquidity 1352 pool, is not processed 1353 1354 immediately, and is processed in the `endblock` at the 1355 same time as other requests. 1356 1357 You must request the same fields as the pool. 1358 1359 Only the default `swap_type_id` 1 is supported. 1360 1361 1362 See: 1363 https://github.com/gravity-devs/liquidity/tree/develop/doc 1364 1365 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 1366 description: >- 1367 SwapMsgState defines the state of the swap message that 1368 contains state information as the message is processed in 1369 the next batch or batches. 1370 pagination: 1371 description: >- 1372 pagination defines the pagination in the response. not working 1373 on this version. 1374 type: object 1375 properties: 1376 next_key: 1377 type: string 1378 format: byte 1379 title: |- 1380 next_key is the key to be passed to PageRequest.key to 1381 query the next page most efficiently 1382 total: 1383 type: string 1384 format: uint64 1385 title: >- 1386 total is total number of results available if 1387 PageRequest.count_total 1388 1389 was set, its value is undefined otherwise 1390 description: >- 1391 the response type for the QueryPoolBatchSwapMsgs RPC method. This 1392 includes list of all currently existing swap messages of the batch 1393 and paging results that contain next_key and total count. 1394 '400': 1395 description: Bad Request 1396 schema: {} 1397 examples: 1398 application/json: 1399 code: 3 1400 message: >- 1401 type mismatch, parameter: pool_id, error: strconv.ParseUint: 1402 parsing *: invalid syntax 1403 details: [] 1404 '500': 1405 description: Internal Server Error 1406 schema: {} 1407 examples: 1408 application/json: 1409 code: 2 1410 message: >- 1411 rpc error: code = NotFound desc = liquidity pool 3 doesn't 1412 exist: key not found 1413 details: [] 1414 default: 1415 description: An unexpected error response. 1416 schema: 1417 type: object 1418 properties: 1419 error: 1420 type: string 1421 code: 1422 type: integer 1423 format: int32 1424 message: 1425 type: string 1426 details: 1427 type: array 1428 items: 1429 type: object 1430 properties: 1431 type_url: 1432 type: string 1433 value: 1434 type: string 1435 format: byte 1436 parameters: 1437 - name: pool_id 1438 description: id of the target pool for query 1439 in: path 1440 required: true 1441 type: string 1442 format: uint64 1443 - name: pagination.key 1444 description: |- 1445 key is a value returned in PageResponse.next_key to begin 1446 querying the next page most efficiently. Only one of offset or key 1447 should be set. 1448 in: query 1449 required: false 1450 type: string 1451 format: byte 1452 - name: pagination.offset 1453 description: >- 1454 offset is a numeric offset that can be used when key is unavailable. 1455 1456 It is less efficient than using key. Only one of offset or key 1457 should 1458 1459 be set. 1460 in: query 1461 required: false 1462 type: string 1463 format: uint64 1464 - name: pagination.limit 1465 description: >- 1466 limit is the total number of results to be returned in the result 1467 page. 1468 1469 If left empty it will default to a value to be set by each app. 1470 in: query 1471 required: false 1472 type: string 1473 format: uint64 1474 - name: pagination.count_total 1475 description: >- 1476 count_total is set to true to indicate that the result set should 1477 include 1478 1479 a count of the total number of items available for pagination in 1480 UIs. 1481 1482 count_total is only respected when offset is used. It is ignored 1483 when key 1484 1485 is set. 1486 in: query 1487 required: false 1488 type: boolean 1489 tags: 1490 - Query 1491 externalDocs: 1492 description: Find out more about the query and error codes 1493 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 1494 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch/swaps/{msg_index}': 1495 get: 1496 summary: Get a specific swap message in the pool's current batch. 1497 description: >- 1498 Returns the swap message that corresponds to the msg_index in the pool's 1499 current batch 1500 operationId: PoolBatchSwapMsg 1501 responses: 1502 '200': 1503 description: A successful response. 1504 schema: 1505 type: object 1506 properties: 1507 swap: 1508 type: object 1509 properties: 1510 msg_height: 1511 type: string 1512 format: int64 1513 example: '1000' 1514 title: height where this message is appended to the batch 1515 msg_index: 1516 type: string 1517 format: uint64 1518 example: '1' 1519 title: index of this swap message in this liquidity pool 1520 executed: 1521 type: boolean 1522 example: true 1523 title: 'true if executed on this batch, false if not executed' 1524 succeeded: 1525 type: boolean 1526 example: true 1527 title: >- 1528 true if executed successfully on this batch, false if 1529 failed 1530 to_be_deleted: 1531 type: boolean 1532 example: true 1533 title: >- 1534 true if ready to be deleted on kvstore, false if not ready 1535 to be deleted 1536 order_expiry_height: 1537 type: string 1538 format: int64 1539 example: '1000' 1540 title: >- 1541 swap orders are cancelled when current height is equal to 1542 or higher than ExpiryHeight 1543 exchanged_offer_coin: 1544 type: object 1545 properties: 1546 denom: 1547 type: string 1548 amount: 1549 type: string 1550 description: >- 1551 Coin defines a token with a denomination and an amount. 1552 1553 1554 NOTE: The amount field is an Int which implements the 1555 custom method 1556 1557 signatures required by gogoproto. 1558 format: sdk.Coin 1559 example: 1560 denom: denomX 1561 amount: '600000' 1562 title: offer coin exchanged until now 1563 remaining_offer_coin: 1564 type: object 1565 properties: 1566 denom: 1567 type: string 1568 amount: 1569 type: string 1570 description: >- 1571 Coin defines a token with a denomination and an amount. 1572 1573 1574 NOTE: The amount field is an Int which implements the 1575 custom method 1576 1577 signatures required by gogoproto. 1578 format: sdk.Coin 1579 example: 1580 denom: denomX 1581 amount: '400000' 1582 title: offer coin currently remaining to be exchanged 1583 reserved_offer_coin_fee: 1584 type: object 1585 properties: 1586 denom: 1587 type: string 1588 amount: 1589 type: string 1590 description: >- 1591 Coin defines a token with a denomination and an amount. 1592 1593 1594 NOTE: The amount field is an Int which implements the 1595 custom method 1596 1597 signatures required by gogoproto. 1598 format: sdk.Coin 1599 example: 1600 denom: denomX 1601 amount: '5000' 1602 title: reserve fee for pays fee in half offer coin 1603 msg: 1604 title: MsgSwapWithinBatch 1605 type: object 1606 properties: 1607 swap_requester_address: 1608 type: string 1609 format: sdk.AccAddress 1610 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 1611 description: account address of the origin of this message 1612 title: address of swap requester 1613 pool_id: 1614 type: string 1615 format: uint64 1616 example: '1' 1617 description: >- 1618 id of swap type, must match the value in the pool. 1619 Only `swap_type_id` 1 is supported. 1620 swap_type_id: 1621 type: integer 1622 format: uint32 1623 example: '1' 1624 description: id of swap type. Must match the value in the pool. 1625 offer_coin: 1626 type: object 1627 properties: 1628 denom: 1629 type: string 1630 amount: 1631 type: string 1632 description: >- 1633 Coin defines a token with a denomination and an 1634 amount. 1635 1636 1637 NOTE: The amount field is an Int which implements the 1638 custom method 1639 1640 signatures required by gogoproto. 1641 format: sdk.Coin 1642 example: 1643 denom: denomX 1644 amount: '1000000' 1645 demand_coin_denom: 1646 type: string 1647 example: denomB 1648 description: >- 1649 denom of demand coin to be exchanged on the swap 1650 request, must match the denom in the pool. 1651 offer_coin_fee: 1652 type: object 1653 properties: 1654 denom: 1655 type: string 1656 amount: 1657 type: string 1658 description: >- 1659 Coin defines a token with a denomination and an 1660 amount. 1661 1662 1663 NOTE: The amount field is an Int which implements the 1664 custom method 1665 1666 signatures required by gogoproto. 1667 format: sdk.Coin 1668 example: 1669 denom: denomX 1670 amount: '5000' 1671 order_price: 1672 type: string 1673 format: sdk.Dec 1674 example: '1.1' 1675 description: >- 1676 limit order price for the order, the price is the 1677 exchange ratio of X/Y 1678 1679 where X is the amount of the first coin and Y is the 1680 amount 1681 1682 of the second coin when their denoms are sorted 1683 alphabetically. 1684 description: >- 1685 `MsgSwapWithinBatch` defines an sdk.Msg type that supports 1686 submitting a swap offer request to the batch of the 1687 liquidity pool. 1688 1689 Submit swap offer to the liquidity pool batch with the 1690 specified the `pool_id`, `swap_type_id`, 1691 1692 `demand_coin_denom` with the coin and the price you're 1693 offering 1694 1695 and `offer_coin_fee` must be half of offer coin amount * 1696 current `params.swap_fee_rate` and ceil for reservation to 1697 pay fees. 1698 1699 This request is stacked in the batch of the liquidity 1700 pool, is not processed 1701 1702 immediately, and is processed in the `endblock` at the 1703 same time as other requests. 1704 1705 You must request the same fields as the pool. 1706 1707 Only the default `swap_type_id` 1 is supported. 1708 1709 1710 See: 1711 https://github.com/gravity-devs/liquidity/tree/develop/doc 1712 1713 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 1714 description: >- 1715 SwapMsgState defines the state of the swap message that 1716 contains state information as the message is processed in the 1717 next batch or batches. 1718 description: >- 1719 the response type for the QueryPoolBatchSwapMsg RPC method. This 1720 includes a batch swap message of the batch. 1721 '400': 1722 description: Bad Request 1723 schema: {} 1724 examples: 1725 application/json: 1726 code: 3 1727 message: >- 1728 type mismatch, parameter: msg_index, error: strconv.ParseUint: 1729 parsing *: invalid syntax 1730 details: [] 1731 '500': 1732 description: Internal Server Error 1733 schema: {} 1734 examples: 1735 application/json: 1736 root: 1737 code: 2 1738 details: [] 1739 message: >- 1740 rpc error: code = NotFound desc = the msg given msg_index 1 1741 doesn't exist or deleted: key not found 1742 default: 1743 description: An unexpected error response. 1744 schema: 1745 type: object 1746 properties: 1747 error: 1748 type: string 1749 code: 1750 type: integer 1751 format: int32 1752 message: 1753 type: string 1754 details: 1755 type: array 1756 items: 1757 type: object 1758 properties: 1759 type_url: 1760 type: string 1761 value: 1762 type: string 1763 format: byte 1764 parameters: 1765 - name: pool_id 1766 description: id of the target pool for query 1767 in: path 1768 required: true 1769 type: string 1770 format: uint64 1771 - name: msg_index 1772 description: target msg_index of the pool 1773 in: path 1774 required: true 1775 type: string 1776 format: uint64 1777 tags: 1778 - Query 1779 externalDocs: 1780 description: Find out more about the query and error codes 1781 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 1782 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch/withdraws': 1783 get: 1784 summary: Get all withdraw messages in the pool's current batch. 1785 description: >- 1786 Returns a list of all withdraw messages in the current batch of the pool 1787 with pagination result. 1788 operationId: PoolBatchWithdrawMsgs 1789 responses: 1790 '200': 1791 description: A successful response. 1792 schema: 1793 type: object 1794 properties: 1795 withdraws: 1796 type: array 1797 items: 1798 type: object 1799 properties: 1800 msg_height: 1801 type: string 1802 format: int64 1803 example: '1000' 1804 title: height where this message is appended to the batch 1805 msg_index: 1806 type: string 1807 format: uint64 1808 example: '1' 1809 title: index of this withdraw message in this liquidity pool 1810 executed: 1811 type: boolean 1812 example: true 1813 title: 'true if executed on this batch, false if not executed' 1814 succeeded: 1815 type: boolean 1816 example: true 1817 title: >- 1818 true if executed successfully on this batch, false if 1819 failed 1820 to_be_deleted: 1821 type: boolean 1822 example: true 1823 title: >- 1824 true if ready to be deleted on kvstore, false if not 1825 ready to be deleted 1826 msg: 1827 title: MsgWithdrawWithinBatch 1828 type: object 1829 properties: 1830 withdrawer_address: 1831 type: string 1832 format: sdk.AccAddress 1833 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 1834 description: account address of the origin of this message 1835 pool_id: 1836 type: string 1837 format: uint64 1838 example: '1' 1839 title: id of the target pool 1840 pool_coin: 1841 type: object 1842 properties: 1843 denom: 1844 type: string 1845 amount: 1846 type: string 1847 description: >- 1848 Coin defines a token with a denomination and an 1849 amount. 1850 1851 1852 NOTE: The amount field is an Int which implements 1853 the custom method 1854 1855 signatures required by gogoproto. 1856 format: sdk.Coin 1857 example: 1858 denom: >- 1859 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 1860 amount: '1000' 1861 description: >- 1862 `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that 1863 supports submitting 1864 1865 a withdraw request to the batch of the liquidity pool. 1866 1867 Withdraw is submitted to the batch from the Liquidity 1868 pool with the 1869 1870 specified `pool_id`, `pool_coin` of the pool. 1871 1872 This request is stacked in the batch of the liquidity 1873 pool, is not processed 1874 1875 immediately, and is processed in the `endblock` at the 1876 same time as other requests. 1877 1878 1879 See: 1880 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 1881 description: >- 1882 WithdrawMsgState defines the state of the withdraw message 1883 that contains state information as the message is processed 1884 in the next batch or batches. 1885 pagination: 1886 description: >- 1887 pagination defines the pagination in the response. Not 1888 supported on this version. 1889 type: object 1890 properties: 1891 next_key: 1892 type: string 1893 format: byte 1894 title: |- 1895 next_key is the key to be passed to PageRequest.key to 1896 query the next page most efficiently 1897 total: 1898 type: string 1899 format: uint64 1900 title: >- 1901 total is total number of results available if 1902 PageRequest.count_total 1903 1904 was set, its value is undefined otherwise 1905 description: >- 1906 the response type for the QueryPoolBatchWithdraw RPC method. This 1907 includes a list of all currently existing withdraw messages of the 1908 batch and paging results that contain next_key and total count. 1909 '400': 1910 description: Bad Request 1911 schema: {} 1912 examples: 1913 application/json: 1914 code: 3 1915 message: >- 1916 type mismatch, parameter: pool_id, error: strconv.ParseUint: 1917 parsing *: invalid syntax 1918 details: [] 1919 '500': 1920 description: Internal Server Error 1921 schema: {} 1922 examples: 1923 application/json: 1924 code: 2 1925 message: >- 1926 rpc error: code = NotFound desc = liquidity pool 3 doesn't 1927 exist: key not found 1928 details: [] 1929 default: 1930 description: An unexpected error response. 1931 schema: 1932 type: object 1933 properties: 1934 error: 1935 type: string 1936 code: 1937 type: integer 1938 format: int32 1939 message: 1940 type: string 1941 details: 1942 type: array 1943 items: 1944 type: object 1945 properties: 1946 type_url: 1947 type: string 1948 value: 1949 type: string 1950 format: byte 1951 parameters: 1952 - name: pool_id 1953 description: id of the target pool for query 1954 in: path 1955 required: true 1956 type: string 1957 format: uint64 1958 - name: pagination.key 1959 description: |- 1960 key is a value returned in PageResponse.next_key to begin 1961 querying the next page most efficiently. Only one of offset or key 1962 should be set. 1963 in: query 1964 required: false 1965 type: string 1966 format: byte 1967 - name: pagination.offset 1968 description: >- 1969 offset is a numeric offset that can be used when key is unavailable. 1970 1971 It is less efficient than using key. Only one of offset or key 1972 should 1973 1974 be set. 1975 in: query 1976 required: false 1977 type: string 1978 format: uint64 1979 - name: pagination.limit 1980 description: >- 1981 limit is the total number of results to be returned in the result 1982 page. 1983 1984 If left empty it will default to a value to be set by each app. 1985 in: query 1986 required: false 1987 type: string 1988 format: uint64 1989 - name: pagination.count_total 1990 description: >- 1991 count_total is set to true to indicate that the result set should 1992 include 1993 1994 a count of the total number of items available for pagination in 1995 UIs. 1996 1997 count_total is only respected when offset is used. It is ignored 1998 when key 1999 2000 is set. 2001 in: query 2002 required: false 2003 type: boolean 2004 tags: 2005 - Query 2006 externalDocs: 2007 description: Find out more about the query and error codes 2008 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 2009 '/cosmos/liquidity/v1beta1/pools/{pool_id}/batch/withdraws/{msg_index}': 2010 get: 2011 summary: Get a specific withdraw message in the pool's current batch. 2012 description: >- 2013 Returns the withdraw message that corresponds to the msg_index in the 2014 pool's current batch. 2015 operationId: PoolBatchWithdrawMsg 2016 responses: 2017 '200': 2018 description: A successful response. 2019 schema: 2020 type: object 2021 properties: 2022 withdraw: 2023 type: object 2024 properties: 2025 msg_height: 2026 type: string 2027 format: int64 2028 example: '1000' 2029 title: height where this message is appended to the batch 2030 msg_index: 2031 type: string 2032 format: uint64 2033 example: '1' 2034 title: index of this withdraw message in this liquidity pool 2035 executed: 2036 type: boolean 2037 example: true 2038 title: 'true if executed on this batch, false if not executed' 2039 succeeded: 2040 type: boolean 2041 example: true 2042 title: >- 2043 true if executed successfully on this batch, false if 2044 failed 2045 to_be_deleted: 2046 type: boolean 2047 example: true 2048 title: >- 2049 true if ready to be deleted on kvstore, false if not ready 2050 to be deleted 2051 msg: 2052 title: MsgWithdrawWithinBatch 2053 type: object 2054 properties: 2055 withdrawer_address: 2056 type: string 2057 format: sdk.AccAddress 2058 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 2059 description: account address of the origin of this message 2060 pool_id: 2061 type: string 2062 format: uint64 2063 example: '1' 2064 title: id of the target pool 2065 pool_coin: 2066 type: object 2067 properties: 2068 denom: 2069 type: string 2070 amount: 2071 type: string 2072 description: >- 2073 Coin defines a token with a denomination and an 2074 amount. 2075 2076 2077 NOTE: The amount field is an Int which implements the 2078 custom method 2079 2080 signatures required by gogoproto. 2081 format: sdk.Coin 2082 example: 2083 denom: >- 2084 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 2085 amount: '1000' 2086 description: >- 2087 `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that 2088 supports submitting 2089 2090 a withdraw request to the batch of the liquidity pool. 2091 2092 Withdraw is submitted to the batch from the Liquidity pool 2093 with the 2094 2095 specified `pool_id`, `pool_coin` of the pool. 2096 2097 This request is stacked in the batch of the liquidity 2098 pool, is not processed 2099 2100 immediately, and is processed in the `endblock` at the 2101 same time as other requests. 2102 2103 2104 See: 2105 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 2106 description: >- 2107 WithdrawMsgState defines the state of the withdraw message 2108 that contains state information as the message is processed in 2109 the next batch or batches. 2110 description: >- 2111 the response type for the QueryPoolBatchWithdrawMsg RPC method. 2112 This includes a batch swap message of the batch. 2113 '400': 2114 description: Bad Request 2115 schema: {} 2116 examples: 2117 application/json: 2118 code: 3 2119 message: >- 2120 type mismatch, parameter: msg_index, error: strconv.ParseUint: 2121 parsing *: invalid syntax 2122 details: [] 2123 '500': 2124 description: Internal Server Error 2125 schema: {} 2126 examples: 2127 application/json: 2128 root: 2129 code: 2 2130 details: [] 2131 message: >- 2132 rpc error: code = NotFound desc = the msg given msg_index 1 2133 doesn't exist or deleted: key not found 2134 default: 2135 description: An unexpected error response. 2136 schema: 2137 type: object 2138 properties: 2139 error: 2140 type: string 2141 code: 2142 type: integer 2143 format: int32 2144 message: 2145 type: string 2146 details: 2147 type: array 2148 items: 2149 type: object 2150 properties: 2151 type_url: 2152 type: string 2153 value: 2154 type: string 2155 format: byte 2156 parameters: 2157 - name: pool_id 2158 description: id of the target pool for query 2159 in: path 2160 required: true 2161 type: string 2162 format: uint64 2163 - name: msg_index 2164 description: target msg_index of the pool 2165 in: path 2166 required: true 2167 type: string 2168 format: uint64 2169 tags: 2170 - Query 2171 externalDocs: 2172 description: Find out more about the query and error codes 2173 url: 'https://github.com/tendermint/liquidity/blob/develop/doc/client.md' 2174 definitions: 2175 cosmos.base.query.v1beta1.PageRequest: 2176 type: object 2177 properties: 2178 key: 2179 type: string 2180 format: byte 2181 description: |- 2182 key is a value returned in PageResponse.next_key to begin 2183 querying the next page most efficiently. Only one of offset or key 2184 should be set. 2185 offset: 2186 type: string 2187 format: uint64 2188 description: |- 2189 offset is a numeric offset that can be used when key is unavailable. 2190 It is less efficient than using key. Only one of offset or key should 2191 be set. 2192 limit: 2193 type: string 2194 format: uint64 2195 description: >- 2196 limit is the total number of results to be returned in the result 2197 page. 2198 2199 If left empty it will default to a value to be set by each app. 2200 count_total: 2201 type: boolean 2202 description: >- 2203 count_total is set to true to indicate that the result set should 2204 include 2205 2206 a count of the total number of items available for pagination in UIs. 2207 2208 count_total is only respected when offset is used. It is ignored when 2209 key 2210 2211 is set. 2212 description: |- 2213 message SomeRequest { 2214 Foo some_parameter = 1; 2215 PageRequest pagination = 2; 2216 } 2217 title: |- 2218 PageRequest is to be embedded in gRPC request messages for efficient 2219 pagination. Ex: 2220 cosmos.base.query.v1beta1.PageResponse: 2221 type: object 2222 properties: 2223 next_key: 2224 type: string 2225 format: byte 2226 title: |- 2227 next_key is the key to be passed to PageRequest.key to 2228 query the next page most efficiently 2229 total: 2230 type: string 2231 format: uint64 2232 title: |- 2233 total is total number of results available if PageRequest.count_total 2234 was set, its value is undefined otherwise 2235 description: |- 2236 PageResponse is to be embedded in gRPC response messages where the 2237 corresponding request message has used PageRequest. 2238 2239 message SomeResponse { 2240 repeated Bar results = 1; 2241 PageResponse page = 2; 2242 } 2243 cosmos.base.v1beta1.Coin: 2244 type: object 2245 properties: 2246 denom: 2247 type: string 2248 amount: 2249 type: string 2250 description: |- 2251 Coin defines a token with a denomination and an amount. 2252 2253 NOTE: The amount field is an Int which implements the custom method 2254 signatures required by gogoproto. 2255 google.protobuf.Any: 2256 type: object 2257 properties: 2258 type_url: 2259 type: string 2260 value: 2261 type: string 2262 format: byte 2263 grpc.gateway.runtime.Error: 2264 type: object 2265 properties: 2266 error: 2267 type: string 2268 code: 2269 type: integer 2270 format: int32 2271 message: 2272 type: string 2273 details: 2274 type: array 2275 items: 2276 type: object 2277 properties: 2278 type_url: 2279 type: string 2280 value: 2281 type: string 2282 format: byte 2283 tendermint.liquidity.v1beta1.DepositMsgState: 2284 type: object 2285 properties: 2286 msg_height: 2287 type: string 2288 format: int64 2289 example: '1000' 2290 title: height where this message is appended to the batch 2291 msg_index: 2292 type: string 2293 format: uint64 2294 example: '1' 2295 title: index of this deposit message in this liquidity pool 2296 executed: 2297 type: boolean 2298 example: true 2299 title: 'true if executed on this batch, false if not executed' 2300 succeeded: 2301 type: boolean 2302 example: true 2303 title: 'true if executed successfully on this batch, false if failed' 2304 to_be_deleted: 2305 type: boolean 2306 example: true 2307 title: >- 2308 true if ready to be deleted on kvstore, false if not ready to be 2309 deleted 2310 msg: 2311 title: MsgDepositWithinBatch 2312 type: object 2313 properties: 2314 depositor_address: 2315 type: string 2316 format: sdk.AccAddress 2317 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 2318 description: account address of the origin of this message 2319 pool_id: 2320 type: string 2321 format: uint64 2322 example: '1' 2323 title: id of the target pool 2324 deposit_coins: 2325 type: array 2326 format: sdk.Coins 2327 example: 2328 - denom: denomX 2329 amount: '1000000' 2330 - denom: denomY 2331 amount: '2000000' 2332 items: 2333 type: object 2334 properties: 2335 denom: 2336 type: string 2337 amount: 2338 type: string 2339 description: >- 2340 Coin defines a token with a denomination and an amount. 2341 2342 2343 NOTE: The amount field is an Int which implements the custom 2344 method 2345 2346 signatures required by gogoproto. 2347 title: reserve coin pair of the pool to deposit 2348 description: >- 2349 `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports 2350 submitting 2351 2352 a deposit request to the batch of the liquidity pool. 2353 2354 Deposit is submitted to the batch of the Liquidity pool with the 2355 specified 2356 2357 `pool_id`, `deposit_coins` for reserve. 2358 2359 This request is stacked in the batch of the liquidity pool, is not 2360 processed 2361 2362 immediately, and is processed in the `endblock` at the same time as 2363 other requests. 2364 2365 2366 See: 2367 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 2368 description: >- 2369 DepositMsgState defines the state of deposit message that contains state 2370 information as it is processed in the next batch or batches. 2371 tendermint.liquidity.v1beta1.MsgDepositWithinBatch: 2372 type: object 2373 properties: 2374 depositor_address: 2375 type: string 2376 format: sdk.AccAddress 2377 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 2378 description: account address of the origin of this message 2379 pool_id: 2380 type: string 2381 format: uint64 2382 example: '1' 2383 title: id of the target pool 2384 deposit_coins: 2385 type: array 2386 format: sdk.Coins 2387 example: 2388 - denom: denomX 2389 amount: '1000000' 2390 - denom: denomY 2391 amount: '2000000' 2392 items: 2393 type: object 2394 properties: 2395 denom: 2396 type: string 2397 amount: 2398 type: string 2399 description: |- 2400 Coin defines a token with a denomination and an amount. 2401 2402 NOTE: The amount field is an Int which implements the custom method 2403 signatures required by gogoproto. 2404 title: reserve coin pair of the pool to deposit 2405 description: >- 2406 `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports 2407 submitting 2408 2409 a deposit request to the batch of the liquidity pool. 2410 2411 Deposit is submitted to the batch of the Liquidity pool with the 2412 specified 2413 2414 `pool_id`, `deposit_coins` for reserve. 2415 2416 This request is stacked in the batch of the liquidity pool, is not 2417 processed 2418 2419 immediately, and is processed in the `endblock` at the same time as other 2420 requests. 2421 2422 2423 See: 2424 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 2425 tendermint.liquidity.v1beta1.MsgSwapWithinBatch: 2426 type: object 2427 properties: 2428 swap_requester_address: 2429 type: string 2430 format: sdk.AccAddress 2431 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 2432 description: account address of the origin of this message 2433 title: address of swap requester 2434 pool_id: 2435 type: string 2436 format: uint64 2437 example: '1' 2438 description: >- 2439 id of swap type, must match the value in the pool. Only `swap_type_id` 2440 1 is supported. 2441 swap_type_id: 2442 type: integer 2443 format: uint32 2444 example: '1' 2445 description: id of swap type. Must match the value in the pool. 2446 offer_coin: 2447 type: object 2448 properties: 2449 denom: 2450 type: string 2451 amount: 2452 type: string 2453 description: |- 2454 Coin defines a token with a denomination and an amount. 2455 2456 NOTE: The amount field is an Int which implements the custom method 2457 signatures required by gogoproto. 2458 format: sdk.Coin 2459 example: 2460 denom: denomX 2461 amount: '1000000' 2462 demand_coin_denom: 2463 type: string 2464 example: denomB 2465 description: >- 2466 denom of demand coin to be exchanged on the swap request, must match 2467 the denom in the pool. 2468 offer_coin_fee: 2469 type: object 2470 properties: 2471 denom: 2472 type: string 2473 amount: 2474 type: string 2475 description: |- 2476 Coin defines a token with a denomination and an amount. 2477 2478 NOTE: The amount field is an Int which implements the custom method 2479 signatures required by gogoproto. 2480 format: sdk.Coin 2481 example: 2482 denom: denomX 2483 amount: '5000' 2484 order_price: 2485 type: string 2486 format: sdk.Dec 2487 example: '1.1' 2488 description: >- 2489 limit order price for the order, the price is the exchange ratio of 2490 X/Y 2491 2492 where X is the amount of the first coin and Y is the amount 2493 2494 of the second coin when their denoms are sorted alphabetically. 2495 description: >- 2496 `MsgSwapWithinBatch` defines an sdk.Msg type that supports submitting a 2497 swap offer request to the batch of the liquidity pool. 2498 2499 Submit swap offer to the liquidity pool batch with the specified the 2500 `pool_id`, `swap_type_id`, 2501 2502 `demand_coin_denom` with the coin and the price you're offering 2503 2504 and `offer_coin_fee` must be half of offer coin amount * current 2505 `params.swap_fee_rate` and ceil for reservation to pay fees. 2506 2507 This request is stacked in the batch of the liquidity pool, is not 2508 processed 2509 2510 immediately, and is processed in the `endblock` at the same time as other 2511 requests. 2512 2513 You must request the same fields as the pool. 2514 2515 Only the default `swap_type_id` 1 is supported. 2516 2517 2518 See: https://github.com/gravity-devs/liquidity/tree/develop/doc 2519 2520 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 2521 tendermint.liquidity.v1beta1.MsgWithdrawWithinBatch: 2522 type: object 2523 properties: 2524 withdrawer_address: 2525 type: string 2526 format: sdk.AccAddress 2527 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 2528 description: account address of the origin of this message 2529 pool_id: 2530 type: string 2531 format: uint64 2532 example: '1' 2533 title: id of the target pool 2534 pool_coin: 2535 type: object 2536 properties: 2537 denom: 2538 type: string 2539 amount: 2540 type: string 2541 description: |- 2542 Coin defines a token with a denomination and an amount. 2543 2544 NOTE: The amount field is an Int which implements the custom method 2545 signatures required by gogoproto. 2546 format: sdk.Coin 2547 example: 2548 denom: poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 2549 amount: '1000' 2550 description: >- 2551 `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that supports 2552 submitting 2553 2554 a withdraw request to the batch of the liquidity pool. 2555 2556 Withdraw is submitted to the batch from the Liquidity pool with the 2557 2558 specified `pool_id`, `pool_coin` of the pool. 2559 2560 This request is stacked in the batch of the liquidity pool, is not 2561 processed 2562 2563 immediately, and is processed in the `endblock` at the same time as other 2564 requests. 2565 2566 2567 See: 2568 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 2569 tendermint.liquidity.v1beta1.Params: 2570 type: object 2571 properties: 2572 pool_types: 2573 type: array 2574 items: 2575 type: object 2576 properties: 2577 id: 2578 type: integer 2579 format: uint32 2580 example: '1' 2581 title: >- 2582 This is the id of the pool_type that is used as pool_type_id for 2583 pool creation. 2584 2585 In this version, only pool-type-id 1 is supported. 2586 2587 {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""} 2588 name: 2589 type: string 2590 example: ConstantProductLiquidityPool 2591 description: name of the pool type. 2592 min_reserve_coin_num: 2593 type: integer 2594 format: uint32 2595 example: '2' 2596 description: >- 2597 minimum number of reserveCoins for LiquidityPoolType, only 2 2598 reserve coins are supported. 2599 max_reserve_coin_num: 2600 type: integer 2601 format: uint32 2602 example: '2' 2603 description: >- 2604 maximum number of reserveCoins for LiquidityPoolType, only 2 2605 reserve coins are supported. 2606 description: 2607 type: string 2608 description: description of the pool type. 2609 description: >- 2610 Structure for the pool type to distinguish the characteristics of 2611 the reserve pools. 2612 title: list of available pool types 2613 min_init_deposit_amount: 2614 type: string 2615 format: sdk.Int 2616 example: '1000000' 2617 description: >- 2618 Minimum number of coins to be deposited to the liquidity pool on pool 2619 creation. 2620 init_pool_coin_mint_amount: 2621 type: string 2622 format: sdk.Int 2623 example: '1000000' 2624 description: Initial mint amount of pool coins upon pool creation. 2625 max_reserve_coin_amount: 2626 type: string 2627 format: sdk.Int 2628 example: '1000000000000' 2629 description: >- 2630 Limit the size of each liquidity pool to minimize risk. In 2631 development, set to 0 for no limit. In production, set a limit. 2632 pool_creation_fee: 2633 type: array 2634 format: sdk.Coins 2635 example: 2636 - denom: uatom 2637 amount: '100000000' 2638 items: 2639 type: object 2640 properties: 2641 denom: 2642 type: string 2643 amount: 2644 type: string 2645 description: |- 2646 Coin defines a token with a denomination and an amount. 2647 2648 NOTE: The amount field is an Int which implements the custom method 2649 signatures required by gogoproto. 2650 description: Fee paid to create a Liquidity Pool. Set a fee to prevent spamming. 2651 swap_fee_rate: 2652 type: string 2653 format: sdk.Dec 2654 example: '0.003' 2655 description: Swap fee rate for every executed swap. 2656 withdraw_fee_rate: 2657 type: string 2658 format: sdk.Dec 2659 example: '0.003' 2660 description: Reserve coin withdrawal with less proportion by withdrawFeeRate. 2661 max_order_amount_ratio: 2662 type: string 2663 format: sdk.Dec 2664 example: '0.003' 2665 description: Maximum ratio of reserve coins that can be ordered at a swap order. 2666 unit_batch_height: 2667 type: integer 2668 format: uint32 2669 example: '1' 2670 description: The smallest unit batch height for every liquidity pool. 2671 circuit_breaker_enabled: 2672 type: boolean 2673 format: bool 2674 example: 'false' 2675 description: >- 2676 Circuit breaker enables or disables transaction messages in liquidity 2677 module. 2678 description: Params defines the parameters for the liquidity module. 2679 tendermint.liquidity.v1beta1.Pool: 2680 type: object 2681 properties: 2682 id: 2683 type: string 2684 format: uint64 2685 example: '1' 2686 title: id of the pool 2687 type_id: 2688 type: integer 2689 format: uint32 2690 example: '1' 2691 title: id of the pool_type 2692 reserve_coin_denoms: 2693 type: array 2694 example: 2695 - denomX 2696 - denomY 2697 items: 2698 type: string 2699 title: denoms of reserve coin pair of the pool 2700 reserve_account_address: 2701 type: string 2702 format: sdk.AccAddress 2703 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 2704 title: reserve account address of the pool 2705 pool_coin_denom: 2706 type: string 2707 example: poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 2708 title: denom of pool coin of the pool 2709 description: Pool defines the liquidity pool that contains pool information. 2710 tendermint.liquidity.v1beta1.PoolBatch: 2711 type: object 2712 properties: 2713 pool_id: 2714 type: string 2715 format: uint64 2716 example: '1' 2717 title: id of the pool 2718 index: 2719 type: string 2720 format: uint64 2721 example: '1' 2722 title: index of this batch 2723 begin_height: 2724 type: string 2725 format: int64 2726 example: '1000' 2727 title: height where this batch is started 2728 deposit_msg_index: 2729 type: string 2730 format: uint64 2731 example: '1' 2732 title: last index of DepositMsgStates 2733 withdraw_msg_index: 2734 type: string 2735 format: uint64 2736 example: '1' 2737 title: last index of WithdrawMsgStates 2738 swap_msg_index: 2739 type: string 2740 format: uint64 2741 example: '1' 2742 title: last index of SwapMsgStates 2743 executed: 2744 type: boolean 2745 example: true 2746 title: 'true if executed, false if not executed' 2747 description: >- 2748 PoolBatch defines the batch or batches of a given liquidity pool that 2749 contains indexes of deposit, withdraw, and swap messages. 2750 2751 Index param increments by 1 if the pool id is same. 2752 tendermint.liquidity.v1beta1.PoolType: 2753 type: object 2754 properties: 2755 id: 2756 type: integer 2757 format: uint32 2758 example: '1' 2759 title: >- 2760 This is the id of the pool_type that is used as pool_type_id for pool 2761 creation. 2762 2763 In this version, only pool-type-id 1 is supported. 2764 2765 {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""} 2766 name: 2767 type: string 2768 example: ConstantProductLiquidityPool 2769 description: name of the pool type. 2770 min_reserve_coin_num: 2771 type: integer 2772 format: uint32 2773 example: '2' 2774 description: >- 2775 minimum number of reserveCoins for LiquidityPoolType, only 2 reserve 2776 coins are supported. 2777 max_reserve_coin_num: 2778 type: integer 2779 format: uint32 2780 example: '2' 2781 description: >- 2782 maximum number of reserveCoins for LiquidityPoolType, only 2 reserve 2783 coins are supported. 2784 description: 2785 type: string 2786 description: description of the pool type. 2787 description: >- 2788 Structure for the pool type to distinguish the characteristics of the 2789 reserve pools. 2790 tendermint.liquidity.v1beta1.QueryLiquidityPoolBatchResponse: 2791 type: object 2792 properties: 2793 batch: 2794 type: object 2795 properties: 2796 pool_id: 2797 type: string 2798 format: uint64 2799 example: '1' 2800 title: id of the pool 2801 index: 2802 type: string 2803 format: uint64 2804 example: '1' 2805 title: index of this batch 2806 begin_height: 2807 type: string 2808 format: int64 2809 example: '1000' 2810 title: height where this batch is started 2811 deposit_msg_index: 2812 type: string 2813 format: uint64 2814 example: '1' 2815 title: last index of DepositMsgStates 2816 withdraw_msg_index: 2817 type: string 2818 format: uint64 2819 example: '1' 2820 title: last index of WithdrawMsgStates 2821 swap_msg_index: 2822 type: string 2823 format: uint64 2824 example: '1' 2825 title: last index of SwapMsgStates 2826 executed: 2827 type: boolean 2828 example: true 2829 title: 'true if executed, false if not executed' 2830 description: >- 2831 PoolBatch defines the batch or batches of a given liquidity pool that 2832 contains indexes of deposit, withdraw, and swap messages. 2833 2834 Index param increments by 1 if the pool id is same. 2835 description: >- 2836 the response type for the QueryLiquidityPoolBatchResponse RPC method. 2837 Returns the liquidity pool batch that corresponds to the requested 2838 pool_id. 2839 tendermint.liquidity.v1beta1.QueryLiquidityPoolResponse: 2840 type: object 2841 properties: 2842 pool: 2843 type: object 2844 properties: 2845 id: 2846 type: string 2847 format: uint64 2848 example: '1' 2849 title: id of the pool 2850 type_id: 2851 type: integer 2852 format: uint32 2853 example: '1' 2854 title: id of the pool_type 2855 reserve_coin_denoms: 2856 type: array 2857 example: 2858 - denomX 2859 - denomY 2860 items: 2861 type: string 2862 title: denoms of reserve coin pair of the pool 2863 reserve_account_address: 2864 type: string 2865 format: sdk.AccAddress 2866 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 2867 title: reserve account address of the pool 2868 pool_coin_denom: 2869 type: string 2870 example: >- 2871 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 2872 title: denom of pool coin of the pool 2873 description: Pool defines the liquidity pool that contains pool information. 2874 description: >- 2875 the response type for the QueryLiquidityPoolResponse RPC method. Returns 2876 the liquidity pool that corresponds to the requested pool_id. 2877 tendermint.liquidity.v1beta1.QueryLiquidityPoolsResponse: 2878 type: object 2879 properties: 2880 pools: 2881 type: array 2882 items: 2883 type: object 2884 properties: 2885 id: 2886 type: string 2887 format: uint64 2888 example: '1' 2889 title: id of the pool 2890 type_id: 2891 type: integer 2892 format: uint32 2893 example: '1' 2894 title: id of the pool_type 2895 reserve_coin_denoms: 2896 type: array 2897 example: 2898 - denomX 2899 - denomY 2900 items: 2901 type: string 2902 title: denoms of reserve coin pair of the pool 2903 reserve_account_address: 2904 type: string 2905 format: sdk.AccAddress 2906 example: cosmos16ddqestwukv0jzcyfn3fdfq9h2wrs83cr4rfm3 2907 title: reserve account address of the pool 2908 pool_coin_denom: 2909 type: string 2910 example: >- 2911 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 2912 title: denom of pool coin of the pool 2913 description: Pool defines the liquidity pool that contains pool information. 2914 pagination: 2915 description: >- 2916 pagination defines the pagination in the response. not working on this 2917 version. 2918 type: object 2919 properties: 2920 next_key: 2921 type: string 2922 format: byte 2923 title: |- 2924 next_key is the key to be passed to PageRequest.key to 2925 query the next page most efficiently 2926 total: 2927 type: string 2928 format: uint64 2929 title: >- 2930 total is total number of results available if 2931 PageRequest.count_total 2932 2933 was set, its value is undefined otherwise 2934 description: >- 2935 the response type for the QueryLiquidityPoolsResponse RPC method. This 2936 includes a list of all existing liquidity pools and paging results that 2937 contain next_key and total count. 2938 tendermint.liquidity.v1beta1.QueryParamsResponse: 2939 type: object 2940 properties: 2941 params: 2942 description: params holds all the parameters of this module. 2943 type: object 2944 properties: 2945 pool_types: 2946 type: array 2947 items: 2948 type: object 2949 properties: 2950 id: 2951 type: integer 2952 format: uint32 2953 example: '1' 2954 title: >- 2955 This is the id of the pool_type that is used as pool_type_id 2956 for pool creation. 2957 2958 In this version, only pool-type-id 1 is supported. 2959 2960 {"id":1,"name":"ConstantProductLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":""} 2961 name: 2962 type: string 2963 example: ConstantProductLiquidityPool 2964 description: name of the pool type. 2965 min_reserve_coin_num: 2966 type: integer 2967 format: uint32 2968 example: '2' 2969 description: >- 2970 minimum number of reserveCoins for LiquidityPoolType, only 2 2971 reserve coins are supported. 2972 max_reserve_coin_num: 2973 type: integer 2974 format: uint32 2975 example: '2' 2976 description: >- 2977 maximum number of reserveCoins for LiquidityPoolType, only 2 2978 reserve coins are supported. 2979 description: 2980 type: string 2981 description: description of the pool type. 2982 description: >- 2983 Structure for the pool type to distinguish the characteristics 2984 of the reserve pools. 2985 title: list of available pool types 2986 min_init_deposit_amount: 2987 type: string 2988 format: sdk.Int 2989 example: '1000000' 2990 description: >- 2991 Minimum number of coins to be deposited to the liquidity pool on 2992 pool creation. 2993 init_pool_coin_mint_amount: 2994 type: string 2995 format: sdk.Int 2996 example: '1000000' 2997 description: Initial mint amount of pool coins upon pool creation. 2998 max_reserve_coin_amount: 2999 type: string 3000 format: sdk.Int 3001 example: '1000000000000' 3002 description: >- 3003 Limit the size of each liquidity pool to minimize risk. In 3004 development, set to 0 for no limit. In production, set a limit. 3005 pool_creation_fee: 3006 type: array 3007 format: sdk.Coins 3008 example: 3009 - denom: uatom 3010 amount: '100000000' 3011 items: 3012 type: object 3013 properties: 3014 denom: 3015 type: string 3016 amount: 3017 type: string 3018 description: >- 3019 Coin defines a token with a denomination and an amount. 3020 3021 3022 NOTE: The amount field is an Int which implements the custom 3023 method 3024 3025 signatures required by gogoproto. 3026 description: >- 3027 Fee paid to create a Liquidity Pool. Set a fee to prevent 3028 spamming. 3029 swap_fee_rate: 3030 type: string 3031 format: sdk.Dec 3032 example: '0.003' 3033 description: Swap fee rate for every executed swap. 3034 withdraw_fee_rate: 3035 type: string 3036 format: sdk.Dec 3037 example: '0.003' 3038 description: Reserve coin withdrawal with less proportion by withdrawFeeRate. 3039 max_order_amount_ratio: 3040 type: string 3041 format: sdk.Dec 3042 example: '0.003' 3043 description: >- 3044 Maximum ratio of reserve coins that can be ordered at a swap 3045 order. 3046 unit_batch_height: 3047 type: integer 3048 format: uint32 3049 example: '1' 3050 description: The smallest unit batch height for every liquidity pool. 3051 circuit_breaker_enabled: 3052 type: boolean 3053 format: bool 3054 example: 'false' 3055 description: >- 3056 Circuit breaker enables or disables transaction messages in 3057 liquidity module. 3058 description: >- 3059 the response type for the QueryParamsResponse RPC method. This includes 3060 current parameter of the liquidity module. 3061 tendermint.liquidity.v1beta1.QueryPoolBatchDepositMsgResponse: 3062 type: object 3063 properties: 3064 deposit: 3065 type: object 3066 properties: 3067 msg_height: 3068 type: string 3069 format: int64 3070 example: '1000' 3071 title: height where this message is appended to the batch 3072 msg_index: 3073 type: string 3074 format: uint64 3075 example: '1' 3076 title: index of this deposit message in this liquidity pool 3077 executed: 3078 type: boolean 3079 example: true 3080 title: 'true if executed on this batch, false if not executed' 3081 succeeded: 3082 type: boolean 3083 example: true 3084 title: 'true if executed successfully on this batch, false if failed' 3085 to_be_deleted: 3086 type: boolean 3087 example: true 3088 title: >- 3089 true if ready to be deleted on kvstore, false if not ready to be 3090 deleted 3091 msg: 3092 title: MsgDepositWithinBatch 3093 type: object 3094 properties: 3095 depositor_address: 3096 type: string 3097 format: sdk.AccAddress 3098 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 3099 description: account address of the origin of this message 3100 pool_id: 3101 type: string 3102 format: uint64 3103 example: '1' 3104 title: id of the target pool 3105 deposit_coins: 3106 type: array 3107 format: sdk.Coins 3108 example: 3109 - denom: denomX 3110 amount: '1000000' 3111 - denom: denomY 3112 amount: '2000000' 3113 items: 3114 type: object 3115 properties: 3116 denom: 3117 type: string 3118 amount: 3119 type: string 3120 description: >- 3121 Coin defines a token with a denomination and an amount. 3122 3123 3124 NOTE: The amount field is an Int which implements the custom 3125 method 3126 3127 signatures required by gogoproto. 3128 title: reserve coin pair of the pool to deposit 3129 description: >- 3130 `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports 3131 submitting 3132 3133 a deposit request to the batch of the liquidity pool. 3134 3135 Deposit is submitted to the batch of the Liquidity pool with the 3136 specified 3137 3138 `pool_id`, `deposit_coins` for reserve. 3139 3140 This request is stacked in the batch of the liquidity pool, is not 3141 processed 3142 3143 immediately, and is processed in the `endblock` at the same time 3144 as other requests. 3145 3146 3147 See: 3148 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 3149 description: >- 3150 DepositMsgState defines the state of deposit message that contains 3151 state information as it is processed in the next batch or batches. 3152 description: >- 3153 the response type for the QueryPoolBatchDepositMsg RPC method. This 3154 includes a batch swap message of the batch. 3155 tendermint.liquidity.v1beta1.QueryPoolBatchDepositMsgsResponse: 3156 type: object 3157 properties: 3158 deposits: 3159 type: array 3160 items: 3161 type: object 3162 properties: 3163 msg_height: 3164 type: string 3165 format: int64 3166 example: '1000' 3167 title: height where this message is appended to the batch 3168 msg_index: 3169 type: string 3170 format: uint64 3171 example: '1' 3172 title: index of this deposit message in this liquidity pool 3173 executed: 3174 type: boolean 3175 example: true 3176 title: 'true if executed on this batch, false if not executed' 3177 succeeded: 3178 type: boolean 3179 example: true 3180 title: 'true if executed successfully on this batch, false if failed' 3181 to_be_deleted: 3182 type: boolean 3183 example: true 3184 title: >- 3185 true if ready to be deleted on kvstore, false if not ready to be 3186 deleted 3187 msg: 3188 title: MsgDepositWithinBatch 3189 type: object 3190 properties: 3191 depositor_address: 3192 type: string 3193 format: sdk.AccAddress 3194 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 3195 description: account address of the origin of this message 3196 pool_id: 3197 type: string 3198 format: uint64 3199 example: '1' 3200 title: id of the target pool 3201 deposit_coins: 3202 type: array 3203 format: sdk.Coins 3204 example: 3205 - denom: denomX 3206 amount: '1000000' 3207 - denom: denomY 3208 amount: '2000000' 3209 items: 3210 type: object 3211 properties: 3212 denom: 3213 type: string 3214 amount: 3215 type: string 3216 description: >- 3217 Coin defines a token with a denomination and an amount. 3218 3219 3220 NOTE: The amount field is an Int which implements the 3221 custom method 3222 3223 signatures required by gogoproto. 3224 title: reserve coin pair of the pool to deposit 3225 description: >- 3226 `MsgDepositWithinBatch defines` an `sdk.Msg` type that supports 3227 submitting 3228 3229 a deposit request to the batch of the liquidity pool. 3230 3231 Deposit is submitted to the batch of the Liquidity pool with the 3232 specified 3233 3234 `pool_id`, `deposit_coins` for reserve. 3235 3236 This request is stacked in the batch of the liquidity pool, is 3237 not processed 3238 3239 immediately, and is processed in the `endblock` at the same time 3240 as other requests. 3241 3242 3243 See: 3244 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 3245 description: >- 3246 DepositMsgState defines the state of deposit message that contains 3247 state information as it is processed in the next batch or batches. 3248 pagination: 3249 description: >- 3250 pagination defines the pagination in the response. not working on this 3251 version. 3252 type: object 3253 properties: 3254 next_key: 3255 type: string 3256 format: byte 3257 title: |- 3258 next_key is the key to be passed to PageRequest.key to 3259 query the next page most efficiently 3260 total: 3261 type: string 3262 format: uint64 3263 title: >- 3264 total is total number of results available if 3265 PageRequest.count_total 3266 3267 was set, its value is undefined otherwise 3268 description: >- 3269 the response type for the QueryPoolBatchDeposit RPC method. This includes 3270 a list of all currently existing deposit messages of the batch and paging 3271 results that contain next_key and total count. 3272 tendermint.liquidity.v1beta1.QueryPoolBatchSwapMsgResponse: 3273 type: object 3274 properties: 3275 swap: 3276 type: object 3277 properties: 3278 msg_height: 3279 type: string 3280 format: int64 3281 example: '1000' 3282 title: height where this message is appended to the batch 3283 msg_index: 3284 type: string 3285 format: uint64 3286 example: '1' 3287 title: index of this swap message in this liquidity pool 3288 executed: 3289 type: boolean 3290 example: true 3291 title: 'true if executed on this batch, false if not executed' 3292 succeeded: 3293 type: boolean 3294 example: true 3295 title: 'true if executed successfully on this batch, false if failed' 3296 to_be_deleted: 3297 type: boolean 3298 example: true 3299 title: >- 3300 true if ready to be deleted on kvstore, false if not ready to be 3301 deleted 3302 order_expiry_height: 3303 type: string 3304 format: int64 3305 example: '1000' 3306 title: >- 3307 swap orders are cancelled when current height is equal to or 3308 higher than ExpiryHeight 3309 exchanged_offer_coin: 3310 type: object 3311 properties: 3312 denom: 3313 type: string 3314 amount: 3315 type: string 3316 description: >- 3317 Coin defines a token with a denomination and an amount. 3318 3319 3320 NOTE: The amount field is an Int which implements the custom 3321 method 3322 3323 signatures required by gogoproto. 3324 format: sdk.Coin 3325 example: 3326 denom: denomX 3327 amount: '600000' 3328 title: offer coin exchanged until now 3329 remaining_offer_coin: 3330 type: object 3331 properties: 3332 denom: 3333 type: string 3334 amount: 3335 type: string 3336 description: >- 3337 Coin defines a token with a denomination and an amount. 3338 3339 3340 NOTE: The amount field is an Int which implements the custom 3341 method 3342 3343 signatures required by gogoproto. 3344 format: sdk.Coin 3345 example: 3346 denom: denomX 3347 amount: '400000' 3348 title: offer coin currently remaining to be exchanged 3349 reserved_offer_coin_fee: 3350 type: object 3351 properties: 3352 denom: 3353 type: string 3354 amount: 3355 type: string 3356 description: >- 3357 Coin defines a token with a denomination and an amount. 3358 3359 3360 NOTE: The amount field is an Int which implements the custom 3361 method 3362 3363 signatures required by gogoproto. 3364 format: sdk.Coin 3365 example: 3366 denom: denomX 3367 amount: '5000' 3368 title: reserve fee for pays fee in half offer coin 3369 msg: 3370 title: MsgSwapWithinBatch 3371 type: object 3372 properties: 3373 swap_requester_address: 3374 type: string 3375 format: sdk.AccAddress 3376 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 3377 description: account address of the origin of this message 3378 title: address of swap requester 3379 pool_id: 3380 type: string 3381 format: uint64 3382 example: '1' 3383 description: >- 3384 id of swap type, must match the value in the pool. Only 3385 `swap_type_id` 1 is supported. 3386 swap_type_id: 3387 type: integer 3388 format: uint32 3389 example: '1' 3390 description: id of swap type. Must match the value in the pool. 3391 offer_coin: 3392 type: object 3393 properties: 3394 denom: 3395 type: string 3396 amount: 3397 type: string 3398 description: >- 3399 Coin defines a token with a denomination and an amount. 3400 3401 3402 NOTE: The amount field is an Int which implements the custom 3403 method 3404 3405 signatures required by gogoproto. 3406 format: sdk.Coin 3407 example: 3408 denom: denomX 3409 amount: '1000000' 3410 demand_coin_denom: 3411 type: string 3412 example: denomB 3413 description: >- 3414 denom of demand coin to be exchanged on the swap request, must 3415 match the denom in the pool. 3416 offer_coin_fee: 3417 type: object 3418 properties: 3419 denom: 3420 type: string 3421 amount: 3422 type: string 3423 description: >- 3424 Coin defines a token with a denomination and an amount. 3425 3426 3427 NOTE: The amount field is an Int which implements the custom 3428 method 3429 3430 signatures required by gogoproto. 3431 format: sdk.Coin 3432 example: 3433 denom: denomX 3434 amount: '5000' 3435 order_price: 3436 type: string 3437 format: sdk.Dec 3438 example: '1.1' 3439 description: >- 3440 limit order price for the order, the price is the exchange 3441 ratio of X/Y 3442 3443 where X is the amount of the first coin and Y is the amount 3444 3445 of the second coin when their denoms are sorted 3446 alphabetically. 3447 description: >- 3448 `MsgSwapWithinBatch` defines an sdk.Msg type that supports 3449 submitting a swap offer request to the batch of the liquidity 3450 pool. 3451 3452 Submit swap offer to the liquidity pool batch with the specified 3453 the `pool_id`, `swap_type_id`, 3454 3455 `demand_coin_denom` with the coin and the price you're offering 3456 3457 and `offer_coin_fee` must be half of offer coin amount * current 3458 `params.swap_fee_rate` and ceil for reservation to pay fees. 3459 3460 This request is stacked in the batch of the liquidity pool, is not 3461 processed 3462 3463 immediately, and is processed in the `endblock` at the same time 3464 as other requests. 3465 3466 You must request the same fields as the pool. 3467 3468 Only the default `swap_type_id` 1 is supported. 3469 3470 3471 See: https://github.com/gravity-devs/liquidity/tree/develop/doc 3472 3473 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 3474 description: >- 3475 SwapMsgState defines the state of the swap message that contains state 3476 information as the message is processed in the next batch or batches. 3477 description: >- 3478 the response type for the QueryPoolBatchSwapMsg RPC method. This includes 3479 a batch swap message of the batch. 3480 tendermint.liquidity.v1beta1.QueryPoolBatchSwapMsgsResponse: 3481 type: object 3482 properties: 3483 swaps: 3484 type: array 3485 items: 3486 type: object 3487 properties: 3488 msg_height: 3489 type: string 3490 format: int64 3491 example: '1000' 3492 title: height where this message is appended to the batch 3493 msg_index: 3494 type: string 3495 format: uint64 3496 example: '1' 3497 title: index of this swap message in this liquidity pool 3498 executed: 3499 type: boolean 3500 example: true 3501 title: 'true if executed on this batch, false if not executed' 3502 succeeded: 3503 type: boolean 3504 example: true 3505 title: 'true if executed successfully on this batch, false if failed' 3506 to_be_deleted: 3507 type: boolean 3508 example: true 3509 title: >- 3510 true if ready to be deleted on kvstore, false if not ready to be 3511 deleted 3512 order_expiry_height: 3513 type: string 3514 format: int64 3515 example: '1000' 3516 title: >- 3517 swap orders are cancelled when current height is equal to or 3518 higher than ExpiryHeight 3519 exchanged_offer_coin: 3520 type: object 3521 properties: 3522 denom: 3523 type: string 3524 amount: 3525 type: string 3526 description: >- 3527 Coin defines a token with a denomination and an amount. 3528 3529 3530 NOTE: The amount field is an Int which implements the custom 3531 method 3532 3533 signatures required by gogoproto. 3534 format: sdk.Coin 3535 example: 3536 denom: denomX 3537 amount: '600000' 3538 title: offer coin exchanged until now 3539 remaining_offer_coin: 3540 type: object 3541 properties: 3542 denom: 3543 type: string 3544 amount: 3545 type: string 3546 description: >- 3547 Coin defines a token with a denomination and an amount. 3548 3549 3550 NOTE: The amount field is an Int which implements the custom 3551 method 3552 3553 signatures required by gogoproto. 3554 format: sdk.Coin 3555 example: 3556 denom: denomX 3557 amount: '400000' 3558 title: offer coin currently remaining to be exchanged 3559 reserved_offer_coin_fee: 3560 type: object 3561 properties: 3562 denom: 3563 type: string 3564 amount: 3565 type: string 3566 description: >- 3567 Coin defines a token with a denomination and an amount. 3568 3569 3570 NOTE: The amount field is an Int which implements the custom 3571 method 3572 3573 signatures required by gogoproto. 3574 format: sdk.Coin 3575 example: 3576 denom: denomX 3577 amount: '5000' 3578 title: reserve fee for pays fee in half offer coin 3579 msg: 3580 title: MsgSwapWithinBatch 3581 type: object 3582 properties: 3583 swap_requester_address: 3584 type: string 3585 format: sdk.AccAddress 3586 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 3587 description: account address of the origin of this message 3588 title: address of swap requester 3589 pool_id: 3590 type: string 3591 format: uint64 3592 example: '1' 3593 description: >- 3594 id of swap type, must match the value in the pool. Only 3595 `swap_type_id` 1 is supported. 3596 swap_type_id: 3597 type: integer 3598 format: uint32 3599 example: '1' 3600 description: id of swap type. Must match the value in the pool. 3601 offer_coin: 3602 type: object 3603 properties: 3604 denom: 3605 type: string 3606 amount: 3607 type: string 3608 description: >- 3609 Coin defines a token with a denomination and an amount. 3610 3611 3612 NOTE: The amount field is an Int which implements the custom 3613 method 3614 3615 signatures required by gogoproto. 3616 format: sdk.Coin 3617 example: 3618 denom: denomX 3619 amount: '1000000' 3620 demand_coin_denom: 3621 type: string 3622 example: denomB 3623 description: >- 3624 denom of demand coin to be exchanged on the swap request, 3625 must match the denom in the pool. 3626 offer_coin_fee: 3627 type: object 3628 properties: 3629 denom: 3630 type: string 3631 amount: 3632 type: string 3633 description: >- 3634 Coin defines a token with a denomination and an amount. 3635 3636 3637 NOTE: The amount field is an Int which implements the custom 3638 method 3639 3640 signatures required by gogoproto. 3641 format: sdk.Coin 3642 example: 3643 denom: denomX 3644 amount: '5000' 3645 order_price: 3646 type: string 3647 format: sdk.Dec 3648 example: '1.1' 3649 description: >- 3650 limit order price for the order, the price is the exchange 3651 ratio of X/Y 3652 3653 where X is the amount of the first coin and Y is the amount 3654 3655 of the second coin when their denoms are sorted 3656 alphabetically. 3657 description: >- 3658 `MsgSwapWithinBatch` defines an sdk.Msg type that supports 3659 submitting a swap offer request to the batch of the liquidity 3660 pool. 3661 3662 Submit swap offer to the liquidity pool batch with the specified 3663 the `pool_id`, `swap_type_id`, 3664 3665 `demand_coin_denom` with the coin and the price you're offering 3666 3667 and `offer_coin_fee` must be half of offer coin amount * current 3668 `params.swap_fee_rate` and ceil for reservation to pay fees. 3669 3670 This request is stacked in the batch of the liquidity pool, is 3671 not processed 3672 3673 immediately, and is processed in the `endblock` at the same time 3674 as other requests. 3675 3676 You must request the same fields as the pool. 3677 3678 Only the default `swap_type_id` 1 is supported. 3679 3680 3681 See: https://github.com/gravity-devs/liquidity/tree/develop/doc 3682 3683 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 3684 description: >- 3685 SwapMsgState defines the state of the swap message that contains 3686 state information as the message is processed in the next batch or 3687 batches. 3688 pagination: 3689 description: >- 3690 pagination defines the pagination in the response. not working on this 3691 version. 3692 type: object 3693 properties: 3694 next_key: 3695 type: string 3696 format: byte 3697 title: |- 3698 next_key is the key to be passed to PageRequest.key to 3699 query the next page most efficiently 3700 total: 3701 type: string 3702 format: uint64 3703 title: >- 3704 total is total number of results available if 3705 PageRequest.count_total 3706 3707 was set, its value is undefined otherwise 3708 description: >- 3709 the response type for the QueryPoolBatchSwapMsgs RPC method. This includes 3710 list of all currently existing swap messages of the batch and paging 3711 results that contain next_key and total count. 3712 tendermint.liquidity.v1beta1.QueryPoolBatchWithdrawMsgResponse: 3713 type: object 3714 properties: 3715 withdraw: 3716 type: object 3717 properties: 3718 msg_height: 3719 type: string 3720 format: int64 3721 example: '1000' 3722 title: height where this message is appended to the batch 3723 msg_index: 3724 type: string 3725 format: uint64 3726 example: '1' 3727 title: index of this withdraw message in this liquidity pool 3728 executed: 3729 type: boolean 3730 example: true 3731 title: 'true if executed on this batch, false if not executed' 3732 succeeded: 3733 type: boolean 3734 example: true 3735 title: 'true if executed successfully on this batch, false if failed' 3736 to_be_deleted: 3737 type: boolean 3738 example: true 3739 title: >- 3740 true if ready to be deleted on kvstore, false if not ready to be 3741 deleted 3742 msg: 3743 title: MsgWithdrawWithinBatch 3744 type: object 3745 properties: 3746 withdrawer_address: 3747 type: string 3748 format: sdk.AccAddress 3749 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 3750 description: account address of the origin of this message 3751 pool_id: 3752 type: string 3753 format: uint64 3754 example: '1' 3755 title: id of the target pool 3756 pool_coin: 3757 type: object 3758 properties: 3759 denom: 3760 type: string 3761 amount: 3762 type: string 3763 description: >- 3764 Coin defines a token with a denomination and an amount. 3765 3766 3767 NOTE: The amount field is an Int which implements the custom 3768 method 3769 3770 signatures required by gogoproto. 3771 format: sdk.Coin 3772 example: 3773 denom: >- 3774 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 3775 amount: '1000' 3776 description: >- 3777 `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that supports 3778 submitting 3779 3780 a withdraw request to the batch of the liquidity pool. 3781 3782 Withdraw is submitted to the batch from the Liquidity pool with 3783 the 3784 3785 specified `pool_id`, `pool_coin` of the pool. 3786 3787 This request is stacked in the batch of the liquidity pool, is not 3788 processed 3789 3790 immediately, and is processed in the `endblock` at the same time 3791 as other requests. 3792 3793 3794 See: 3795 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 3796 description: >- 3797 WithdrawMsgState defines the state of the withdraw message that 3798 contains state information as the message is processed in the next 3799 batch or batches. 3800 description: >- 3801 the response type for the QueryPoolBatchWithdrawMsg RPC method. This 3802 includes a batch swap message of the batch. 3803 tendermint.liquidity.v1beta1.QueryPoolBatchWithdrawMsgsResponse: 3804 type: object 3805 properties: 3806 withdraws: 3807 type: array 3808 items: 3809 type: object 3810 properties: 3811 msg_height: 3812 type: string 3813 format: int64 3814 example: '1000' 3815 title: height where this message is appended to the batch 3816 msg_index: 3817 type: string 3818 format: uint64 3819 example: '1' 3820 title: index of this withdraw message in this liquidity pool 3821 executed: 3822 type: boolean 3823 example: true 3824 title: 'true if executed on this batch, false if not executed' 3825 succeeded: 3826 type: boolean 3827 example: true 3828 title: 'true if executed successfully on this batch, false if failed' 3829 to_be_deleted: 3830 type: boolean 3831 example: true 3832 title: >- 3833 true if ready to be deleted on kvstore, false if not ready to be 3834 deleted 3835 msg: 3836 title: MsgWithdrawWithinBatch 3837 type: object 3838 properties: 3839 withdrawer_address: 3840 type: string 3841 format: sdk.AccAddress 3842 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 3843 description: account address of the origin of this message 3844 pool_id: 3845 type: string 3846 format: uint64 3847 example: '1' 3848 title: id of the target pool 3849 pool_coin: 3850 type: object 3851 properties: 3852 denom: 3853 type: string 3854 amount: 3855 type: string 3856 description: >- 3857 Coin defines a token with a denomination and an amount. 3858 3859 3860 NOTE: The amount field is an Int which implements the custom 3861 method 3862 3863 signatures required by gogoproto. 3864 format: sdk.Coin 3865 example: 3866 denom: >- 3867 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 3868 amount: '1000' 3869 description: >- 3870 `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that supports 3871 submitting 3872 3873 a withdraw request to the batch of the liquidity pool. 3874 3875 Withdraw is submitted to the batch from the Liquidity pool with 3876 the 3877 3878 specified `pool_id`, `pool_coin` of the pool. 3879 3880 This request is stacked in the batch of the liquidity pool, is 3881 not processed 3882 3883 immediately, and is processed in the `endblock` at the same time 3884 as other requests. 3885 3886 3887 See: 3888 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 3889 description: >- 3890 WithdrawMsgState defines the state of the withdraw message that 3891 contains state information as the message is processed in the next 3892 batch or batches. 3893 pagination: 3894 description: >- 3895 pagination defines the pagination in the response. Not supported on 3896 this version. 3897 type: object 3898 properties: 3899 next_key: 3900 type: string 3901 format: byte 3902 title: |- 3903 next_key is the key to be passed to PageRequest.key to 3904 query the next page most efficiently 3905 total: 3906 type: string 3907 format: uint64 3908 title: >- 3909 total is total number of results available if 3910 PageRequest.count_total 3911 3912 was set, its value is undefined otherwise 3913 description: >- 3914 the response type for the QueryPoolBatchWithdraw RPC method. This includes 3915 a list of all currently existing withdraw messages of the batch and paging 3916 results that contain next_key and total count. 3917 tendermint.liquidity.v1beta1.SwapMsgState: 3918 type: object 3919 properties: 3920 msg_height: 3921 type: string 3922 format: int64 3923 example: '1000' 3924 title: height where this message is appended to the batch 3925 msg_index: 3926 type: string 3927 format: uint64 3928 example: '1' 3929 title: index of this swap message in this liquidity pool 3930 executed: 3931 type: boolean 3932 example: true 3933 title: 'true if executed on this batch, false if not executed' 3934 succeeded: 3935 type: boolean 3936 example: true 3937 title: 'true if executed successfully on this batch, false if failed' 3938 to_be_deleted: 3939 type: boolean 3940 example: true 3941 title: >- 3942 true if ready to be deleted on kvstore, false if not ready to be 3943 deleted 3944 order_expiry_height: 3945 type: string 3946 format: int64 3947 example: '1000' 3948 title: >- 3949 swap orders are cancelled when current height is equal to or higher 3950 than ExpiryHeight 3951 exchanged_offer_coin: 3952 type: object 3953 properties: 3954 denom: 3955 type: string 3956 amount: 3957 type: string 3958 description: |- 3959 Coin defines a token with a denomination and an amount. 3960 3961 NOTE: The amount field is an Int which implements the custom method 3962 signatures required by gogoproto. 3963 format: sdk.Coin 3964 example: 3965 denom: denomX 3966 amount: '600000' 3967 title: offer coin exchanged until now 3968 remaining_offer_coin: 3969 type: object 3970 properties: 3971 denom: 3972 type: string 3973 amount: 3974 type: string 3975 description: |- 3976 Coin defines a token with a denomination and an amount. 3977 3978 NOTE: The amount field is an Int which implements the custom method 3979 signatures required by gogoproto. 3980 format: sdk.Coin 3981 example: 3982 denom: denomX 3983 amount: '400000' 3984 title: offer coin currently remaining to be exchanged 3985 reserved_offer_coin_fee: 3986 type: object 3987 properties: 3988 denom: 3989 type: string 3990 amount: 3991 type: string 3992 description: |- 3993 Coin defines a token with a denomination and an amount. 3994 3995 NOTE: The amount field is an Int which implements the custom method 3996 signatures required by gogoproto. 3997 format: sdk.Coin 3998 example: 3999 denom: denomX 4000 amount: '5000' 4001 title: reserve fee for pays fee in half offer coin 4002 msg: 4003 title: MsgSwapWithinBatch 4004 type: object 4005 properties: 4006 swap_requester_address: 4007 type: string 4008 format: sdk.AccAddress 4009 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 4010 description: account address of the origin of this message 4011 title: address of swap requester 4012 pool_id: 4013 type: string 4014 format: uint64 4015 example: '1' 4016 description: >- 4017 id of swap type, must match the value in the pool. Only 4018 `swap_type_id` 1 is supported. 4019 swap_type_id: 4020 type: integer 4021 format: uint32 4022 example: '1' 4023 description: id of swap type. Must match the value in the pool. 4024 offer_coin: 4025 type: object 4026 properties: 4027 denom: 4028 type: string 4029 amount: 4030 type: string 4031 description: >- 4032 Coin defines a token with a denomination and an amount. 4033 4034 4035 NOTE: The amount field is an Int which implements the custom 4036 method 4037 4038 signatures required by gogoproto. 4039 format: sdk.Coin 4040 example: 4041 denom: denomX 4042 amount: '1000000' 4043 demand_coin_denom: 4044 type: string 4045 example: denomB 4046 description: >- 4047 denom of demand coin to be exchanged on the swap request, must 4048 match the denom in the pool. 4049 offer_coin_fee: 4050 type: object 4051 properties: 4052 denom: 4053 type: string 4054 amount: 4055 type: string 4056 description: >- 4057 Coin defines a token with a denomination and an amount. 4058 4059 4060 NOTE: The amount field is an Int which implements the custom 4061 method 4062 4063 signatures required by gogoproto. 4064 format: sdk.Coin 4065 example: 4066 denom: denomX 4067 amount: '5000' 4068 order_price: 4069 type: string 4070 format: sdk.Dec 4071 example: '1.1' 4072 description: >- 4073 limit order price for the order, the price is the exchange ratio 4074 of X/Y 4075 4076 where X is the amount of the first coin and Y is the amount 4077 4078 of the second coin when their denoms are sorted alphabetically. 4079 description: >- 4080 `MsgSwapWithinBatch` defines an sdk.Msg type that supports submitting 4081 a swap offer request to the batch of the liquidity pool. 4082 4083 Submit swap offer to the liquidity pool batch with the specified the 4084 `pool_id`, `swap_type_id`, 4085 4086 `demand_coin_denom` with the coin and the price you're offering 4087 4088 and `offer_coin_fee` must be half of offer coin amount * current 4089 `params.swap_fee_rate` and ceil for reservation to pay fees. 4090 4091 This request is stacked in the batch of the liquidity pool, is not 4092 processed 4093 4094 immediately, and is processed in the `endblock` at the same time as 4095 other requests. 4096 4097 You must request the same fields as the pool. 4098 4099 Only the default `swap_type_id` 1 is supported. 4100 4101 4102 See: https://github.com/gravity-devs/liquidity/tree/develop/doc 4103 4104 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 4105 description: >- 4106 SwapMsgState defines the state of the swap message that contains state 4107 information as the message is processed in the next batch or batches. 4108 tendermint.liquidity.v1beta1.WithdrawMsgState: 4109 type: object 4110 properties: 4111 msg_height: 4112 type: string 4113 format: int64 4114 example: '1000' 4115 title: height where this message is appended to the batch 4116 msg_index: 4117 type: string 4118 format: uint64 4119 example: '1' 4120 title: index of this withdraw message in this liquidity pool 4121 executed: 4122 type: boolean 4123 example: true 4124 title: 'true if executed on this batch, false if not executed' 4125 succeeded: 4126 type: boolean 4127 example: true 4128 title: 'true if executed successfully on this batch, false if failed' 4129 to_be_deleted: 4130 type: boolean 4131 example: true 4132 title: >- 4133 true if ready to be deleted on kvstore, false if not ready to be 4134 deleted 4135 msg: 4136 title: MsgWithdrawWithinBatch 4137 type: object 4138 properties: 4139 withdrawer_address: 4140 type: string 4141 format: sdk.AccAddress 4142 example: cosmos1e35y69rhrt7y4yce5l5u73sjnxu0l33wvznyun 4143 description: account address of the origin of this message 4144 pool_id: 4145 type: string 4146 format: uint64 4147 example: '1' 4148 title: id of the target pool 4149 pool_coin: 4150 type: object 4151 properties: 4152 denom: 4153 type: string 4154 amount: 4155 type: string 4156 description: >- 4157 Coin defines a token with a denomination and an amount. 4158 4159 4160 NOTE: The amount field is an Int which implements the custom 4161 method 4162 4163 signatures required by gogoproto. 4164 format: sdk.Coin 4165 example: 4166 denom: >- 4167 poolD35A0CC16EE598F90B044CE296A405BA9C381E38837599D96F2F70C2F02A23A4 4168 amount: '1000' 4169 description: >- 4170 `MsgWithdrawWithinBatch` defines an `sdk.Msg` type that supports 4171 submitting 4172 4173 a withdraw request to the batch of the liquidity pool. 4174 4175 Withdraw is submitted to the batch from the Liquidity pool with the 4176 4177 specified `pool_id`, `pool_coin` of the pool. 4178 4179 This request is stacked in the batch of the liquidity pool, is not 4180 processed 4181 4182 immediately, and is processed in the `endblock` at the same time as 4183 other requests. 4184 4185 4186 See: 4187 https://github.com/gravity-devs/liquidity/blob/develop/x/liquidity/spec/04_messages.md 4188 description: >- 4189 WithdrawMsgState defines the state of the withdraw message that contains 4190 state information as the message is processed in the next batch or 4191 batches.