Monitor pools

1. Overview of Pool Monitoring

Fetching liquidity pool details helps developers gain insight into the current state of the pool, whether it is initialized or uninitialized, and retrieve relevant metrics like liquidity, price, and fee rates. The SDKs offer three main functions to help developers monitor the pools:

Fetch Splash Pool: Fetches the details of a specific Splash Pool.
Fetch Concentrated Liquidity Pool: Fetches the details of a specific Concentrated Liquidity Pool.
Fetch Pools: Fetches all possible liquidity pools between two token mints, with various tick spacings.

Initialized vs. Uninitialized Pools

Each token pair can have multiple pools based on different tick spacings, corresponding to various fee tiers. When fetching pool data, it’s possible to request a pool with a tick spacing that hasn’t been used to create a pool for the given token pair. In this case, you’ll receive a pool object with default parameters and an indication that the pool has not been set up. When fetching all pools for a token pair, which iterates through all possible tick spacings, both initialized and uninitialized pools can be returned, allowing you to identify pools that have not yet been created.

2. Getting Started Guide

Fetching a pool by Address

If you already have the address of a Whirlpool:

Whirlpool Address: Provide the address of the specific Whirlpool you want to fetch.
Fetch Pool Details: Use the function to fetch the details of the Whirlpool at the provided address.

use orca_whirlpools_client::fetch_whirlpool;
use solana_client::rpc_client::RpcClient;
use solana_sdk::pubkey::Pubkey;
use std::str::FromStr;

#[tokio::main]
async fn main() {
    let rpc = RpcClient::new("https://api.devnet.solana.com".to_string());

    // SOL/devUSDC
    let whirlpool_address =
        Pubkey::from_str("3KBZiL2g8C7tiJ32hTv5v3KM7aK9htpqTw4cTXz1HvPt").unwrap();

    let whirlpool = fetch_whirlpool(&rpc, &whirlpool_address).unwrap();

    println!("Pool data: {:?}", whirlpool.data);
}

import { fetchWhirlpool } from "@orca-so/whirlpools-client";
import { address, createSolanaRpc, devnet } from "@solana/kit";

const devnetRpc = createSolanaRpc(devnet("https://api.devnet.solana.com"));
const whirlpoolAddress = address(
	"3KBZiL2g8C7tiJ32hTv5v3KM7aK9htpqTw4cTXz1HvPt",
); // SOL/devUSDC

const whirlpool = await fetchWhirlpool(devnetRpc, whirlpoolAddress);

console.log("Pool data:", whirlpool.data);

Fetching a Splash Pool by Token Pair

Token Mint Addresses: Provide the mint addresses of the two tokens that make up the liquidity pool.
Fetch Pool Details: Use the appropriate function to fetch the details of the specified Splash Pool.

use orca_whirlpools::{fetch_splash_pool, PoolInfo, WhirlpoolDeployment};
use solana_client::nonblocking::rpc_client::RpcClient;
use solana_sdk::pubkey::Pubkey;
use std::str::FromStr;

#[tokio::main]
async fn main() {
    let rpc = RpcClient::new("https://api.devnet.solana.com".to_string());
    let token_a = Pubkey::from_str("So11111111111111111111111111111111111111112").unwrap(); // SOL
    let token_b = Pubkey::from_str("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k").unwrap(); // devUSDC

    let pool_info = fetch_splash_pool(&rpc, token_a, token_b, Some(WhirlpoolDeployment::devnet()))
        .await
        .unwrap();

    match pool_info {
        PoolInfo::Initialized(pool) => println!("Pool is initialized: {:?}", pool),
        PoolInfo::Uninitialized(pool) => println!("Pool is not initialized: {:?}", pool),
    }
}

import { fetchWhirlpool } from "@orca-so/whirlpools-client";
import { address, createSolanaRpc, devnet } from "@solana/kit";

const devnetRpc = createSolanaRpc(devnet("https://api.devnet.solana.com"));
const whirlpoolAddress = address(
	"3KBZiL2g8C7tiJ32hTv5v3KM7aK9htpqTw4cTXz1HvPt",
); // SOL/devUSDC

const whirlpool = await fetchWhirlpool(devnetRpc, whirlpoolAddress);

console.log("Pool data:", whirlpool.data);

Fetching a Concentrated Liquidity Pool by Token Pair

Token Mint Addresses: Provide the mint addresses of the two tokens that make up the liquidity pool.
Tick Spacing: Specify the tick spacing, which defines the intervals for price ticks.
Fetch Pool Details: Use the appropriate function to fetch the details of the specified Concentrated Liquidity Pool.

use orca_whirlpools::{fetch_concentrated_liquidity_pool, PoolInfo, WhirlpoolDeployment};
use solana_client::nonblocking::rpc_client::RpcClient;
use solana_sdk::pubkey::Pubkey;
use std::str::FromStr;

