-
Notifications
You must be signed in to change notification settings - Fork 150
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.
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
Update doc site and SDK related recommendations #477
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
dc29818
Update recommendations. Fix links to documentation. Restructure sideb…
c5a8846
Fix sidebar label
9f96c19
Fix broken links
45b8ab1
Merge branch 'main' into calintje/update-sdk-recommendations
f9a1481
Reposition image on welcome page
85f55ce
Resolve comments
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
200 changes: 200 additions & 0 deletions
200
docs/whirlpool/docs/03-Whirlpools SDKs/01-Whirlpools Client.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| --- | ||
| sidebar_label: Whirlpools Client | ||
| --- | ||
| import Tabs from '@theme/Tabs'; | ||
| import TabItem from '@theme/TabItem'; | ||
|
|
||
| # Orca Whirlpools Client SDK | ||
|
|
||
| ## Overview | ||
| This SDK provides developers with low-level functionalities for interacting with the Whirlpool Program on Solana. It serves as a foundational tool that allows developers to manage and integrate detailed operations into their Typescript projects, particularly those related to Orca's Whirlpool Program. While a high-level SDK is available for easier integration, this package offers more granular control for advanced use cases. | ||
|
|
||
| ## Key Features | ||
| - **Codama Client**: The package includes a set of generated client code based on the Whirlpool Program IDL. This ensures all the necessary program information is easily accessible in a structured format and handles all decoding and encoding of instructions and account data, making it much easier to interact with the program. | ||
| - **GPA (Get Program Accounts) Filters**: This feature contains utilities to add filters to program accounts, allowing developers to fetch program account data more selectively and efficiently. | ||
| - **PDA (Program Derived Addresses) Utilities**: This feature contains utility functions that help derive Program Derived Addresses (PDAs) for accounts within the Whirlpool Program, simplifying address generation for developers. | ||
|
|
||
| ## Installation: | ||
|
|
||
| <Tabs groupId="programming-languages"> | ||
| <TabItem value="ts" label="Typescript" default> | ||
| **NOTE**: This SDK requires Solana Web3.js SDK v2, which is currently in Release Candidate (RC) status. It is not compatible with the widely used v1.x.x version. | ||
| ```bash | ||
| npm install @orca-so/whirlpools-client | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="rust" label="Rust"> | ||
| **NOTE**: This SDK requires Solana Web3.js SDK v2. | ||
| ```bash | ||
| cargo add orca_whirlpools_client | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ## Usage | ||
| Here are some basic examples of how to use the package. | ||
|
|
||
| ### Fetching Whirlpool Accounts with Filters | ||
| The following example demonstrates how to fetch Whirlpools accounts based on specific filters, using the GPA utilities: | ||
|
|
||
| <Tabs groupId="programming-languages"> | ||
| <TabItem value="ts" label="Typescript" default> | ||
| ```tsx | ||
| import { createSolanaRpc, address, devnet } from '@solana/web3.js'; | ||
| import { fetchAllWhirlpoolWithFilter, whirlpoolTokenMintAFilter } from "@orca-so/whirlpools-client"; | ||
|
|
||
| const rpc = createSolanaRpc(devnet("https://api.devnet.solana.com")); | ||
|
|
||
| const tokenMintA = address("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k"); //DevUSDC | ||
| const filter = whirlpoolTokenMintAFilter(tokenMintA); | ||
|
|
||
| const accounts = await fetchAllWhirlpoolWithFilter(rpc, filter); | ||
| console.log(accounts); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="rust" label="Rust"> | ||
| `orca_whirlpools_client` currently does not support fetching accounts with filters. | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
|
|
||
|
|
||
| ### Deriving a PDA | ||
| To derive a PDA for a Whirlpool account, you can use the `getWhirlpoolAddress` PDA utility. | ||
|
|
||
| <Tabs groupId="programming-languages"> | ||
| <TabItem value="ts" label="Typescript" default> | ||
| ```tsx | ||
| import { getWhirlpoolAddress } from "@orca-so/whirlpools-client"; | ||
| import { address } from '@solana/web3.js'; | ||
|
|
||
| const whirlpoolConfigAddress = address("FcrweFY1G9HJAHG5inkGB6pKg1HZ6x9UC2WioAfWrGkR"); | ||
| const tokenMintA = address("So11111111111111111111111111111111111111112"); //wSOL | ||
| const tokenMintB = address("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k"); //DevUSDC | ||
| const tickSpacing = 64; | ||
|
|
||
| const whirlpoolPda = await getWhirlpoolAddress( | ||
| whirlpoolConfigAddress, | ||
| tokenMintA, | ||
| tokenMintB, | ||
| tickSpacing, | ||
| ); | ||
| console.log(whirlpoolPda); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="rust" label="Rust"> | ||
| ```rust | ||
| use orca_whirlpools_client::get_whirlpool_address; | ||
| use solana_sdk::pubkey::Pubkey; | ||
| use std::str::FromStr; | ||
|
|
||
| fn main() { | ||
| let whirlpool_config_address = Pubkey::from_str("FcrweFY1G9HJAHG5inkGB6pKg1HZ6x9UC2WioAfWrGkR").unwrap(); | ||
| let token_mint_a = Pubkey::from_str("So11111111111111111111111111111111111111112").unwrap(); // wSOL | ||
| let token_mint_b = Pubkey::from_str("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k").unwrap(); // DevUSDC | ||
| let tick_spacing = 64; | ||
|
|
||
| let (whirlpool_pda, _bump) = get_whirlpool_address(&whirlpool_config_address, &token_mint_a, &token_mint_b, tick_spacing).unwrap(); | ||
| println!("{:?}", whirlpool_pda); | ||
| } | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| ### Example: Initialize Pool Instruction | ||
| The following example demonstrates how to create an InitializePool instruction using the Codama-IDL autogenerated code: | ||
|
|
||
| <Tabs groupId="programming-languages"> | ||
| <TabItem value="ts" label="Typescript" default> | ||
| ```tsx | ||
| import { getInitializePoolV2Instruction, getTokenBadgeAddress, getWhirlpoolAddress, getFeeTierAddress } from "@orca-so/whirlpools-client"; | ||
| import { address, generateKeyPairSigner } from '@solana/web3.js'; | ||
|
|
||
| const whirlpoolConfigAddress = address("FcrweFY1G9HJAHG5inkGB6pKg1HZ6x9UC2WioAfWrGkR"); | ||
| const tokenMintA = address("So11111111111111111111111111111111111111112"); // wSOL | ||
| const tokenMintB = address("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k"); // DevUSDC | ||
| const tokenBadgeA = await getTokenBadgeAddress(whirlpoolConfigAddress, tokenMintA) | ||
| const tokenBadgeB = await getTokenBadgeAddress(whirlpoolConfigAddress, tokenMintB) | ||
| const wallet = await generateKeyPairSigner(); // CAUTION: this wallet is not persistent | ||
| const tickSpacing = 8; | ||
| const whirlpool = await getWhirlpoolAddress(whirlpoolConfigAddress, tokenMintA, tokenMintB, tickSpacing); | ||
| const tokenVaultA = await generateKeyPairSigner(); | ||
| const tokenVaultB = await generateKeyPairSigner(); | ||
| const feeTier = await getFeeTierAddress(whirlpoolConfigAddress, tickSpacing); | ||
| const tokenProgramA = address("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"); | ||
| const tokenProgramB = address("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA"); | ||
| const initialSqrtPrice = BigInt(7459106261056563200n); | ||
|
|
||
| const initializePoolInstruction = getInitializePoolV2Instruction({ | ||
| whirlpoolsConfig: whirlpoolConfigAddress, | ||
| tokenMintA, | ||
| tokenMintB, | ||
| tokenBadgeA, | ||
| tokenBadgeB, | ||
| funder: wallet, | ||
| whirlpool, | ||
| tokenVaultA, | ||
| tokenVaultB, | ||
| feeTier, | ||
| whirlpoolBump: 1, | ||
| tickSpacing, | ||
| tokenProgramA, | ||
| tokenProgramB, | ||
| initialSqrtPrice | ||
| }); | ||
|
|
||
| console.log(initializePoolInstruction); | ||
| ``` | ||
| </TabItem> | ||
| <TabItem value="rust" label="Rust"> | ||
| ```rust | ||
| use orca_whirlpools_client::{ | ||
| instructions::InitializePoolV2Builder, | ||
| get_fee_tier_address, | ||
| get_token_badge_address, | ||
| get_whirlpool_address, | ||
| }; | ||
| use solana_sdk::{ | ||
| pubkey::Pubkey, | ||
| signer::{keypair::Keypair, Signer}, | ||
| }; | ||
| use std::str::FromStr; | ||
|
|
||
| fn main() { | ||
| let whirlpool_config_address = Pubkey::from_str("FcrweFY1G9HJAHG5inkGB6pKg1HZ6x9UC2WioAfWrGkR").unwrap(); | ||
| let token_mint_a = Pubkey::from_str("So11111111111111111111111111111111111111112").unwrap(); // wSOL | ||
| let token_mint_b = Pubkey::from_str("BRjpCHtyQLNCo8gqRUr8jtdAj5AjPYQaoqbvcZiHok1k").unwrap(); // DevUSDC | ||
| let (token_badge_a, _bump) = get_token_badge_address(&whirlpool_config_address, &token_mint_a).unwrap(); | ||
| let (token_badge_b, _bump) = get_token_badge_address(&whirlpool_config_address, &token_mint_b).unwrap(); | ||
| let wallet = Keypair::new(); // CAUTION: this wallet is not persistent | ||
| let tick_spacing = 8; | ||
| let (whirlpool_pda, _bump) = get_whirlpool_address(&whirlpool_config_address, &token_mint_a, &token_mint_b, tick_spacing).unwrap(); | ||
| let token_vault_a = Keypair::new(); | ||
| let token_vault_b = Keypair::new(); | ||
| let (fee_tier, _bump) = get_fee_tier_address(&whirlpool_config_address, tick_spacing).unwrap(); | ||
| let token_program_a = Pubkey::from_str("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA").unwrap(); | ||
| let token_program_b = Pubkey::from_str("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA").unwrap(); | ||
| let initial_sqrt_price = 7459106261056563200u128; | ||
|
|
||
| let initialize_pool_v2_instruction = InitializePoolV2Builder::new() | ||
| .whirlpools_config(whirlpool_config_address) | ||
| .token_mint_a(token_mint_a) | ||
| .token_mint_b(token_mint_b) | ||
| .token_badge_a(token_badge_a) | ||
| .token_badge_b(token_badge_b) | ||
| .funder(wallet.pubkey()) | ||
| .whirlpool(whirlpool_pda) | ||
| .token_vault_a(token_vault_a.pubkey()) | ||
| .token_vault_b(token_vault_b.pubkey()) | ||
| .fee_tier(fee_tier) | ||
| .token_program_a(token_program_a) | ||
| .token_program_b(token_program_b) | ||
| .tick_spacing(tick_spacing) | ||
| .initial_sqrt_price(initial_sqrt_price) | ||
| .instruction(); | ||
|
|
||
| println!("{:?}", initialize_pool_v2_instruction); | ||
| } | ||
| ``` | ||
| </TabItem> | ||
| </Tabs> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: percent encoding in the url looks kinda ugly here. Is it needed?