Reading Whirlpool Accounts

The SDK provides the following methods to fetch and parse data from Whirlpool accounts on-chain.

Fetching Accounts

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

[link to data type]

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.

const fetcher = new AccountFetcher(connection);
const config: WhirlpoolsConfigData = await fetcher.getConfig(CONFIG_PUBLIC_KEY);

const poolAddress = PDAUtil.getPool(...);
const pool: WhirlpoolData = await fetcher.getPool(poolAddress);

2. Parsing fetched AccountInfo data

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

const whirlpoolAccountInfo: Buffer = ...
const whirlpool: WhirlpoolData = ParsableWhirlpool.parse(accountInfoData)

3. Whirlpool Client

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

const context = new WhirlpoolContext(...);
const fetcher = new AccountFetcher(context.provider.connection);
const client = buildWhirlpoolClient(context, fetcher);
const pool = await client.getPool(poolAddress);
const position = await client.getPosition(positionAddress);

const poolData: WhirlpoolData = pool.getData();
const positionData: PositionData = position.getData();

// Perform Action...

const newestData = pool.refreshData();

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.

PDAUtil | @orca-so/whirlpools-sdk