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.

Fetching Accounts

The TypeScript SDK has types setup to help you parse the corresponding accounts on-chain.

1. Account Fetcher

Use the AccountFetcher class’s get functions to fetch and parse the Whirlpool account that you need. Note that this class also provides caching options.

TypeScript

import { ORCA_WHIRLPOOL_PROGRAM_ID, PDAUtil } from "@orca-so/whirlpools-sdk";
import { PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const DEVNET_WHIRLPOOLS_CONFIG = new PublicKey(
	"FcrweFY1G9HJAHG5inkGB6pKg1HZ6x9UC2WioAfWrGkR",
);
const tokenAddressA = new PublicKey(
	"So11111111111111111111111111111111111111112",
); // SOL
const tokenAddressB = new PublicKey(
	"BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k",
); // devUSDC

const ctx = getCtx();

const poolAddress = PDAUtil.getWhirlpool(
	ORCA_WHIRLPOOL_PROGRAM_ID,
	DEVNET_WHIRLPOOLS_CONFIG,
	tokenAddressA,
	tokenAddressB,
	64,
);
const pool = await ctx.fetcher.getPool(poolAddress.publicKey);

console.log(pool);

2. Parsing fetched AccountInfo data

If you already have the Buffer from fetching the AccountInfo, use the Parsables classes (eg. ParsableWhirlpool) in the SDK to parse account buffer data into readable types.

TypeScript

import { exit } from "node:process";
import { ParsableWhirlpool } from "@orca-so/whirlpools-sdk";
import { type AccountInfo, PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const ctx = getCtx();

const whirlpoolAddress = new PublicKey(
	"3KBZiL2g8C7tiJ32hTv5v3KM7aK9htpqTw4cTXz1HvPt",
); // SOL/devUSDC

const whirlpoolData = await ctx.connection.getAccountInfo(whirlpoolAddress);

if (!whirlpoolData) {
	console.log("Invalid whirlpool");
	exit();
}

const whirlpoolAccountInfo: AccountInfo<Buffer> = whirlpoolData;
const whirlpool = ParsableWhirlpool.parse(
	whirlpoolAddress,
	whirlpoolAccountInfo,
);

console.log(whirlpool);

Whirlpool Client

If you are already using WhirlpoolClient, you can fetch the data from the Whirlpool or Position class directly.

TypeScript

import { buildWhirlpoolClient } from "@orca-so/whirlpools-sdk";
import { PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const ctx = getCtx();
const client = buildWhirlpoolClient(ctx);
const whirlpoolAddress = new PublicKey(
	"3KBZiL2g8C7tiJ32hTv5v3KM7aK9htpqTw4cTXz1HvPt",
); // SOL/devUSDC

const pool = await client.getPool(whirlpoolAddress);

const poolData = pool.getData();

console.log(poolData);

// Perform Action...

const newestData = await pool.refreshData();

console.log(newestData);

Deriving Account Addresses

Almost all Whirlpools accounts are Program Derived Addresses. Use the PDAUtil class to derive the required addresses to access on-chain accounts.

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

Fetching Accounts

1. Account Fetcher

2. Parsing fetched AccountInfo data

Whirlpool Client

Deriving Account Addresses

3. Using Pool Data

4. Best Practices

​1. Overview of Pool Monitoring

​Fetching Accounts

​1. Account Fetcher

​2. Parsing fetched AccountInfo data

​Whirlpool Client

​Deriving Account Addresses

​3. Using Pool Data

​4. Best Practices

1. Overview of Pool Monitoring

Fetching Accounts

1. Account Fetcher

2. Parsing fetched AccountInfo data

Whirlpool Client

Deriving Account Addresses

3. Using Pool Data

4. Best Practices