Harvesting a Position

1. Overview of Harvesting a Position

Get a quick quote on outstanding fees and rewards

There are use-cases where users would like to check the outstanding values before deciding to perform an on-chain update and harvest. In these cases, use the provided collectFeesQuote and collectRewardsQuote in the Typescript SDK.

TypeScript

import { exit } from "node:process";
import {
	collectFeesQuote,
	collectRewardsQuote,
	PDAUtil,
	TickArrayUtil,
	TickUtil,
	TokenExtensionUtil,
} from "@orca-so/whirlpools-sdk";
import { PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const ctx = getCtx();

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

// Fetching necessary on-chain account data.
const whirlpool = await ctx.fetcher.getPool(whirlpoolAddress);
const position = await ctx.fetcher.getPosition(positionAddress);

if (whirlpool === null || position === null) {
	console.log("Invalid whirlpool or position");
	exit();
}

const lowerTickStartIndex = TickUtil.getStartTickIndex(
	position.tickLowerIndex,
	whirlpool.tickSpacing,
);
const upperTickStartIndex = TickUtil.getStartTickIndex(
	position.tickUpperIndex,
	whirlpool.tickSpacing,
);

const lowerTickArrayPda = PDAUtil.getTickArray(
	ctx.program.programId,
	whirlpoolAddress,
	lowerTickStartIndex,
);
const upperTickArrayPda = PDAUtil.getTickArray(
	ctx.program.programId,
	whirlpoolAddress,
	upperTickStartIndex,
);

const lowerTickArray = await ctx.fetcher.getTickArray(
	lowerTickArrayPda.publicKey,
);
const upperTickArray = await ctx.fetcher.getTickArray(
	upperTickArrayPda.publicKey,
);

if (lowerTickArray === null || upperTickArray === null) {
	console.log("Invalid tick arrays");
	exit();
}

// Get the individual TickData on each tickIndex from the fetched TickArray
const lowerTick = TickArrayUtil.getTickFromArray(
	lowerTickArray,
	position.tickLowerIndex,
	whirlpool.tickSpacing,
);
const upperTick = TickArrayUtil.getTickFromArray(
	upperTickArray,
	position.tickUpperIndex,
	whirlpool.tickSpacing,
);

const tokenExtensionCtx = await TokenExtensionUtil.buildTokenExtensionContext(
	ctx.fetcher,
	whirlpool,
);

const feeQuote = collectFeesQuote({
	whirlpool,
	position,
	tickLower: lowerTick,
	tickUpper: upperTick,
	tokenExtensionCtx,
});

console.log("Fees token A:", feeQuote.feeOwedA.toNumber());
console.log("Fees token A:", feeQuote.feeOwedB.toNumber());

const rewardQuote = collectRewardsQuote({
	whirlpool,
	position,
	tickLower: lowerTick,
	tickUpper: upperTick,
	tokenExtensionCtx,
});

console.log(rewardQuote);
console.log(position);

console.log("Rewards token A:", rewardQuote.rewardOwed[0]?.toNumber() ?? 0);
console.log("Rewards token B:", rewardQuote.rewardOwed[1]?.toNumber() ?? 0);

Update on-chain position with the latest accrued fees

Before you fetch your owed fees, you must update the on-chain position with the latest values by calling increase_liquidity or decrease_liquidity. Alternatively, you can call update_fee_and_rewards to update without modifying liquidity. If this step is skipped, the collect instructions will only fetch the last updated values of the position. In many cases, this will be 0. Sample code on using update_fee_and_rewards:

TypeScript

import { exit } from "node:process";
import { PDAUtil, TickUtil, toTx, WhirlpoolIx } from "@orca-so/whirlpools-sdk";
import { PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const ctx = getCtx();

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

// Fetching necessary on-chain account data.
const whirlpool = await ctx.fetcher.getPool(whirlpoolAddress);
const position = await ctx.fetcher.getPosition(positionAddress);

if (whirlpool === null || position === null) {
	console.log("Invalid whirlpool or position");
	exit();
}

const lowerTickStartIndex = TickUtil.getStartTickIndex(
	position.tickLowerIndex,
	whirlpool.tickSpacing,
);
const upperTickStartIndex = TickUtil.getStartTickIndex(
	position.tickUpperIndex,
	whirlpool.tickSpacing,
);

const lowerTickArrayPda = PDAUtil.getTickArray(
	ctx.program.programId,
	whirlpoolAddress,
	lowerTickStartIndex,
);
const upperTickArrayPda = PDAUtil.getTickArray(
	ctx.program.programId,
	whirlpoolAddress,
	upperTickStartIndex,
);

const signature = await toTx(
	ctx,
	WhirlpoolIx.updateFeesAndRewardsIx(ctx.program, {
		whirlpool: position.whirlpool,
		position: positionAddress,
		tickArrayLower: lowerTickArrayPda.publicKey,
		tickArrayUpper: upperTickArrayPda.publicKey,
	}),
).buildAndExecute();

console.log("Signature: ", signature);

Collect Fees and Rewards

Once the position has been updated, you can use collect_fees and collect_reward to harvest the position.

Collect fee

TypeScript

import { exit } from "node:process";
import { toTx, WhirlpoolIx } from "@orca-so/whirlpools-sdk";
import {
	createAssociatedTokenAccountIdempotentInstruction,
	getAssociatedTokenAddressSync,
	TOKEN_2022_PROGRAM_ID,
} from "@solana/spl-token";
import { PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const ctx = getCtx();

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

const whirlpool = await ctx.fetcher.getPool(whirlpoolAddress);
const position = await ctx.fetcher.getPosition(positionAddress);

if (whirlpool === null || position === null) {
	console.log("Invalid whirlpool or position");
	exit();
}

const positionTokenAccount = getAssociatedTokenAddressSync(
	position.positionMint,
	ctx.provider.wallet.publicKey,
	false,
	TOKEN_2022_PROGRAM_ID,
);
const tokenOwnerAccountA = getAssociatedTokenAddressSync(
	whirlpool.tokenMintA,
	ctx.provider.wallet.publicKey,
);
const tokenOwnerAccountB = getAssociatedTokenAddressSync(
	whirlpool.tokenMintB,
	ctx.provider.wallet.publicKey,
);

const signature = await toTx(
	ctx,
	WhirlpoolIx.collectFeesIx(ctx.program, {
		whirlpool: whirlpoolAddress,
		positionAuthority: ctx.provider.wallet.publicKey,
		position: positionAddress,
		positionTokenAccount,
		tokenOwnerAccountA,
		tokenOwnerAccountB,
		tokenVaultA: whirlpool.tokenVaultA,
		tokenVaultB: whirlpool.tokenVaultB,
	}),
)
	.prependInstruction({
		instructions: [
			createAssociatedTokenAccountIdempotentInstruction(
				ctx.provider.wallet.publicKey,
				tokenOwnerAccountA,
				ctx.provider.wallet.publicKey,
				whirlpool.tokenMintA,
			),
			createAssociatedTokenAccountIdempotentInstruction(
				ctx.provider.wallet.publicKey,
				tokenOwnerAccountB,
				ctx.provider.wallet.publicKey,
				whirlpool.tokenMintB,
			),
		],
		cleanupInstructions: [],
		signers: [],
	})
	.buildAndExecute();

console.log("Signature: ", signature);

Collect rewards

TypeScript

import { exit } from "node:process";
import { toTx, WhirlpoolIx } from "@orca-so/whirlpools-sdk";
import {
	createAssociatedTokenAccountIdempotentInstruction,
	getAssociatedTokenAddressSync,
	TOKEN_2022_PROGRAM_ID,
	TOKEN_PROGRAM_ID,
} from "@solana/spl-token";
import { PublicKey } from "@solana/web3.js";
import { getCtx } from "../utils";

const ctx = getCtx();

const whirlpoolAddress = new PublicKey(
	"EgxU92G34jw6QDG9RuTX9StFg1PmHuDqkRKAE5kVEiZ4",
); // devSAMO/devUSDC
const positionAddress = new PublicKey(
	"4GjnV6Hbznu7NCWVEqEmz7ofvCZFeHm74tyWxFkKcEyw",
);

const whirlpool = await ctx.fetcher.getPool(whirlpoolAddress);
const position = await ctx.fetcher.getPosition(positionAddress);

if (whirlpool === null || position === null) {
	console.log("Invalid whirlpool or position");
	exit();
}

const positionTokenAccount = getAssociatedTokenAddressSync(
	position.positionMint,
	ctx.provider.wallet.publicKey,
	false,
	TOKEN_2022_PROGRAM_ID,
);

const signatures = [];

let i = 0;
for (const rewardInfo of whirlpool.rewardInfos) {
	if (rewardInfo.mint.equals(PublicKey.default)) {
		i += 1;
		continue;
	}

	const tokenAccount = await ctx.connection.getAccountInfo(rewardInfo.mint);

	if (!tokenAccount) {
		i += 1;
		continue;
	}

	const rewardOwnerAccount = getAssociatedTokenAddressSync(
		rewardInfo.mint,
		ctx.provider.wallet.publicKey,
		false,
		TOKEN_2022_PROGRAM_ID.equals(tokenAccount.owner)
			? TOKEN_2022_PROGRAM_ID
			: TOKEN_PROGRAM_ID,
	);

	const signature = await toTx(
		ctx,
		WhirlpoolIx.collectRewardIx(ctx.program, {
			whirlpool: whirlpoolAddress,
			positionAuthority: ctx.provider.wallet.publicKey,
			position: positionAddress,
			positionTokenAccount,
			rewardOwnerAccount,
			rewardVault: rewardInfo.vault,
			rewardIndex: i,
		}),
	)
		.prependInstruction({
			instructions: [
				createAssociatedTokenAccountIdempotentInstruction(
					ctx.provider.wallet.publicKey,
					rewardOwnerAccount,
					ctx.provider.wallet.publicKey,
					rewardInfo.mint,
				),
			],
			cleanupInstructions: [],
			signers: [],
		})
		.buildAndExecute();

	signatures.push(signature);
	i += 1;
}

console.log("Signatures: ", signatures);

3. Usage Example

Suppose you are a developer creating a bot to manage investments for a group of investors. The bot periodically collects accumulated fees and rewards from liquidity positions to distribute profits among investors. By using the SDK, you can generate the instructions to collect earnings from each active position without closing it, allowing the liquidity to continue generating returns and potentially reinvest your earned fees into the position.

4. Next Steps

After harvesting fees and rewards, you can:

Monitor Performance: Keep track of your position to evaluate future earnings and the overall performance.
Reinvest Earnings: Use the harvested fees and rewards to add more liquidity or diversify your positions.
Harvest Regularly: Regularly collect your earnings to maintain optimal capital efficiency while keeping your liquidity active.

By using the SDK, you can maximize the benefits of providing liquidity while keeping your position open and continuously earning fees. As the liquidity pool is traded upon, liquidity providers will begin to accrue fees and rewards. Follow the following steps to see how much you are owe and how to collect them. Harvesting a position in Orca Whirlpools allows you to collect any accumulated fees and rewards without closing the position. This process is useful when you want to claim your earnings while keeping your liquidity active in the pool, ensuring you continue to benefit from potential future fees.

Getting Started

Architecture

SDKs

Examples

Resources

Reference

1. Overview of Harvesting a Position

Get a quick quote on outstanding fees and rewards

Update on-chain position with the latest accrued fees

Collect Fees and Rewards

Collect fee

Collect rewards

3. Usage Example

4. Next Steps

​1. Overview of Harvesting a Position

​Get a quick quote on outstanding fees and rewards

​Update on-chain position with the latest accrued fees

​Collect Fees and Rewards

​Collect fee

​Collect rewards

​3. Usage Example

​4. Next Steps

1. Overview of Harvesting a Position

Get a quick quote on outstanding fees and rewards

Update on-chain position with the latest accrued fees

Collect Fees and Rewards

Collect fee

Collect rewards

3. Usage Example

4. Next Steps