流動性のロック / 手数料の収集

Burn & Earn プログラムを使用して LPトークン を永続的にロックし、Fee Key NFT を介して取引手数料の取り分を受け取りましょう。

---

仕組み

LPトークン をロックすると：

1. あなたの LPトークン は Burn & Earn locker program に移され、引き出すことはできません。

2. あなたは Fee Key NFT を受け取ります。これはロックされたポジションを表します。

3. Fee Key NFT により、プールに蓄積した取引手数料を請求する権利が得られます。

手数料 harvest が内部でどのように機能するか

constant-product pool では、手数料は別個に保管されるわけではなく、pool vaults に蓄積されるため、各 LP token は時間の経過とともにより多くの underlying tokens の価値を持つようになります。その蓄積された価値を引き出す唯一の方法は、LP tokens を redeem（burn）することです。

ロックされたポジションから harvest する場合：

1. あなたのロックされたポジションは、たとえば 1000 LP トークンを保有しています。

2. スワップが発生し、手数料が pool vaults に流入し、各 LP token の価値が上昇します。

3. あなたは harvestLockLp を lpFeeAmount （例： 5 LP).

4. とともに呼び出します。locker program は CPMM program 上の withdraw を通じてその 5 LP を burn します。

5. あなたは token A + token B の比例配分を自分のウォレットで受け取ります。

6. あなたのロックされたポジションは現在 995 LP トークンを保有しています。

LP 残高は 減少します harvest のたびに。ですが、残りの 995 LP tokens は、手数料が蓄積する前の元の 1000 とほぼ同じ価値を持ちます。これは各 LP token の価値が上がっているためです。あなたが引き出しているのは値上がり分であり、元本ではありません。

この lpFeeAmount パラメータは burn する LP の量を制御します。

---

LPトークン のロック

使用する raydium.cpmm.lockLp() を使用して LPトークン を永続的にロックし、Fee Key NFT を受け取ります。

import {
  ApiV3PoolInfoStandardItemCpmm,
  CpmmKeys,
  DEVNET_PROGRAM_ID,
  TxVersion,
} from '@raydium-io/raydium-sdk-v2'
import { initSdk } from '../config'

const lockLiquidity = async () => {
  const raydium = await initSdk()
  const poolId = 'YOUR_POOL_ID'

  let poolInfo: ApiV3PoolInfoStandardItemCpmm
  let poolKeys: CpmmKeys | undefined

  if (raydium.cluster === 'mainnet') {
    const data = await raydium.api.fetchPoolById({ ids: poolId })
    poolInfo = data[0] as ApiV3PoolInfoStandardItemCpmm
  } else {
    const data = await raydium.cpmm.getPoolInfoFromRpc(poolId)
    poolInfo = data.poolInfo
    poolKeys = data.poolKeys
  }

  // LP 残高を取得するためにウォレットの token accounts を取得
  await raydium.account.fetchWalletTokenAccounts()
  const lpBalance = raydium.account.tokenAccounts.find(
    (a) => a.mint.toBase58() === poolInfo.lpMint.address
  )
  if (!lpBalance) throw new Error(`pool の LP 残高がありません: ${poolId}`)

  const { execute, extInfo } = await raydium.cpmm.lockLp({
    // devnet: programId: DEVNET_PROGRAM_ID.LOCK_CPMM_PROGRAM
    // devnet: authProgram: DEVNET_PROGRAM_ID.LOCK_CPMM_AUTH
    // devnet: poolKeys
    poolInfo,
    lpAmount: lpBalance.amount,
    withMetadata: true,
    txVersion: TxVersion.V0,
  })

  const { txId } = await execute({ sendAndConfirm: true })
  console.log('lp locked', {
    txId: `https://explorer.solana.com/tx/${txId}`,
    nftMint: extInfo,
  })
}

lockLiquidity()

ロック parameters

パラメータ	型	説明
poolInfo	object	API または RPC から取得したプール情報。
poolKeys	object	プールキー。devnet では必須です。
lpAmount	BN	ロックする LPトークン の量（最小単位）。
withMetadata	boolean	もし trueの場合、Fee Key NFT の on-chain metadata を作成します。
programId	PublicKey	locker program。Mainnet のデフォルトは自動解決されます。Devnet: DEVNET_PROGRAM_ID.LOCK_CPMM_PROGRAM.
authProgram	PublicKey	locker auth program。Devnet: DEVNET_PROGRAM_ID.LOCK_CPMM_AUTH.
txVersion	TxVersion	トランザクションのバージョン。

ロックは永続的です。一度ロックすると、LPトークン を引き出すことはできません。Fee Key NFT を介して取引手数料のみを回収できます。

---

ロックされた Liquidity からの手数料回収

