Uniswap / docs

đŸ““ Uniswap V3 docs website
https://docs.uniswap.org
317 stars 526 forks source link

add IPoolManager reference guide with mdx formatting #760

Closed krisoshea-eth closed 1 month ago

krisoshea-eth commented 1 month ago

This PR introduces a reference guide for the IPoolManager interface in Uniswap V4.

Key Features of the Document:

  1. Introduction to the IPoolManager interface and its role in Uniswap V4
  2. Detailed explanations of key structures:
    • ModifyLiquidityParams
    • SwapParams
  3. Comprehensive breakdown of core methods:
    • initialize
    • unlock
    • modifyLiquidity
    • swap
    • donate
  4. For each method:
    • Solidity function signature
    • Description of functionality
    • Table of input parameters
    • Description of return values
  5. Important notes on specific behaviors (e.g., fee collection in modifyLiquidity)

Document Structure:

Impact and Importance:

The IPoolManager interface is the primary point of interaction for operations like initializing pools, modifying liquidity, executing swaps, and donating to pools. Understanding these methods is essential for anyone implementing, integrating, or building on top of Uniswap V4.

vercel[bot] commented 1 month ago

@krisoshea-eth is attempting to deploy a commit to the Uniswap Team on Vercel.

A member of the Team first needs to authorize it.