Passive Concentrated Liquidity Pools

Overview

Astroport’s passive concentrated liquidity (PCL) pools optimize for a passive and automatic LP experience for concentrated liquidity. Instead of depositors actively managing their price ranges, liquidity becomes concentrated around an internal oracle price - this is the moving average of recent trades in a pair.

More details around how PCL pools function can be found here.

InstantiateMsg

Initializes a new concentrated liquidity pair.

json

{
    "token_code_id": 123,
    "factory_addr": "terra...",
    "asset_infos": [
        {
            "token": {
                "contract_addr": "terra..."
            }
        },
        {
            "native_token": {
                "denom": "uusd"
            }
        }
    ],
    "init_params": "<base64_encoded_json_string>"
}

where <base64_encoded_json_string> is

json

{
    "amp": "40.0",
    "gamma": "0.0001",
    "mid_fee": "0.005",
    "out_fee": "0.01",
    "fee_gamma": "0.001",
    "repeg_profit_threshold": "0.0001",
    "min_price_scale_delta": "0.000001",
    "initial_price_scale": "1.5",
    "ma_half_time": 600,
    "owner": "terra..."
}

Note, the aforementioned values are just examples and have no practical meaning.

ExecuteMsg

`receive`

Withdraws liquidity or assets that were swapped to (ask assets from a swap operation).

json

{
    "receive": {
        "sender": "terra...",
        "amount": "123",
        "msg": "<base64_encoded_json_string>"
    }
}

`provide_liquidity`

Provides liquidity by sending a user's native or token assets to the pool.

NOTE

NOTE: you should increase your token allowance for the pool before providing liquidity!

json

{
    "provide_liquidity": {
        "assets": [
            {
                "info": {
                    "token": {
                        "contract_addr": "terra..."
                    }
                },
                "amount": "1000000"
            },
            {
                "info": {
                    "native_token": {
                        "denom": "uusd"
                    }
                },
                "amount": "1000000"
            }
        ],
        "auto_stake": false,
        "receiver": "terra...",
        "slippage_tolerance": "0.01"
    }
}

`withdraw_liquidity`

Burn LP tokens and withdraw liquidity from a pool. This call must be sent to a LP token contract associated with the pool from which you want to withdraw liquidity from.

json

{
    "withdraw_liquidity": {}
}

`swap`

Perform a swap. offer_asset is your source asset and to is the address that will receive the ask assets. All fields are optional except offer_asset.

json

{
    "swap": {
        "offer_asset": {
            "info": {
                "native_token": {
                    "denom": "uluna"
                }
            },
            "amount": "123"
        },
        "belief_price": "123",
        "max_spread": "123",
        "to": "terra..."
    }
}

`update_config`

Update the concentrated liquidity pair's configuration.

json

{
    "update_config": {
        "params": "<base64_encoded_json_string>"
    }
}

where <base64_encoded_json_string> is one of

Update parameters

json

{
    "update": {
        "mid_fee": "0.1",
        "out_fee": "0.01",
        ...
    }
}

Update Amp or Gamma

json

{
    "promote": {
        "next_amp": "44",
        "next_gamma": "0.001",
        "future_time": 1570257049
    }
}

Stop Amp and Gamma change

json

{
    "stop_changing_amp_gamma": {}
}

QueryMsg

`pair`

Queries information about a pair.

json

pair_concentrated.rs

{
  "pair": {}
}

Returns a PairInfo response struct.

`pool`

Queries information about a pool.

json

pair_concentrated.rs

{
  "pool": {}
}

`PoolResponse`

This struct is used to return a query result with the total amount of LP tokens and assets in a specific pool.

json

pair_concentrated.rs

{
    "assets": [
        {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        },
        {
            "info": {
                "native_token": {
                    "denom": "..."
                }
            },
            "amount": "100000"
        }
    ], 
    "total_share": "1234567"
}

Params	Type	Description
`assets`	`Vec<Asset>`	The assets in the pool together with asset amounts
`total_share`	`Uint128`	The total amount of LP tokens currently issued

`config`

Queries contract configuration settings.

json

pair_concentrated.rs

{
  "config": {}
}

`ConfigResponse`

This struct is used to return a query result with the general contract configuration.

json

pair_concentrated.rs

{
    "block_time_last": 1234567, 
    "params": "<base64_encoded_json_string>",
    "owner": "..."
}

Params	Type	Description
`block_time_last`	`u64`	The assets in the pool together with asset amounts
`params`	`Option<Binary>`	The pool's parameters
`owner`	`Option<Addr>`	The contract owner

`share`

Queries information about the share of a pool.

json

pair_concentrated.rs

{
  "share": {
    "amount": "1000000"
  }
}

Params	Type	Description
`amount`	`Uint128`	Share of the pool

Returns a vector that contains objects of type Asset.

`simulation`

Queries information about a swap simulation.

json

pair_concentrated.rs

