pool state

GetPoolCount

GetPoolCount returns the total number of pools.

GetPoolPaths

GetPoolPaths returns a paginated list of pool paths.

ExistsPoolPath

ExistsPoolPath checks if a pool exists at the given path.

GetBalances

GetBalances returns the balances of the pool.

GetBalanceToken0

GetBalanceToken0 returns the balance of token0 in the pool.

GetBalanceToken1

GetBalanceToken1 returns the balance of token1 in the pool.

GetFee

GetFee returns the fee tier of the pool.

GetFeeAmountTickSpacings

GetFeeAmountTickSpacings returns all fee tier to tick spacing mappings.

GetFeeAmountTickSpacing

GetFeeAmountTickSpacing retrieves the mapping between fee amounts and tick spacing. This mapping determines the tick spacing for each supported fee tier.

GetFeeGrowthGlobal0X128

GetFeeGrowthGlobal0X128 returns the global fee growth for token0.

GetFeeGrowthGlobal1X128

GetFeeGrowthGlobal1X128 returns the global fee growth for token1.

GetFeeGrowthGlobalX128

GetFeeGrowthGlobalX128 returns the global fee growth for both tokens.

GetLiquidity

GetLiquidity returns the current liquidity in the pool.

GetObservation

GetObservation returns observation data for calculating time-weighted averages.

GetPoolCreationFee

GetPoolCreationFee retrieves the pool creation fee amount.

GetPositionFeeGrowthInside0LastX128

GetPositionFeeGrowthInside0LastX128 returns the last recorded fee growth inside for token0.

GetPositionFeeGrowthInside1LastX128

GetPositionFeeGrowthInside1LastX128 returns the last recorded fee growth inside for token1.

GetPositionFeeGrowthInsideLastX128

GetPositionFeeGrowthInsideLastX128 returns the last recorded fee growth inside for both tokens.

GetPoolPositionCount

GetPoolPositionCount returns the number of positions in a pool.

GetPoolPositionKeys

GetPoolPositionKeys returns a paginated list of position keys in a pool.

GetPositionLiquidity

GetPositionLiquidity returns the liquidity of a position.

GetPositionTokensOwed0

GetPositionTokensOwed0 returns the amount of token0 owed to a position.

GetPositionTokensOwed1

GetPositionTokensOwed1 returns the amount of token1 owed to a position.

GetPositionTokensOwed

GetPositionTokensOwedInfos returns the amount of tokens owed for both tokens.

GetProtocolFeesToken0

GetProtocolFeesToken0 returns accumulated protocol fees for token0.

GetProtocolFeesToken1

GetProtocolFeesToken1 returns accumulated protocol fees for token1.

GetProtocolFeesTokens

GetProtocolFeesTokens returns the accumulated protocol fees for both tokens.

GetSlot0FeeProtocol

GetSlot0FeeProtocol retrieves the protocol fee percentage for slot0.

GetSlot0SqrtPriceX96

GetSlot0SqrtPriceX96 returns the current sqrt price from slot0.

GetSlot0Tick

GetSlot0Tick returns the current tick from slot0.

GetSlot0Unlocked

GetSlot0Unlocked returns the locked status from slot0.

GetTickCumulativeOutside

GetTickCumulativeOutside returns the tick cumulative value outside a tick.

GetTickFeeGrowthOutside0X128

GetTickFeeGrowthOutside0X128 returns fee growth outside for token0 at a tick.

GetTickFeeGrowthOutside1X128

GetTickFeeGrowthOutside1X128 returns fee growth outside for token1 at a tick.

GetTickFeeGrowthOutsideX128

GetTickFeeGrowthOutsideX128 returns fee growth outside for both tokens at a tick.

GetTickInitialized

GetTickInitialized returns whether a tick is initialized.

GetInitializedTicksInRange

GetInitializedTicksInRange returns initialized ticks within the given range.

GetTickLiquidityGross

GetTickLiquidityGross returns the total liquidity that references a tick.

GetTickLiquidityNet

GetTickLiquidityNet returns the net liquidity change at a tick.

GetTickSecondsOutside

GetTickSecondsOutside returns seconds spent outside a tick.

GetTickSecondsPerLiquidityOutsideX128

GetTickSecondsPerLiquidityOutsideX128 returns seconds per liquidity outside a tick.

GetTickSpacing

GetTickSpacing returns the tick spacing of the pool.

GetToken0Path

GetToken0Path returns the path of token0 in the pool.

GetToken1Path

GetToken1Path returns the path of token1 in the pool.

GetWithdrawalFee

GetWithdrawalFee returns the current withdrawal fee rate.

GetTWAP

