Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Example Usage to Fetch All Whirlpool Accounts with Specified Filters #510

Merged
merged 1 commit into from
Nov 15, 2024
Merged

Add Example Usage to Fetch All Whirlpool Accounts with Specified Filters #510

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions ts-sdk/client/src/gpa/whirlpool.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,25 @@ export function whirlpoolRewardVault3Filter(
} as WhirlpoolFilter;
}

/**
* Fetches all Whirlpool accounts with the specified filters.
*
* This function fetches all Whirlpool accounts from the blockchain that match the specified filters.
* It uses the Whirlpool discriminator to identify Whirlpool accounts and applies additional filters
* provided as arguments.
*
* @param {Rpc<GetProgramAccountsApi>} rpc - The Solana RPC client to fetch program accounts.
* @param {...WhirlpoolFilter[]} filters - The filters to apply when fetching Whirlpool accounts.
* @returns {Promise<Account<Whirlpool>[]>} A promise that resolves to an array of Whirlpool accounts.
*
* @example
* import { address, createSolanaRpc, devnet } from "@solana/web3.js";
* import { fetchAllWhirlpoolWithFilter, whirlpoolWhirlpoolConfigFilter } from "@orca-so/whirlpools-client";
*
* const rpcDevnet = createSolanaRpc(devnet("https://api.devnet.solana.com"));
* const WHIRLPOOLS_CONFIG_ADDRESS_DEVNET = address("FcrweFY1G9HJAHG5inkGB6pKg1HZ6x9UC2WioAfWrGkR");
* const whirlpools = await fetchAllWhirlpoolWithFilter(rpcDevnet, whirlpoolWhirlpoolConfigFilter(WHIRLPOOLS_CONFIG_ADDRESS_DEVNET));
*/
export async function fetchAllWhirlpoolWithFilter(
rpc: Rpc<GetProgramAccountsApi>,
...filters: WhirlpoolFilter[]
Expand Down