Vortex LPer library

The Valence Vortex LPer library allows users to deposit into an Osmosis pool via Vortex contract from an input account. Also, the library allows withdrawing from position via vortex contract and receiving the withdrawn tokens into an output account and output account_2 (principal and counterparty tokens).

High Level Flow

---
title: Vortex lper Library
---
graph LR
  IA((Input
      Account))
  OA((Output
      Accounts))
  P[Processor]
  S[Vortex LPer
      Library]
  P -- 1/Provide or Withdraw liquidity --> S
  S -- 2/Query balances --> IA
  S -- 3/Provide liquidity --> IA
  S -- 4/Withdraw liquidity --> OA

Functions

Function	Parameters	Description
ProvideLiquidity	`tick_range: TickRange` `principal_token_min_amount: Uint128` `counterparty_token_min_amount: Uint128`	tries to deposit the entire principal and counterparty token amounts from the input account to the pool via Vortex.
Withdraw	-	withdraws all the liquidity from the position Vortex entered including potential rewards.

Configuration

The library is configured on instantiation via the LibraryConfig type.

#![allow(unused)]
fn main() {
pub struct LibraryConfig {
    /// Address of the input account 
    pub input_addr: LibraryAccountType,
    /// Address of the output account 
    pub output_addr: LibraryAccountType,
    /// Address of the second output account 
    pub output_addr_2: LibraryAccountType,
    /// Configuration for the liquidity provider
    /// This includes the pool address and asset data
    pub lp_config: LiquidityProviderConfig,
}

pub struct LiquidityProviderConfig {
    /// Code of the vortex contract we are going to instantiate
    pub vortex_code: u64,
    /// Label for the contract instantiation
    pub label: String,
    /// Id of the pool we are going to provide liquidity for
    pub pool_id: u64,
    /// Duration of the round in seconds
    pub round_duration: u64,
    /// Duration of the auction in seconds
    pub auction_duration: u64,
    /// Denoms of both assets we are going to provide liquidity for
    pub asset_data: AssetData,
    /// Whether the principal token is first in the pool
    pub principal_first: bool,
}
}

Implementation Details

Providing Liquidity Process

Balance Check: Queries the input account balance for the specified pool assets.
ProvideLiquidity: Initiates the liquidity process by executing a CreatePosition submessage to the Vortex contract.
- The initial call instantiates the Vortex contract.
- Once the submessage completes, the reply handler performs the actual position creation in the Osmosis pool by the Vortex contract instance.

Withdrawal Process

Round End Check: Queries the state of the Vortex contract to check if round ended - which must happen prior to executing a withdrawal.
Position Check: Checks if the position exists.
Withdraw: Executes a EndRound message on Vortex to withdraw the whole position.

Keyboard shortcuts