Farm / Staking 指令

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.

​

指令清單

​

CreateFarm (v6)

reward_info_count: u8               // 建立時的獎勵流數量 (1..=5)
reward_infos: [
  {
    open_time:            u64,
    end_time:             u64,
    emission_per_second_x64: u128,   // Q64.64
    mint:                 Pubkey,    // 獎勵 mint
    token_program:        Pubkey,    // SPL 或 Token-2022
  }
]

• open_time > now，end_time > open_time。
• creator ATA 至少持有 emission_per_second_x64 × (end_time − open_time) / 2^64 的獎勵 mint。
• staking_mint 沒有凍結授權，或凍結授權已禁用。

• FarmState 初始化完成，total_staked = 0。
• 獎勵保險庫資金充足，包含完整流預算。
• 建立者的獎勵 ATA 消耗相應金額。

​

Deposit (v6)

amount: u64

1. 使用惰性更新公式為每個有效獎勵流重新整理 reward_per_share_x64[i]。
2. 計算 pending_i = user_ledger.deposited × reward_per_share_x64[i] / 2^64 − user_ledger.reward_debts[i]。
3. 從 reward_vault_{i} 轉移 pending_i 至 user_reward_ata_{i}。
4. 從 user_staking_ata 轉移 amount 質押 mint 至 staking_vault。
5. 更新 user_ledger.deposited += amount 並重新快照 reward_debts[i]。
6. 更新 farm_state.total_staked += amount。

• amount > 0 才能進行真實質押（v6 禁止 amount = 0 — 僅領取時使用 Harvest）。
• user_staking_ata 至少持有 amount。
• 每個有效獎勵保險庫至少持有欠此使用者的待領金額。

​

Withdraw (v6)

amount: u64

• amount ≤ user_ledger.deposited。
• Farm 未暫停。

​

Harvest (v6)

​

AddReward (v5/v6)

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

• 存在可用插槽（v6 上 reward_info_count < 5，v5 上 < 2）。
• open_time ≥ now（可能在未來），或 open_time < now 僅在程式版本允許時才可——v6 允許，v5 不允許。

• 新流在索引 reward_info_count 處初始化，reward_info_count++。
• 獎勵保險庫由呼叫者的 ATA 記入完整流預算。

​

SetRewards (v5/v6)

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

• 流仍在執行中（reward_state == 1）。
• new_end_time ≥ 當前 end_time。
• 所需的額外預算 (new_emission × new_duration − already_emissioned) 存在於寄件者的 ATA 中，並由指令轉移至獎勵保險庫。

​

RestartRewards (v5/v6)

• reward_state == 2（已結束）。
• 呼叫者是插槽的 reward_sender（v6）或 farm owner（v5）。

​

WithdrawReward (v5/v6)

reward_index: u8

• 流已結束（reward_state == 2）。
• reward_total_emissioned == reward_claimed + vault_balance（無待結算）。

​

v5 變異

• Deposit / Withdraw 的形狀與 v6 相同，但使用最多 2 個獎勵插槽，reward_per_share 為 u128（具有不同基數的定點）。
• CreateAssociatedLedger 是第一次 Deposit 前的必需單獨呼叫；v6 將其合併。
• AddReward 可用，Harvest 不可用（使用 Deposit 0）。

​

v3 變異

• 單一獎勵流。無 AddReward，無第二個插槽。
• Deposit 0 是唯一的領取方式。
• CreateUserLedger 必須在第一次 Deposit 前呼叫。

​

狀態變化矩陣

​

接下來前往

• products/farm-staking/code-demos — TypeScript 範例。
• products/farm-staking/accounts — FarmState / UserLedger / UserStake 配置。
• reference/error-codes — farm 錯誤列舉。

• Raydium SDK v2 Farm 模組
• Raydium farm 程式原始碼（v3 / v5 / v6）