Read Uniswap v3 price example

docs/source/tutorials/index.rst

@@ -48,6 +48,7 @@ Tutorials and examples
  make-uniswap-swap-in-python
  chainlink-price-feed
  chainlink-native-token
+ uniswap-v3-price-simple
  live-price
  uniswap-v3-liquidity-analysis
  uniswap-v3-price-analysis

docs/source/tutorials/uniswap-v3-price-simple.rst

@@ -0,0 +1,35 @@
+Uniswap v3 price (minimal)
+--------------------------------------------
+
+This is a minimal example code for reading the live price of a single Uniswap v3 pool.
+
+- This example runs on a free Polygon JSON-RPC node.
+
+- It will print out live price for a chosen pool
+
+- It will use a polling approach
+
+To run:
+
+.. code-block:: shell
+
+ python scripts/uniswap-v3-price.py
+
+Example output:
+
+.. code-block:: text
+
+ --------------------------------------------------------------------------------
+ Uniswap pool details
+ Chain 137
+ Pool 0x45dda9cb7c25131df268515131f647d726f50608
+ Token0 USDC
+ Token1 WETH
+ Fee 0.0005
+ --------------------------------------------------------------------------------
+
+ [2024-09-25T15:24:14.419151, block 62,262,906] Price USDC / WETH: 2626.504043965991386673686020
+ [2024-09-25T15:24:20.332237, block 62,262,909] Price USDC / WETH: 2626.504043965991386673686020
+
+.. literalinclude:: ../../../scripts/uniswap-v3-price.py
+ :language: python

eth_defi/uniswap_v3/pool.py

@@ -43,6 +43,12 @@ def __repr__(self):
  def convert_price_to_human(self, tick: int, reverse_token_order=False) -> Decimal:
  """Convert the price obtained through
 
+ Example:
+
+ .. code-block:: python
+
+
+
  :param tick:
  Logarithmic tick from the Uniswap pool
 

scripts/uniswap-v3-price.py

@@ -0,0 +1,74 @@
+"""Read a price of a token from Uniswap v3.
+
+- Very simple
+
+- Uses polling approach
+
+- This script is made for Uniswap v3 on Polygon, using free RPC endpoint
+"""
+
+
+import os
+import time
+import datetime
+
+from eth_defi.provider.multi_provider import create_multi_provider_web3
+from eth_defi.uniswap_v3.pool import fetch_pool_details
+from eth_defi.uniswap_v3.price import get_onchain_price
+
+
+def main():
+ # You can pass your own endpoint in an environment variable
+ json_rpc_url = os.environ.get("JSON_RPC_POLYGON", "https://polygon-rpc.com")
+
+ # Search pair contract addresses using Trading Strategy search: https://tradingstrategy.ai/search
+ # This one is:
+ # https://tradingstrategy.ai/trading-view/polygon/uniswap-v3/eth-usdc-fee-5
+ pool_address = os.environ.get("PAIR_ADDRESS", "0x45dda9cb7c25131df268515131f647d726f50608")
+
+ # Create web3 connection instance
+ web3 = create_multi_provider_web3(json_rpc_url)
+
+ # Get Pool contract ABI file, prepackaged in eth_defi Python package
+ # and convert it to a wrapped Python object
+ pool = fetch_pool_details(web3, pool_address)
+
+ # Print out pool details
+ # token0 and token1 will be always in a random order
+ # and may inverse the price
+ print("-" * 80)
+ print("Uniswap pool details")
+ print("Chain", web3.eth.chain_id)
+ print("Pool", pool_address)
+ print("Token0", pool.token0.symbol)
+ print("Token1", pool.token1.symbol)
+ print("Fee", pool.fee)
+ print("-" * 80)
+
+ inverse = True # Is price inverted for output
+
+ # Keep reading events as they land
+ while True:
+
+ # Record the block number close to our timestamp
+ block_num = web3.eth.get_block_number()
+
+ # Use get_onchain_price() to get a human readable price
+ # in Python Decimal
+ price = get_onchain_price(
+ web3,
+ pool.address,
+ )
+
+ if inverse:
+ price = 1 / price
+
+ timestamp = datetime.datetime.utcnow().isoformat()
+
+ print(f"[{timestamp}, block {block_num:,}] Price {pool.token0.symbol} / {pool.token1.symbol}: {price}")
+
+ # Refresh every 5 seconds
+ time.sleep(5)
+
+if __name__ == "__main__":
+ main()