GetTWAP returns the time-weighted average price for a pool. Returns arithmetic mean tick and harmonic mean liquidity over the time period.

GetPool

GetPool returns a copy of the pool for the given token pair and fee tier.

GetTickInfo

GetTickInfo returns the tick info for a given tick.

GetTickBitmaps

GetTickBitmaps returns the tick bitmap for a given word position.

GetPosition

GetPosition returns the position info for a given key.

GetObservationState

GetObservationState returns the observation state for a given pool path.

cloneStringSlice

cloneInt32Slice

cloneFeeAmountTickSpacings

clonePositionInfo

cloneObservationState

clonePool

clonePoolTicks

clonePoolTickBitmaps

cloneStringInt64Map

NewDefaultPositionInfo

ObservationState

ObservationState manages the oracle's historical data

Observation

NewObservationState

NewObservation

NewDefaultObservation

Pool

type Pool describes a single Pool's state A pool is identificed with a unique key (token0, token1, fee), where token0 \< token1

NewPool

NewPoolsTree

NewPoolTicksTree

NewPoolTicksTree creates a BPTree for storing pool tick info (fanout 32), owned by the pool domain realm so leaf-slot writes are not readonly tainted.

NewPoolPositionsTree

NewPoolPositionsTree creates a BPTree for storing pool position info (fanout 16), owned by the pool domain realm so leaf-slot writes are not readonly tainted.

TokenPair

NewTokenPair

Slot0

NewSlot0

TickInfo

TickInfo stores information about a specific tick in the pool. TIcks represent discrete price points that can be used as boundaries for positions.

NewTickInfo

PositionInfo

PositionInfo stores liquidity and fee state for a position. Liquidity and fee-growth fields are stored as decimal strings to reduce storage cost, while transferable owed amounts stay as int64 for token transfer boundaries.

NewPositionInfo

NewDefaultFeeAmountTickSpacing

CreatePool

CreatePool creates a new liquidity pool for a token pair. Parameters: - token0Path: path of the first token - token1Path: path of the second token - fee: pool fee tier - sqrtPriceX96: initial sqrt price (Q64.96 format)

SetPoolCreationFee

SetPoolCreationFee stores the pool creation fee amount.

IncreaseObservationCardinalityNext

IncreaseObservationCardinalityNext increases the observation cardinality for a pool. Parameters: - token0Path: path of the first token - token1Path: path of the second token - fee: pool fee tier - cardinalityNext: new observation cardinality limit

Mint

Mint adds liquidity to a position. Parameters: - token0Path: path of the first token - token1Path: path of the second token - fee: pool fee tier - tickLower: lower tick boundary - tickUpper: upper tick boundary - liquidityAmount: amount of liquidity to add - positionCaller: caller address for the position Returns: - string: amount of token0 added - string: amount of token1 added

Burn

Burn removes liquidity from a position.

Collect

Collect transfers owed tokens from a position to recipient.

SetWithdrawalFee

SetWithdrawalFee sets the withdrawal fee rate. Parameters: - fee: withdrawal fee in basis points

HandleWithdrawalFee

HandleWithdrawalFee processes withdrawal fees for a position. Parameters: - token0Path: path of the first token - amount0: amount of token0 to withdraw - token1Path: path of the second token - amount1: amount of token1 to withdraw - positionCaller: caller address for the position Returns: - string: withdrawal fee amount of token0 - string: withdrawal fee amount of token1 - string: net amount of token0 after fees - string: net amount of token1 after fees

Swap

Swap executes a token swap in the pool. Parameters: - token0Path: path of the first token - token1Path: path of the second token - fee: pool fee tier - recipient: recipient address for output tokens - zeroForOne: true if swapping token0 for token1 - amountSpecified: amount to swap (positive for exact input, negative for exact output) - sqrtPriceLimitX96: price limit for the swap - payer: address that will pay for the swap - swapCallback: callback function for token transfer, callbackMarker is used to identify the callback Returns: - string: amount of token0 delta - string: amount of token1 delta

DrySwap

DrySwap simulates a swap without executing it, returning the expected output. This is a read-only operation that does not modify pool state. Used by router for multi-hop swap simulations and by clients for price quotes. Parameters: - token0Path: path of the first token - token1Path: path of the second token - fee: pool fee tier - zeroForOne: true if swapping token0 for token1 - amountSpecified: amount to swap - sqrtPriceLimitX96: price limit for the swap Returns: - string: amount of token0 delta - string: amount of token1 delta - bool: swap success status

SetSwapEndHook

SetSwapEndHook stores the swap end hook function.

SetSwapStartHook

SetSwapStartHook stores the swap start hook function.

