# Stable Pool ## Contract Interface ### 1. Notations & Structs #### 1.1. PoolResultType ```rust pub type PoolResultType = ManagedVec>; ``` #### 1.2. TokenAttributes ```rust pub struct TokenAttributes { pub reserve: BigUint, pub rate: BigUint, } ``` #### 1.3. AddLiquidityAttributes ```rust pub struct AddLiquidityAttributes { pub token: TokenIdentifier, pub attribute: TokenAttributes, pub amount_added: BigUint, pub total_fee: BigUint, pub admin_fee: BigUint, } ``` #### 1.4. AddLiquidityEvent ```rust pub struct AddLiquidityEvent { lp_token_amount: BigUint, lp_token_supply: BigUint, tokens: ManagedVec>, } ``` #### 1.5. RemoveLiquidityAttributes ```rust pub struct RemoveLiquidityAttributes { pub token: TokenIdentifier, pub attribute: TokenAttributes, pub amount_removed: BigUint, } ``` #### 1.6. RemoveLiquidityEvent ```rust pub struct RemoveLiquidityEvent { lp_token_amount: BigUint, lp_token_supply: BigUint, tokens: ManagedVec>, } ``` #### 1.7. RemoveLiquidityOneCoinEvent ```rust pub struct RemoveLiquidityOneCoinEvent { lp_token_amount: BigUint, lp_token_supply: BigUint, total_fee: BigUint, admin_fee: BigUint, token_out: RemoveLiquidityAttributes, } ``` #### 1.8. ExchangeAttributes ```rust pub struct ExchangeAttributes { pub token: TokenIdentifier, pub attribute: TokenAttributes, pub final_amount: BigUint, } ``` #### 1.9. ExchangeEvent ```rust pub struct ExchangeEvent { total_fee: BigUint, admin_fee: BigUint, token_in: ExchangeAttributes, token_out: ExchangeAttributes, } ``` ### 2. Write functions #### 2.1. Add liquidity ```rust #[payable("*")] #[endpoint(addLiquidity)] fn add_liquidity(&self, mint_amount_min: BigUint, lp_token_receiver: &ManagedAddress) -> PoolResultType ``` #### 2.2. Remove liquidity ```rust #[payable("*")] #[endpoint(removeLiquidity)] fn remove_liquidity(&self, token_amount_min: MultiValueEncoded) -> PoolResultType ``` #### 2.3. Exchange ```rust #[payable("*")] #[endpoint(exchange)] fn exchange(&self, token_out: TokenIdentifier, amount_out_min: BigUint) -> PoolResultType ``` `token_out`: The token id that you want to receive after exchanging. `amount_out_min`: The minimum amount of `token_out` that you will receive. If the pool returns an amount that is smaller than `amount_out_min` the transaction will be reverted. ### 3. Read functions #### 3.1. Estimate the exchange output ```rust #[derive(TopEncode, TopDecode, NestedEncode, NestedDecode, PartialEq, TypeAbi, Clone, ManagedVecItem)] pub struct TokenAttributes { pub reserve: BigUint, pub rate: BigUint, } #[derive(TopEncode, TopDecode, NestedEncode, NestedDecode, PartialEq, TypeAbi, Clone, ManagedVecItem)] pub struct ExchangeAttributes { pub token: TokenIdentifier, pub attribute: TokenAttributes, pub final_amount: BigUint, } #[derive(TopEncode, TopDecode, NestedEncode, NestedDecode, PartialEq, TypeAbi, Clone)] pub struct ExchangeResultType { pub total_fee: BigUint, pub admin_fee: BigUint, pub token_in: ExchangeAttributes, pub token_out: ExchangeAttributes, } #[view(estimateAmountOut)] fn get_amount_out(&self, token_in: &TokenIdentifier, token_out: &TokenIdentifier, amount_in: BigUint) -> ExchangeResultType ``` #### 3.2. Estimate add liquidity ```rust #[derive(TopEncode, TopDecode, NestedEncode, NestedDecode, PartialEq, TypeAbi, Clone)] pub struct AddLiquidityResultType { pub mint_amount: BigUint, pub tokens: ManagedVec>, } #[view(estimateAddLiquidity)] fn pool_add_liquidity(&self, token_amount_added: &ManagedVec) -> AddLiquidityResultType ``` #### 3.3. Estimate remove liquidity ```rust #[derive(TopEncode, TopDecode, NestedEncode, NestedDecode, PartialEq, TypeAbi, Clone)] pub struct RemoveLiquidityResultType { pub burn_amount: BigUint, pub tokens: ManagedVec>, } #[view(estimateRemoveLiquidity)] fn pool_remove_liquidity(&self, burn_amount: BigUint) -> RemoveLiquidityResultType ``` #### 3.4. Get AMP factor ```rust #[view(getAmpFactor)] fn get_amp_factor(&self) -> u64 ``` #### 3.5. Get pool state ```rust #[derive(TopEncode, TopDecode, PartialEq, TypeAbi, Debug)] pub enum State { Inactive, Active, ActiveNoSwaps } #[view(getState)] fn state(&self) -> State; ``` #### 3.6. Get LP token identifier ```rust #[view(getLpTokenIdentifier)] fn get_lp_token_identifier(&self) -> TokenIdentifier ``` #### 3.7. Get LP token supply ```rust #[view(getTotalSupply)] fn get_lp_token_supply(&self) -> BigUint ``` #### 3.8. Get pool tokens ```rust #[view(getTokens)] fn get_tokens(&self) -> ManagedVec ``` #### 3.9. Get token balances ```rust #[view(getBalances)] fn get_balances(&self, token: &TokenIdentifier) -> BigUint ``` #### 3.10. Get swap fee ```rust #[view(getSwapFeePercent)] fn swap_fee_percent(&self) -> u64; ``` #### 3.11. Get admin fee ```rust #[view(getAdminFeePercent)] fn admin_fee_percent(&self) -> u64; ``` ### 4. Events #### 4.1. Add liquidity ```rust #[event("add_liquidity")] fn add_liquidity_event( &self, #[indexed] timestamp: u64, #[indexed] caller: &ManagedAddress, add_liquidity_event: &AddLiquidityEvent, ); ``` #### 4.2. Remove liquidity ```rust #[event("remove_liquidity")] fn remove_liquidity_event( &self, #[indexed] timestamp: u64, #[indexed] caller: &ManagedAddress, remove_liquidity_event: &RemoveLiquidityEvent, ); ``` #### 4.3. Remove liquidity one coin ```rust #[event("remove_liquidity_one_coin")] fn remove_liquidity_one_coin_event( &self, #[indexed] timestamp: u64, #[indexed] caller: &ManagedAddress, remove_liquidity_one_coin_event: &RemoveLiquidityOneCoinEvent, ); ``` #### 4.4. Exchange ```rust #[event("exchange")] fn exchange_event( &self, #[indexed] timestamp: u64, #[indexed] caller: &ManagedAddress, exchange_event: &ExchangeEvent, ); ``` --- # 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://docs.ashswap.io/developers/smart-contracts/stable-pool.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.