Environment Setup

Rust
TypeScript

Prerequisites

Before you start, ensure you have Rust installed. To ensure compatibility with the Solana SDK v3, we recommend using rustc 1.86.0.

1. Initialize a new project

Initialize a new Rust project:

cargo new <project-name>

Add the necessary dependencies to your project:

cargo add orca_whirlpools orca_tx_sender solana-sdk solana-client solana_commitment_config tokio serde_json

Note: If you’re using the Rust SDK in an already existing project which does not use the latest version of Solana SDK, you may need to apply a patchfile lock with the following command:

cargo update solana-sdk:<current-version> --precise <required-version>

You might also have to apply lockfile patches for solana-program, solana-client, solana-account-decoder, spl-token, spl-memo, spl-token-2022, spl-associated-token-account.

2. Wallet Management

You can generate a file system wallet using the Solana CLI and load it in your program.

  use solana_sdk::signature::Keypair;

  /// `KEYPAIR` must be set in env.
  ///
  /// Example:
  ///     KEYPAIR="[229,10,196,219,228,214...]"
  pub fn load_wallet() -> Keypair {
      dotenvy::dotenv().ok();

      let keypair = std::env::var("KEYPAIR").expect("KEYPAIR in .env");

      // Alternatively, if using a JSON file wallet
      // let keypair = fs::read_to_string("path/to/wallet.json").unwrap();

      let bytes = serde_json::from_str::<Vec<u8>>(&keypair).expect("Keypair bytes");

      let keypair = Keypair::try_from(&bytes as &[u8]).expect("Valid keypair bytes");

      keypair
  }

⚠️ Important: Never share your private key publicly.

3. Airdrop SOL to Your Wallet

Once your wallet is created, you will need some SOL to pay for transactions. You can request an airdrop of SOL from the network, but this is only available on Solana Devnet.

use solana_client::rpc_client::RpcClient;  
use solana_sdk::signature::Signer;  
  
fn main() {  
  // Rest of the code  
  let rpc_client = RpcClient::new("https://api.devnet.solana.com");  
  match rpc_client.request_airdrop(&wallet.pubkey(), 1_000_000_000) {  
      Ok(signature) => println!("Airdrop successful. Transactoin signature: {:?}", signature),  
      Err(e) => println!("Error: {:?}", e),  
  }  
}

4. Set the default funder for Transactions

After funding your wallet, you can set the wallet as the FUNDER for future transactions within the SDK. The funder is the account that will cover the transaction costs for initializing pools, providing liquidity, etc.

use orca_whirlpools::set_funder; 
use solana_sdk::signature::Signer;  
  
fn main() {  
  // Rest of the code  
  set_funder(wallet.pubkey()).unwrap();  
}

Prerequisites

Before you start, ensure you have Node.js version 20 or higher installed on your machine. Download it from the official website: https://nodejs.org/.

1. Initialize a new project

Create a new project directory:

mkdir <project-name>  
cd <project-name>

Initialize a new Node.js project:

npm init -y && npm pkg set type="module"

Install the necessary packages:

npm install typescript @orca-so/whirlpools @solana/kit

Initialize the project as a TypeScript project:

npx tsc --init

2. Wallet Management

You can generate a file system wallet using the Solana CLI and load it in your program.

import { createKeyPairSignerFromBytes, type KeyPairSigner } from '@solana/kit';
import 'dotenv/config';

/*
* Load a Solana keypair signer from the `KEYPAIR` env var.
*/
export async function loadWallet(): Promise<KeyPairSigner> {
  const keypair = process.env.KEYPAIR;
  if (!keypair) {
    throw new Error('KEYPAIR not set in .env');
  }

  const bytes = new Uint8Array(JSON.parse(keypair));

  // Alternatively, if using a JSON file wallet
  // const bytes = new Uint8Array(JSON.parse(fs.readFileSync('path/to/solana-keypair.json', 'utf8'))); 
  return createKeyPairSignerFromBytes(bytes);
}

⚠️ Important: Never share your private key publicly.

3. Airdrop SOL to Your Wallet

Once your wallet is created, you will need some SOL to pay for transactions. You can request an airdrop of SOL from the network, but this is only available on Solana Devnet.

import { generateKeyPairSigner, createSolanaRpc, devnet, lamports } from '@solana/kit';  
  
const devnetRpc = createSolanaRpc(devnet('https://api.devnet.solana.com'));  
const wallet = await generateKeyPairSigner();  
devnetRpc.requestAirdrop(  
  wallet.address,  
  lamports(1000000000n)  
).send()

4. Set the default funder for Transactions

import { setDefaultFunder } from '@orca-so/whirlpools';  
  
setDefaultFunder(wallet.address);

Next steps

Once you’ve completed the setup, you can move on to building more complex functionalities using the Orca SDK, such as creating and managing pools, providing liquidity, etc. Refer to individual function documentation to use this wallet setup in action.

Getting Started

Architecture

SDKs

Examples

Resources

Reference

Prerequisites

1. Initialize a new project

2. Wallet Management

3. Airdrop SOL to Your Wallet

4. Set the default funder for Transactions

Prerequisites

1. Initialize a new project

2. Wallet Management

3. Airdrop SOL to Your Wallet

4. Set the default funder for Transactions

Next steps

​Prerequisites

​1. Initialize a new project

​2. Wallet Management

​3. Airdrop SOL to Your Wallet

​4. Set the default funder for Transactions

​Prerequisites

​1. Initialize a new project

​2. Wallet Management

​3. Airdrop SOL to Your Wallet

​4. Set the default funder for Transactions

​Next steps

Prerequisites

1. Initialize a new project

2. Wallet Management

3. Airdrop SOL to Your Wallet

4. Set the default funder for Transactions

Prerequisites

1. Initialize a new project

2. Wallet Management

3. Airdrop SOL to Your Wallet

4. Set the default funder for Transactions

Next steps