# Contract Event ## CLMM Events Documentation This document describes all user-related events emitted by the CLMM contract. These events provide transparency and allow external systems to track user interactions with the protocol. ### Table of Contents * [Pool Management Events](#pool-management-events) * [Trading Events](#trading-events) * [Liquidity Management Events](#liquidity-management-events) * [Fee Collection Events](#fee-collection-events) * [Flash Loan Events](#flash-loan-events) *** ### Pool Management Events #### PoolCreatedEvent Emitted when a new pool is created. ```move public struct PoolCreatedEvent has copy, drop, store { sender: address, // Address of the pool creator pool_id: ID, // Unique identifier for the pool type_x: TypeName, // Type name of token X type_y: TypeName, // Type name of token Y fee_rate: u64, // Fee rate for the pool (in basis points) tick_spacing: u32, // Tick spacing for the pool } ``` *** ### Trading Events #### SwapEvent Emitted when a swap operation is executed. ```move public struct SwapEvent has copy, drop, store { sender: address, // Address of the trader pool_id: ID, // ID of the pool being traded x_for_y: bool, // True if swapping X for Y, false if Y for X amount_x: u64, // Amount of token X involved in the swap amount_y: u64, // Amount of token Y involved in the swap sqrt_price_before: u128, // Square root price before the swap sqrt_price_after: u128, // Square root price after the swap liquidity: u128, // Current liquidity in the pool tick_index: i32::I32, // Current tick index fee_amount: u64, // Total fee amount charged protocol_fee: u64, // Protocol fee amount reserve_x: u64, // Reserve of token X after swap reserve_y: u64 // Reserve of token Y after swap } ``` *** ### Liquidity Management Events #### OpenPositionEvent Emitted when a new position is opened. ```move public struct OpenPositionEvent has copy, drop, store { sender: address, // Address of the position owner pool_id: ID, // ID of the pool position_id: ID, // Unique identifier for the position tick_lower_index: I32, // Lower tick index of the position range tick_upper_index: I32, // Upper tick index of the position range } ``` #### ClosePositionEvent Emitted when a position is closed. ```move public struct ClosePositionEvent has copy, drop, store { sender: address, // Address of the position owner position_id: ID, // ID of the position being closed } ``` #### AddLiquidityEvent Emitted when liquidity is added to a position. ```move public struct AddLiquidityEvent has copy, drop, store { sender: address, // Address of the liquidity provider pool_id: ID, // ID of the pool position_id: ID, // ID of the position liquidity: u128, // Amount of liquidity added amount_x: u64, // Amount of token X added amount_y: u64, // Amount of token Y added upper_tick_index: I32, // Upper tick index of the position lower_tick_index: I32, // Lower tick index of the position reserve_x: u64, // Reserve of token X after adding liquidity reserve_y: u64 // Reserve of token Y after adding liquidity } ``` #### RemoveLiquidityEvent Emitted when liquidity is removed from a position. ```move public struct RemoveLiquidityEvent has copy, drop, store { sender: address, // Address of the liquidity provider pool_id: ID, // ID of the pool position_id: ID, // ID of the position liquidity: u128, // Amount of liquidity removed amount_x: u64, // Amount of token X removed amount_y: u64, // Amount of token Y removed upper_tick_index: I32, // Upper tick index of the position lower_tick_index: I32, // Lower tick index of the position reserve_x: u64, // Reserve of token X after removing liquidity reserve_y: u64 // Reserve of token Y after removing liquidity } ``` *** ### Fee Collection Events #### FeeCollectedEvent Emitted when fees are collected from a position. ```move public struct FeeCollectedEvent has copy, drop, store { sender: address, // Address of the fee collector pool_id: ID, // ID of the pool position_id: ID, // ID of the position amount_x: u64, // Amount of token X fees collected amount_y: u64, // Amount of token Y fees collected } ``` #### CollectPoolRewardEvent Emitted when pool rewards are collected. ```move public struct CollectPoolRewardEvent has copy, drop, store { sender: address, // Address of the reward collector pool_id: ID, // ID of the pool position_id: ID, // ID of the position reward_coin_type: TypeName, // Type of the reward token amount: u64, // Amount of reward tokens collected } ``` *** ### Flash Loan Events #### FlashLoanEvent Emitted when a flash loan is initiated. ```move public struct FlashLoanEvent has copy, drop, store { sender: address, // Address of the flash loan borrower pool_id: ID, // ID of the pool amount_x: u64, // Amount of token X borrowed amount_y: u64, // Amount of token Y borrowed reserve_x: u64, // Reserve of token X after flash loan reserve_y: u64 // Reserve of token Y after flash loan } ``` #### RepayFlashLoanEvent Emitted when a flash loan is repaid. ```move public struct RepayFlashLoanEvent has copy, drop, store { sender: address, // Address of the flash loan borrower pool_id: ID, // ID of the pool amount_x_debt: u64, // Amount of token X debt amount_y_debt: u64, // Amount of token Y debt actual_fee_paid_x: u64, // Actual fee paid in token X actual_fee_paid_y: u64, // Actual fee paid in token Y reserve_x: u64, // Reserve of token X after repayment reserve_y: u64, // Reserve of token Y after repayment fee_x: u64, // Fee amount in token X fee_y: u64 // Fee amount in token Y } ``` #### RepayFlashSwapEvent Emitted when a flash swap is repaid. ```move public struct RepayFlashSwapEvent has copy, drop, store { sender: address, // Address of the flash swap borrower pool_id: ID, // ID of the pool amount_x_debt: u64, // Amount of token X debt amount_y_debt: u64, // Amount of token Y debt paid_x: u64, // Amount of token X paid back paid_y: u64, // Amount of token Y paid back reserve_x: u64, // Reserve of token X after repayment reserve_y: u64 // Reserve of token Y after repayment } ```
--- # 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://developers.mmt.finance/clmm-smart-contracts/contract-event.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.