LP Modules : How do they work?

Module Types

  • two_pool_amm Module - Two-Token AMMs allow liquidity providers to create pools with just two different tokens. This simplifies the process of providing liquidity and makes it more accessible for users who want to focus on specific trading pairs. Two-Token AMMs are supported in all pool types: Weighted, Stable, and Concentrated Liquidity (Curve v2).

  • three_pool_amm Module - Three-Token AMMs extend the capabilities of our AMM Farms by allowing liquidity providers to create pools with three different tokens. This opens up more trading possibilities and can lead to increased liquidity and trading volume. Like the Two-Token AMMs, Three-Token AMMs are also supported in all pool types.


Module Structures & Objects

Objects

NameTypeDescription

[PoolRegistry]

Shared

Our ledger for all created pools, ensuring no duplication of currency pair exists in the hive.

[LiquidityPool]

Shared

Represents a pool buzzing with token currency reserves.

Structs

NameDescription

[PoolRegistryItem]

A representative of a pool's currency pair within the PoolRegistry.

[LP]

A witness of a pool's LP token.

[SuiHarvest]

Stores details about total SUI harvested by a pool and the last time a fee was distributed to the user who triggered the public harvest functions.

[PoolFeeInfo]

Holds the fee rates of a pool.

[Flashloan]

A non-droppable Flash loan struct.

Last updated