使用する raydium.cpmm.harvestLockLp() を使用して、Fee Key NFT の mint address を使い、ロックされた LP ポジションから蓄積した取引手数料を請求します。

import { PublicKey } from '@solana/web3.js'
import BN from 'bn.js'

const harvestLockLiquidity = async () => {
  const raydium = await initSdk()
  const poolId = 'YOUR_POOL_ID'

  let poolInfo: ApiV3PoolInfoStandardItemCpmm
  let poolKeys: CpmmKeys | undefined

  if (raydium.cluster === 'mainnet') {
    const data = await raydium.api.fetchPoolById({ ids: poolId })
    poolInfo = data[0] as ApiV3PoolInfoStandardItemCpmm
  } else {
    const data = await raydium.cpmm.getPoolInfoFromRpc(poolId)
    poolInfo = data.poolInfo
    poolKeys = data.poolKeys
  }

  const { execute } = await raydium.cpmm.harvestLockLp({
    // devnet: programId: DEVNET_PROGRAM_ID.LOCK_CPMM_PROGRAM
    // devnet: authProgram: DEVNET_PROGRAM_ID.LOCK_CPMM_AUTH
    // devnet: poolKeys
    poolInfo,
    nftMint: new PublicKey('YOUR_FEE_KEY_NFT_MINT'),
    lpFeeAmount: new BN(99999999),
    txVersion: TxVersion.V0,
    // closeWsol: false, // デフォルトは true — wSOL account を保持するには false に設定
  })

  const { txId } = await execute({ sendAndConfirm: true })
  console.log('fees harvested', { txId: `https://explorer.solana.com/tx/${txId}` })
}

harvestLockLiquidity()

Harvest parameters

パラメータ	型	説明
poolInfo	object	API または RPC から取得したプール情報。
poolKeys	object	プールキー。devnet では必須です。
nftMint	PublicKey	ロック時に受け取る Fee Key NFT の mint address。
lpFeeAmount	BN	ロックされたポジションから burn する LPトークン の量。これが蓄積した手数料の価値を引き出す方法です — 詳しくは上記の「手数料 harvest の仕組み」を参照してください。
closeWsol	boolean	デフォルト true。wSOL account を閉じて native SOL を返します。 false に設定すると wSOL を維持します。
txVersion	TxVersion	トランザクションのバージョン。

---

creator fees の回収

Creator fees は、プール作成者に支払われるスワップごとの個別手数料です。これらは permissioned path 経由で作成されたプールでのみ利用可能です (createPoolWithPermission）。これには Raydium admin からの Permission PDA が必要です。標準の createPool() で作成されたプールでは、program level で creator fees が無効化されています — 詳細は「Creating a pool」を参照してください。

プールが permission 付きで作成され、fee config に 0 以外の creator_fee_rateが含まれている場合、蓄積した creator fees を回収できます。

単一プール

const collectCreatorFee = async () => {
  const raydium = await initSdk()
  // ... poolInfo と poolKeys を取得

  const { execute } = await raydium.cpmm.collectCreatorFees({
    poolInfo,
    poolKeys,
    txVersion: TxVersion.V0,
  })

  const { txId } = await execute({ sendAndConfirm: true })
  console.log('creator fees collected', { txId: `https://explorer.solana.com/tx/${txId}` })
}

複数プールを一度に

import {
  CREATE_CPMM_POOL_PROGRAM,
  DEVNET_PROGRAM_ID,
} from '@raydium-io/raydium-sdk-v2'

const collectAllCreatorFees = async () => {
  const raydium = await initSdk()
  const isDevnet = raydium.cluster === 'devnet'

  const host = isDevnet
    ? 'https://temp-api-v1-devnet.raydium.io'
    : 'https://temp-api-v1.raydium.io'

  // 接続されたウォレットに未回収の creator fees があるすべてのプールを取得
  const res = await fetch(
    `${host}/cp-creator-fee?wallet=${raydium.ownerPubKey.toBase58()}`
  )
  const { data } = await res.json()

  const poolsWithFees = data.filter(
    (d: any) => d.fee.amountA !== '0' || d.fee.amountB !== '0'
  )

  if (!poolsWithFees.length) {
    console.log('no pending creator fees')
    return
  }

  const { execute } = await raydium.cpmm.collectMultiCreatorFees({
    poolInfoList: poolsWithFees.map((d: any) => d.poolInfo),
    programId: isDevnet
      ? DEVNET_PROGRAM_ID.CREATE_CPMM_POOL_PROGRAM
      : CREATE_CPMM_POOL_PROGRAM,
    txVersion: TxVersion.V0,
  })

  const sentInfo = await execute({ sequentially: true })
  console.log('creator fees collected', sentInfo)
}