# Swap ## 1. Standard Swap (Without Partner) ### 1.1 Using Router Contract **Location**: `dlmm_router::swap` module #### **swap\_a2b** Swap Coin A to Coin B. ```move public fun swap_a2b( pool: &mut Pool, coin_a: &mut Coin, by_amount_in: bool, amount: u64, amount_limit: u64, config: &GlobalConfig, versioned: &Versioned, clock: &Clock, ctx: &mut TxContext, ) ``` #### **swap\_b2a** Swap Coin B to Coin A. ```move public fun swap_b2a( pool: &mut Pool, coin_b: &mut Coin, by_amount_in: bool, amount: u64, amount_limit: u64, config: &GlobalConfig, versioned: &Versioned, clock: &Clock, ctx: &mut TxContext, ) ``` **Parameters**
ParameterTypeDescription
pool&mut PoolPool object (mutable)
coin_a / coin_b&mut CoinInput coin object
by_amount_inbooltrue: fix input amount, false: fix output amount
amountu64If by_amount_in=true: input amount; else: output amount
amount_limitu64If by_amount_in=true: min output; else: max input
config&GlobalConfigGlobal config for validations
versioned&VersionedVersioned object for version checking
clock&ClockClock object (0x6)
### 1.2 Build Custom Swap (Using Flash Swap) ```move fun swap_( pool: &mut Pool, coin_a: &mut Coin, coin_b: &mut Coin, a2b: bool, by_amount_in: bool, amount: u64, amount_limit: u64, versioned: &Versioned, config: &GlobalConfig, clock: &Clock, ctx: &mut TxContext, ) { // Step 1: Flash swap - borrow output tokens let (receive_a, receive_b, flash_receipt) = pool::flash_swap( pool, a2b, by_amount_in, amount, config, versioned, clock, ctx, ); // Step 2: Validate amounts let (in_amount, out_amount) = ( flash_receipt.pay_amount(), if (a2b) receive_b.value() else receive_a.value(), ); if (by_amount_in) { assert!(in_amount == amount, ESwapAmountIncorrect); assert!(out_amount >= amount_limit, EAmountOutBelowMinLimit); } else { assert!(out_amount == amount, ESwapAmountIncorrect); assert!(in_amount <= amount_limit, EAmountInAboveMaxLimit); }; // Step 3: Prepare repayment let (pay_coin_a, pay_coin_b) = if (a2b) { assert!(coin_a.value() >= in_amount, ENotEnoughCoin); (coin_a.split(in_amount, ctx).into_balance(), balance::zero()) } else { assert!(coin_b.value() >= in_amount, ENotEnoughCoin); (balance::zero(), coin_b.split(in_amount, ctx).into_balance()) }; // Step 4: Repay flash swap pool::repay_flash_swap( pool, pay_coin_a, pay_coin_b, flash_receipt, versioned, ); // Step 5: Collect output coin_a.join(receive_a.into_coin(ctx)); coin_b.join(receive_b.into_coin(ctx)); } ``` *** ## 2. Partner Swap (With Referral Fee) Partners can earn referral fees by using partner-specific swap functions. See [Partner Integration Guide](https://vscode-remote+ssh-002dremote-002bwork.vscode-resource.vscode-cdn.net/home/bond/github/cetus/cetus-dlmm/docs/partner-integration-guide.md) for complete partner setup. ### 2.1 Using Router Contract **Location**: `dlmm_router::swap` module #### **swap\_a2b\_with\_partner** ```move public fun swap_a2b_with_partner( pool: &mut Pool, partner: &mut Partner, coin_a: &mut Coin, by_amount_in: bool, amount: u64, amount_limit: u64, config: &GlobalConfig, versioned: &Versioned, clock: &Clock, ctx: &mut TxContext, ) ``` #### **swap\_b2a\_with\_partner** ```move public fun swap_b2a_with_partner( pool: &mut Pool, partner: &mut Partner, coin_b: &mut Coin, by_amount_in: bool, amount: u64, amount_limit: u64, config: &GlobalConfig, versioned: &Versioned, clock: &Clock, ctx: &mut TxContext, ) ``` **Additional Parameter**
ParameterTypeDescription
partner&mut PartnerPartner object (shared, mutable)
> Other parameters are the same as standard swap. ### 2.2 Build Custom Swap with Partner (Using Flash Swap) ```move fun swap_with_partner_( pool: &mut Pool, partner: &mut Partner, coin_a: &mut Coin, coin_b: &mut Coin, a2b: bool, by_amount_in: bool, amount: u64, amount_limit: u64, config: &GlobalConfig, versioned: &Versioned, clock: &Clock, ctx: &mut TxContext, ) { // Step 1: Flash swap with partner - calculates referral fee let (receive_a, receive_b, flash_receipt) = pool::flash_swap_with_partner( pool, partner, a2b, by_amount_in, amount, config, versioned, clock, ctx, ); // Step 2: Validate amounts let (in_amount, out_amount) = ( flash_receipt.pay_amount(), if (a2b) receive_b.value() else receive_a.value(), ); if (by_amount_in) { assert!(in_amount == amount, ESwapAmountIncorrect); assert!(out_amount >= amount_limit, EAmountOutBelowMinLimit); } else { assert!(out_amount == amount, ESwapAmountIncorrect); assert!(in_amount <= amount_limit, EAmountInAboveMaxLimit); }; // Step 3: Prepare repayment let (pay_coin_a, pay_coin_b) = if (a2b) { assert!(coin_a.value() >= in_amount, ENotEnoughCoin); (coin_a.split(in_amount, ctx).into_balance(), balance::zero()) } else { assert!(coin_b.value() >= in_amount, ENotEnoughCoin); (balance::zero(), coin_b.split(in_amount, ctx).into_balance()) }; // Step 4: Repay flash swap - referral fee is automatically deposited to partner pool::repay_flash_swap_with_partner( pool, partner, pay_coin_a, pay_coin_b, flash_receipt, versioned, ); // Step 5: Collect output coin_a.join(receive_a.into_coin(ctx)); coin_b.join(receive_b.into_coin(ctx)); } ``` #### 2.3 Key Differences from Standard Swap
AspectStandard SwapPartner Swap
Functionflash_swap / repay_flash_swapflash_swap_with_partner / repay_flash_swap_with_partner
Partner paramNot requiredRequired (&mut Partner)
Referral feeNoneCalculated and deposited to partner
Fee collectionN/APartner must manually claim
### Related Documentation *** * [Partner Integration Guide](https://vscode-remote+ssh-002dremote-002bwork.vscode-resource.vscode-cdn.net/home/bond/github/cetus/cetus-dlmm/docs/partner-integration-guide.md) - Partner setup and fee claiming --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://cetus-1.gitbook.io/cetus-developer-docs/developer/via-dlmm-contract/features-available/swap.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.