github.com/gravity-devs/liquidity@v1.5.3/x/liquidity/spec/08_params.md (about)

     1  <!-- order: 8 -->
     2  
     3   # Parameters
     4  
     5  The liquidity module contains the following parameters:
     6  
     7  Key                    | Type             | Example
     8  ---------------------- | ---------------- | -------------------------------------------------------------------------------------------------------------------
     9  PoolTypes              | []PoolType            | [{"id":1,"name":"StandardLiquidityPool","min_reserve_coin_num":2,"max_reserve_coin_num":2,"description":"Standard liquidity pool with pool price function X/Y, ESPM constraint, and two kinds of reserve coins"}]
    10  MinInitDepositAmount   | string (sdk.Int)      | "1000000"
    11  InitPoolCoinMintAmount | string (sdk.Int)      | "1000000"
    12  MaxReserveCoinAmount   | string (sdk.Int)      | "0"
    13  PoolCreationFee        | sdk.Coins             | [{"denom":"stake","amount":"40000000"}]
    14  SwapFeeRate            | string (sdk.Dec)      | "0.003000000000000000"
    15  WithdrawFeeRate        | string (sdk.Dec)      | "0.000000000000000000"
    16  MaxOrderAmountRatio    | string (sdk.Dec)      | "0.100000000000000000"
    17  UnitBatchHeight        | uint32                | 1
    18  CircuitBreakerEnabled  | bool                  | false
    19  
    20  ## PoolTypes
    21  
    22  List of available PoolType
    23  
    24  ```go
    25  type PoolType struct {
    26      Id                    uint32
    27      Name                  string
    28      MinReserveCoinNum     uint32
    29      MaxReserveCoinNum     uint32
    30      Description           string
    31  }
    32  ```
    33  
    34  ## MinInitDepositAmount
    35  
    36  Minimum number of coins to be deposited to the liquidity pool upon pool creation.
    37  
    38  ## InitPoolCoinMintAmount
    39  
    40  Initial mint amount of pool coin on pool creation.
    41  
    42  ## MaxReserveCoinAmount
    43  
    44  Limit the size of each liquidity pool. The deposit transaction fails if the total reserve coin amount after the deposit is larger than the reserve coin amount. 
    45  
    46  The default value of zero means no limit. 
    47  
    48  **Note:** Especially in the early phases of liquidity module adoption, set `MaxReserveCoinAmount` to a non-zero value to minimize risk on error or exploitation.
    49  
    50  ## PoolCreationFee
    51  
    52  Fee paid for to create a LiquidityPool creation. This fee prevents spamming and is collected in in the community pool of the distribution module. 
    53  
    54  ## SwapFeeRate
    55  
    56  Swap fee rate for every executed swap. When a swap is requested, the swap fee is reserved: 
    57  
    58  - Half reserved as `OfferCoinFee`
    59  - Half reserved as `ExchangedCoinFee`
    60  
    61  The swap fee is collected when a batch is executed. 
    62  
    63  ## WithdrawFeeRate
    64  
    65  Reserve coin withdrawal with less proportion by `WithdrawFeeRate`. This fee prevents attack vectors from repeated deposit/withdraw transactions. 
    66  
    67  ## MaxOrderAmountRatio
    68  
    69  Maximum ratio of reserve coins that can be ordered at a swap order.
    70  
    71  ## UnitBatchHeight
    72  
    73  The smallest unit batch size for every liquidity pool.
    74  
    75  ## CircuitBreakerEnabled
    76  
    77  The intention of circuit breaker is to have a contingency plan for a running network which maintains network liveness. This parameter enables or disables `MsgCreatePool`, `MsgDepositWithinBatch` and `MsgSwapWithinBatch` message types in liquidity module.
    78  # Constant Variables
    79  
    80  Key                 | Type   | Constant Value
    81  ------------------- | ------ | --------------
    82  CancelOrderLifeSpan | int64  | 0
    83  MinReserveCoinNum   | uint32 | 2
    84  MaxReserveCoinNum   | uint32 | 2
    85  
    86  ## CancelOrderLifeSpan
    87  
    88  The life span of swap orders in block heights.
    89  
    90  ## MinReserveCoinNum, MaxReserveCoinNum
    91  
    92  The mininum and maximum number of reserveCoins for `PoolType`.