Note

We’re in the process of improving the documentation of the project. You will find some docs here, but there’s also some documentation in the README that you might want to look at.

Contents:

• Getting started
  • Installation
  • Initializing the Uniswap class
  • Quoting prices
  • Making trades
  • Pool Methods (v1 only)
  • Liquidity Methods (v1 only)
• Uniswap v4
  • The PoolKey
  • Connecting to Uniswap v4
  • Getting the spot price
  • Quoting a trade
  • Estimating price impact
  • Making a swap
  • Discovering pools
  • Managing liquidity
  • Reading pool state via StateView
• API Reference
  • Uniswap class
  • Uniswap4 class
  • Pools cache class
  • Token class
  • Exceptions
• Command line interface
  • Example usage
  • Usage
• Examples
  • Uniswap v2
  • Uniswap v3
• Supported deployments
  • Using with forks/other chains