Skip to content

magma_lper.md

Latest commit

 

History

History
65 lines (51 loc) · 1.85 KB

magma_lper.md

File metadata and controls

65 lines (51 loc) · 1.85 KB
Raw

Magma LPer Library

The Valence Magma LPer library allows users to deposit into a Magma Vault Pool from an input account and receive shares into an output account.

High-level flow

---
title: Magma LPer
---
graph LR
  IA((Input
      Account))
  OA((Output
          Account))
  P[Processor]
  S[Magma
      Liquidity
      Provider]
  M[Magma Vault]
  P -- 1/Provide Liquidity --> S
  S -- 2/Query balances --> IA
  S -- 3/Do Provide Liquidity --> IA
  IA -- 4/Provide Liquidity
                  [Tokens] --> M
  M -- 4'/Mint Shares --> OA
Loading

Functions

Function Parameters Description
ProvideLiquidity amount_0_min: Option<String>
amount_1_min: Option<String>		 Provide double-sided liquidity to the pre-configured Magma Vault from the input account, and receive the shares into the output account.

Configuration

The library is configured on instantiation via the LibraryConfig type.

pub struct LibraryConfig {
    /// Address of the input account 
    pub input_addr: LibraryAccountType,
    /// Address of the output account 
    pub output_addr: LibraryAccountType,
    /// Configuration for the liquidity provider
    /// This includes the pool address and asset data
    pub lp_config: LiquidityProviderConfig,
}

pub struct LiquidityProviderConfig {
    /// Address of the vault we are going to deposit into
    pub vault_addr: String,
    /// Denoms of both assets we are going to provide liquidity for
    pub asset_data: AssetData,
}

Implementation Details

Deposit Process

  1. Balance Check: Queries the input account balance for the specified pool assets.
  2. Provide Liquidity: Executes a Deposit message, which deposits assets to the vault. Upon depositing, the provider obtains an amount of LP token shares.