{
    "simulation": {
        "offer_asset": {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        }, 
        "ask_asset_info": {
            "native_token": {
                "denom": "..."
            }
        }
    }
}

Params	Type	Description
`offer_asset`	`Asset`	Offer asset
`ask_asset_info`	`Option<AssetInfo>`	Ask asset info

`SimulationResponse`

This structure holds the parameters that are returned from a swap simulation response.

json

pair_concentrated.rs

{
  "return_amount": "123456",
  "spread_amount": "0",
  "commission_amount": "123"
}

Params	Type	Description
`return_amount`	`Uint128`	The amount of ask assets returned by the swap
`spread_amount`	`Uint128`	The spread used in the swap operation
`commission_amount`	`Uint128`	The amount of fees charged by the transaction

`reverse_simulation`

Queries information about a reverse swap simulation.

json

pair_concentrated.rs

{
    "reverse_simulation": {
        "offer_asset_info": {
            "native_token": {
                "denom": "..."
            }
        },
        "ask_asset": {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        }
    }
}

Params	Type	Description
`offer_asset_info`	`Option<AssetInfo>`	Offer asset info
`ask_asset`	`Asset`	Ask asset

`ReverseSimulationResponse`

This structure holds the parameters that are returned from a reverse swap simulation response.

json

pair_concentrated.rs

{
  "offer_amount": "12345",
  "spread_amount": "0",
  "commission_amount": "123"
}

Params	Type	Description
`offer_amount`	`Uint128`	The amount of offer assets returned by the reverse swap
`spread_amount`	`Uint128`	The spread used in the swap operation
`commission_amount`	`Uint128`	The amount of fees charged by the transaction

`cumulative_prices`

Queries information about cumulative prices in a pool.

json

pair_concentrated.rs

{
  "cumulative_prices": {}
}

`CumulativePricesResponse`

This structure is used to return a cumulative prices query response.

json

pair_concentrated.rs

{
    "assets": [
        {
            "info": {
                "token": {
                    "contract_addr": "..."
                }
            },
            "amount": "100000"
        },
        {
            "info": {
                "native_token": {
                    "denom": "..."
                }
            },
            "amount": "100000"
        }
    ], 
    "total_share": "12345667", 
    "price0_cumulative_last": "12345667",
    "price1_cumulative_last": "12345667"
}

Params	Type	Description
`assets`	`Vec<Asset>`	The assets in the pool to query
`total_share`	`Uint128`	The total amount of LP tokens currently issued
`cumulative_prices`	`Vec<(AssetInfo, AssetInfo, Uint128)>`	The vector contains cumulative prices for each pair of assets in the pool

`query_compute_d`

Returns current D value for the pool.

json

pair_concentrated.rs

{
    "query_compute_d": {}
}

Returns Decimal256

`lp_price`

Query LP token virtual price.

json

pair_concentrated.rs

{
    "lp_price": {}
}

Returns Decimal256

`amp_gamma`

Query curremt Amp and Gamma parameters.

json

pair_concentrated.rs

{
    "amp_gamma": {}
}

`asset_balance_at`

Queries the balance of the specified asset that was in the pool just preceeding the moment of the specified block height creation. The query will return None (null) if the balance was not tracked up to the specified block height.

json

pair_concentrated.rs

{
    "asset_balance_at": {
        "asset_info": {
            "native_token": {
                "denom": "stake"
            }
        },
        "block_height": "12345678"
    }
}

`observe`

Queries price from stored observations. If observation was not found at exact time then it is interpolated using surrounding observations.

json

pair_concentrated.rs

{
    "observe": {
        "seconds_ago": 3600
    }
}

`OracleObservation` (Response)

This structure is used to return an observation query response.

json

observation.rs

{
    "timestamp": 12345, 
    "price": "1.23"
}

Params	Type	Description
`timestamp`	`u64`	The timestamp for returned price observations
`price`	`Decimal`	The price from stored observations

Passive Concentrated Liquidity Pools

Overview​

Links​

InstantiateMsg​

ExecuteMsg​

receive​

provide_liquidity​

withdraw_liquidity​

swap​

update_config​

QueryMsg​

pair​

pool​

PoolResponse​

config​

ConfigResponse​

share​

simulation​

SimulationResponse​

reverse_simulation​

ReverseSimulationResponse​

cumulative_prices​

CumulativePricesResponse​

query_compute_d​

lp_price​

amp_gamma​

asset_balance_at​

observe​

OracleObservation (Response)​

Overview

Links

InstantiateMsg

ExecuteMsg

`receive`

`provide_liquidity`

`withdraw_liquidity`

`swap`

`update_config`

QueryMsg

`pair`

`pool`

`PoolResponse`

`config`

`ConfigResponse`

`share`

`simulation`

`SimulationResponse`

`reverse_simulation`

`ReverseSimulationResponse`

`cumulative_prices`

`CumulativePricesResponse`

`query_compute_d`

`lp_price`

`amp_gamma`

`asset_balance_at`

`observe`

`OracleObservation` (Response)