SetTickCrossHook

SetTickCrossHook stores the tick cross hook function.

CollectProtocol

CollectProtocol collects protocol fees from a pool. Parameters: - token0Path: path of the first token - token1Path: path of the second token - fee: pool fee tier - recipient: recipient address for fees - amount0Requested: amount of token0 to collect - amount1Requested: amount of token1 to collect Returns: - string: amount of token0 collected - string: amount of token1 collected

SetFeeProtocol

SetFeeProtocol sets the protocol fee rates for a pool. Parameters: - feeProtocol0: protocol fee rate for token0 - feeProtocol1: protocol fee rate for token1

ErrSpoofedRealm

domainPath

currentAddress

kvStore

versionManager

implementation

init.101

initializeDomainStore

getImplementation

getImplementation returns the currently active pool implementation. This function is used by all proxy functions to route calls to the active implementation. If no implementation is set, it panics to prevent invalid state.

updateImplementation

StoreKey

StoreKey defines the keys used for storing pool data in the KV store. These keys are prefixed with the domain address to ensure namespace isolation.

StoreKeyPools

// Map containing all pools

StoreKeyFeeAmountTickSpacing

// Fee tier to tick spacing mapping

StoreKeySlot0FeeProtocol

// Protocol fee percentage

StoreKeyPoolCreationFee

// Pool creation fee amount

StoreKeyPendingProtocolFees

// tokenPath -> amount held locally for protocol\_fee

StoreKeyWithdrawalFeeBPS

// Withdrawal fee in basis points

StoreKeyUnlocked

// Global pool reentrancy lock

StoreKeySwapStartHook

// Swap start hook function

StoreKeySwapEndHook

// Swap end hook function

StoreKeyTickCrossHook

// Tick cross hook function

poolStore

poolStore implements the IPoolStore interface for pool domain storage. It provides type-safe access to pool data stored in the underlying KV store.

NewPoolStore

NewPoolStore creates a new pool store instance with the provided KV store. This function is used by the upgrade system to create storage instances for each implementation.

IPool

IPool interface defines all public methods that must be implemented by pool contract versions. This interface serves as the contract between the proxy layer and implementation versions, ensuring that all versions (v1, v2, v3, etc.) maintain the same public API. This design enables seamless upgrades while maintaining backwards compatibility. When upgrading from v1 to v2, the proxy simply switches the implementation pointer without changing the public interface, ensuring zero downtime and no breaking changes.

IPoolManager

IPoolManager interface defines pool management operations. These methods handle pool creation and fee configuration.

IPoolPosition

IPoolPosition interface defines position management operations. These methods handle liquidity provision and position management.

IPoolSwap

IPoolSwap interface defines swap and protocol fee operations. These methods handle token swaps and protocol fee management.

IPoolGetter

IPoolGetter interface defines data retrieval operations. These methods provide read-only access to pool state and data.

IPoolStore

IPoolStore interface defines the storage abstraction for pool data. This interface provides a clean separation between business logic and storage, allowing different implementations to use the same storage interface. All pool implementations (v1, v2, etc.) use this interface to access and modify pool state, ensuring data consistency across versions.

CallbackMarker

NewCallbackMarker

NewCallbackMarker allocates a CallbackMarker in the pool realm. Construction must happen here because /r/-declared types can only be allocated in their owning realm (interrealm v2 checkConstructionTime). Callers in other realms (e.g. pool/v1 impl) borrow into pool via borrow rule #1 (function defined in /r/ package).

RegisterInitializer

RegisterInitializer registers a new pool implementation version. This function is called by each version (v1, v2, etc.) during initialization to register their implementation with the proxy system. The initializer function creates a new instance of the implementation using the provided poolStore interface. The stateInitializer function creates the initial state for this version. Security: Only contracts within the domain path can register initializers. Each package path can only register once to prevent duplicate registrations.

UpgradeImpl

UpgradeImpl switches the active pool implementation to a different version. This function allows seamless upgrades from one version to another without data migration or downtime. Security: Only admin or governance can perform upgrades. The new implementation must have been previously registered via RegisterInitializer.

GetImplementationPackagePath

GetImplementationPackagePath returns the package path of the currently active implementation.

MAX_TICK

ENCODED_TICK_OFFSET

GetPoolPath

GetPoolPath generates a unique pool path string based on the token paths and fee tier.

EncodeTickKey

EncodeTickKey encodes a tick to a string key for the tick tree.

EncodePositionKey

EncodePositionKey encodes a position range into a fixed-width 20-byte string.

encodeTickKeyToBuffer

DecodeTickKey

DecodeTickKey decodes a string key to a tick.