#[tokio::main]
async fn main() {
    let rpc = RpcClient::new("https://api.devnet.solana.com".to_string());
    let token_a = Pubkey::from_str("So11111111111111111111111111111111111111112").unwrap(); // SOL
    let token_b = Pubkey::from_str("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k").unwrap(); // devUSDC
    let tick_spacing = 64;

    let pool_info = fetch_concentrated_liquidity_pool(
        &rpc,
        token_a,
        token_b,
        tick_spacing,
        Some(WhirlpoolDeployment::devnet()),
    )
    .await
    .unwrap();

    match pool_info {
        PoolInfo::Initialized(pool) => println!("Pool is initialized: {:?}", pool),
        PoolInfo::Uninitialized(pool) => println!("Pool is not initialized: {:?}", pool),
    }
}

import {
	fetchConcentratedLiquidityPool,
	WhirlpoolDeployment,
} from "@orca-so/whirlpools";
import { address, createSolanaRpc, devnet } from "@solana/kit";

const devnetRpc = createSolanaRpc(devnet("https://api.devnet.solana.com"));

const tokenMintA = address("So11111111111111111111111111111111111111112");
const tokenMintB = address("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k");
const tickSpacing = 64;

const poolInfo = await fetchConcentratedLiquidityPool(
	devnetRpc,
	tokenMintA,
	tokenMintB,
	tickSpacing,
	WhirlpoolDeployment.devnet,
);

if (poolInfo.initialized) {
	console.log("Pool is initialized:", poolInfo);
} else {
	console.log("Pool is not initialized:", poolInfo);
}

Fetching Pools by Token Pairs

Token Mint Addresses: Provide the mint addresses of the two tokens that make up the liquidity pool.
Fetch Pool Details: Use the appropriate function to fetch the details of all pools for the specified token pair.

use orca_whirlpools::{fetch_whirlpools_by_token_pair, PoolInfo, WhirlpoolDeployment};
use solana_client::nonblocking::rpc_client::RpcClient;
use solana_sdk::pubkey::Pubkey;
use std::str::FromStr;

#[tokio::main]
async fn main() {
    let rpc = RpcClient::new("https://api.devnet.solana.com".to_string());
    let token_a = Pubkey::from_str("So11111111111111111111111111111111111111112").unwrap(); // SOL
    let token_b = Pubkey::from_str("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k").unwrap(); // devUSDC

    let pool_infos =
        fetch_whirlpools_by_token_pair(&rpc, token_a, token_b, Some(WhirlpoolDeployment::devnet()))
            .await
            .unwrap();

    for pool_info in pool_infos {
        match pool_info {
            PoolInfo::Initialized(pool) => println!("Pool is initialized: {:?}", pool),
            PoolInfo::Uninitialized(pool) => println!("Pool is not initialized: {:?}", pool),
        }
    }
}

import {
	fetchWhirlpoolsByTokenPair,
	WhirlpoolDeployment,
} from "@orca-so/whirlpools";
import { address, createSolanaRpc, devnet } from "@solana/kit";

const devnetRpc = createSolanaRpc(devnet("https://api.devnet.solana.com"));

const tokenMintA = address("So11111111111111111111111111111111111111112");
const tokenMintB = address("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k");

const poolInfos = await fetchWhirlpoolsByTokenPair(
	devnetRpc,
	tokenMintA,
	tokenMintB,
	WhirlpoolDeployment.devnet,
);

for (const poolInfo of poolInfos) {
	if (poolInfo.initialized) {
		console.log("Pool is initialized:", poolInfo);
	} else {
		console.log("Pool is not initialized:", poolInfo);
	}
}

3. Using Pool Data

After fetching pool information, you can use it to:

Check if Pool Exists: Determine if a pool for a specific token pair and tick spacing has been created.
Monitor Liquidity: Track the amount of liquidity in the pool over time.
Track Prices: Monitor the current price of tokens in the pool.
Calculate Fees: Calculate expected fees based on the pool’s fee rate and volume.
Data Analytics: Build analytics dashboards tracking pool performance and metrics.

4. Best Practices

When monitoring pools, consider these best practices:

Caching: Implement caching to reduce RPC calls, especially for frequently accessed pools.
Error Handling: Properly handle cases where pools might not exist.
Batch Requests: When possible, batch your requests to reduce the number of RPC calls.
Rate Limiting: Be mindful of RPC rate limits when monitoring multiple pools.
Data Freshness: Determine how recent the data needs to be for your application.

Getting Started

Architecture

SDKs

Examples

Resources

Reference

1. Overview of Pool Monitoring

Initialized vs. Uninitialized Pools

2. Getting Started Guide

Fetching a pool by Address

Fetching a Splash Pool by Token Pair

Fetching a Concentrated Liquidity Pool by Token Pair

Fetching Pools by Token Pairs

3. Using Pool Data

4. Best Practices

​1. Overview of Pool Monitoring

​Initialized vs. Uninitialized Pools

​2. Getting Started Guide

​Fetching a pool by Address

​Fetching a Splash Pool by Token Pair

​Fetching a Concentrated Liquidity Pool by Token Pair

​Fetching Pools by Token Pairs

​3. Using Pool Data

​4. Best Practices

1. Overview of Pool Monitoring

Initialized vs. Uninitialized Pools

2. Getting Started Guide

Fetching a pool by Address

Fetching a Splash Pool by Token Pair

Fetching a Concentrated Liquidity Pool by Token Pair

Fetching Pools by Token Pairs

3. Using Pool Data

4. Best Practices