Farm / Staking instructions

Documentation Index

Fetch the complete documentation index at: https://docs.raydium.io/llms.txt

Use this file to discover all available pages before exploring further.

​

Instruction inventory

​

CreateFarm (v6)

reward_info_count: u8               // number of reward streams at creation (1..=5)
reward_infos: [
  {
    open_time:            u64,
    end_time:             u64,
    emission_per_second_x64: u128,   // Q64.64
    mint:                 Pubkey,    // reward mint
    token_program:        Pubkey,    // SPL or Token-2022
  }
]

• open_time > now, end_time > open_time.
• creator ATAs hold at least emission_per_second_x64 × (end_time − open_time) / 2^64 of the reward mint.
• staking_mint has no freeze authority, or freeze authority is disabled.

• FarmState initialized, total_staked = 0.
• Reward vault(s) funded with the full stream budget.
• The creator’s reward ATA is drained by that amount.

​

Deposit (v6)

amount: u64

1. Refresh reward_per_share_x64[i] for each live reward stream using the lazy update formula.
2. Compute pending_i = user_ledger.deposited × reward_per_share_x64[i] / 2^64 − user_ledger.reward_debts[i].
3. Transfer pending_i from reward_vault_{i} to user_reward_ata_{i}.
4. Transfer amount staking mint from user_staking_ata to staking_vault.
5. Update user_ledger.deposited += amount and re-snapshot reward_debts[i].
6. Update farm_state.total_staked += amount.

• amount > 0 for a true stake (v6 forbids amount = 0 — use Harvest for claim-only).
• user_staking_ata holds at least amount.
• Each live reward vault holds at least the pending owed to this user.

​

Withdraw (v6)

amount: u64

• amount ≤ user_ledger.deposited.
• Farm is not paused.

​

Harvest (v6)

​

AddReward (v5/v6)

reward_info: {
  open_time:            u64,
  end_time:             u64,
  emission_per_second_x64: u128,
  mint:                 Pubkey,
  token_program:        Pubkey,
}

• A free slot exists (reward_info_count < 5 on v6, < 2 on v5).
• open_time ≥ now (may be in the future) or open_time < now is allowed only if the program version permits it — v6 does, v5 does not.

• The new stream is initialized at index reward_info_count, reward_info_count++.
• The reward vault is credited with the full stream budget from the caller’s ATA.

​

SetRewards (v5/v6)

reward_index:         u8
new_open_time:        u64,
new_end_time:         u64,
new_emission_per_second_x64: u128,

• The stream is still running (reward_state == 1).
• new_end_time ≥ current end_time.
• The additional budget required (new_emission × new_duration − already_emissioned) is present in the sender’s ATA and is transferred to the reward vault by the instruction.

​

RestartRewards (v5/v6)

• reward_state == 2 (ended).
• Caller is reward_sender of the slot (v6) or farm owner (v5).

​

WithdrawReward (v5/v6)

reward_index: u8

• Stream is ended (reward_state == 2).
• reward_total_emissioned == reward_claimed + vault_balance (nothing is currently owed).

​

v5 variations

• Deposit / Withdraw have the same shape as v6 but use up to 2 reward slots and reward_per_share is u128 (fixed-point with a different radix).
• CreateAssociatedLedger is a required separate call before the first Deposit; v6 merged it.
• AddReward is available, Harvest is not (use Deposit 0).

​

v3 variations

• Single reward stream. No AddReward, no second slot.
• Deposit 0 is the only way to claim.
• CreateUserLedger must be called before the first Deposit.

​

State-change matrix

​

Where to go next

• products/farm-staking/code-demos — TypeScript examples.
• products/farm-staking/accounts — FarmState / UserLedger / UserStake layouts.
• reference/error-codes — farm error enum.

• Raydium SDK v2 Farm module
• Raydium farm program source (v3 / v5 / v6)