Magma Withdrawer library

The Valence Magma Withdrawer library allows users to withdraw liquidity from Magma Vault from an input account and receive the withdrawn tokens into an output account.

High-level flow

---
title: Magma Liquidity Withdrawal
---
graph LR
  IA((Input
      Account))
  OA((Output
          Account))
  P[Processor]
  S[Magma
      Liquidity
      Withdrawal]
  M[Magma Vault]
  P -- 1/Withdraw Liquidity --> S
  S -- 2/Query balance --> IA
  S -- 3/Do Withdraw Liquidity --> IA
  IA -- 4/Withdraw Liquidity
                  [Shares] --> M
  M -- 4'/Transfer assets --> OA

Function	Parameters	Description
WithdrawLiquidity	`token_min_amount_0: Option<Uint128>` `token_min_amount_1: Option<Uint128>`	Withdraw liquidity from the configured Magma Vault from the input account, and receive tokens to the configured output account.

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 vault we are going to withdraw liquidity from 
    pub vault_addr: String,
}
}

Implementation Details

Withdrawal Process

Balance Check: Queries the balance of the shares in the input account. To withdraw liquidity, the wallet address must have a positive balance of shares amount.
Withdraw Liquidity: Executes a Withdraw message, which withdraws the shares of liquidity to the Valence output account.

Error Handling

No available shares for withdrawal: Returns an error if attempting to withdraw with a zero input value of shares.