LL (#768)

* port PR31 on dev repo

* changeset

* update changeset

Author: yugure-orca

.changeset/purple-buses-move.md

@@ -0,0 +1,8 @@
+---
+"@orca-so/whirlpools-sdk": patch
+"@orca-so/whirlpools-program": patch
+"@orca-so/whirlpools-rust-client": patch
+"@orca-so/whirlpools-client": patch
+---
+
+Add liquidity locking feature

legacy-sdk/whirlpool/src/impl/position-impl.ts

@@ -27,11 +27,14 @@ import {
   decreaseLiquidityV2Ix,
   increaseLiquidityIx,
   increaseLiquidityV2Ix,
+  lockPositionIx,
   updateFeesAndRewardsIx,
 } from "../instructions";
 import type { WhirlpoolAccountFetchOptions } from "../network/public/fetcher";
 import { IGNORE_CACHE, PREFER_CACHE } from "../network/public/fetcher";
 import type {
+  LockConfigData,
+  LockTypeData,
   PositionData,
   TickArrayData,
   TickData,
@@ -652,6 +655,56 @@ export class PositionImpl implements Position {
     return builder.build();
   }
 
+  async lock(
+    lockType: LockTypeData,
+    positionWallet?: Address,
+    funder?: Address,
+  ): Promise<TransactionBuilder> {
+    const [positionWalletKey, funderKey] = AddressUtil.toPubKeys([
+      positionWallet ?? this.ctx.wallet.publicKey,
+      funder ?? this.ctx.wallet.publicKey,
+    ]);
+
+    let txBuilder = new TransactionBuilder(
+      this.ctx.provider.connection,
+      this.ctx.provider.wallet,
+      this.ctx.txBuilderOpts,
+    );
+
+    const positionTokenAccount = getAssociatedTokenAddressSync(
+      this.data.positionMint,
+      positionWalletKey,
+      this.ctx.accountResolverOpts.allowPDAOwnerAddress,
+      this.positionMintTokenProgramId,
+    );
+
+    const ix = lockPositionIx(this.ctx.program, {
+      funder: funderKey,
+      positionAuthority: positionWalletKey,
+      position: this.address,
+      positionMint: this.data.positionMint,
+      positionTokenAccount,
+      whirlpool: this.data.whirlpool,
+      lockConfigPda: PDAUtil.getLockConfig(
+        this.ctx.program.programId,
+        this.address,
+      ),
+      lockType,
+    });
+
+    txBuilder.addInstruction(ix);
+
+    return txBuilder;
+  }
+
+  async getLockConfigData(): Promise<LockConfigData | null> {
+    const lockConfig = await this.ctx.fetcher.getLockConfig(
+      PDAUtil.getLockConfig(this.ctx.program.programId, this.address).publicKey,
+      IGNORE_CACHE,
+    );
+    return lockConfig;
+  }
+
   private async refresh() {
     const positionAccount = await this.ctx.fetcher.getPosition(
       this.address,

legacy-sdk/whirlpool/src/instructions/close-position-with-token-extensions-ix.ts

@@ -27,7 +27,7 @@ export type ClosePositionWithTokenExtensionsParams = {
  * Mint and TokenAccount are based on Token-2022. And Mint accout will be also closed.
  *
  * @category Instructions
- * @param context - Context object containing services required to generate the instruction
+ * @param program - program object containing services required to generate the instruction
  * @param params - ClosePositionWithTokenExtensionsParams object
  * @returns - Instruction to perform the action.
  */

legacy-sdk/whirlpool/src/instructions/index.ts

@@ -14,6 +14,7 @@ export * from "./initialize-pool-ix";
 export * from "./initialize-position-bundle-ix";
 export * from "./initialize-reward-ix";
 export * from "./initialize-tick-array-ix";
+export * from "./lock-position";
 export * from "./open-bundled-position-ix";
 export * from "./open-position-ix";
 export * from "./open-position-with-token-extensions-ix";

legacy-sdk/whirlpool/src/instructions/lock-position.ts

@@ -0,0 +1,68 @@
+import type { Program } from "@coral-xyz/anchor";
+import type { Instruction, PDA } from "@orca-so/common-sdk";
+import type { PublicKey } from "@solana/web3.js";
+import type { LockTypeData } from "..";
+import type { Whirlpool } from "../artifacts/whirlpool";
+import { TOKEN_2022_PROGRAM_ID } from "@solana/spl-token";
+import { SystemProgram } from "@solana/web3.js";
+
+/**
+ * Parameters to lock a position (TokenExtensions based position only).
+ *
+ * @category Instruction Types
+ * @param lockType - The type of lock to apply to the position.
+ * @param funder - The account that would fund the creation of LockConfig account
+ * @param positionAuthority - authority that owns the token corresponding to this desired position.
+ * @param position - PublicKey for the position which will be locked.
+ * @param positionMint - PublicKey for the mint token for the Position token.
+ * @param positionTokenAccount - The associated token address for the position token in the owners wallet.
+ * @param lockConfigPda - PDA for the LockConfig account that will be created to manage lock state.
+ * @param whirlpool - PublicKey for the whirlpool that the position belongs to.
+ */
+export type LockPositionParams = {
+  lockType: LockTypeData;
+  funder: PublicKey;
+  positionAuthority: PublicKey;
+  position: PublicKey;
+  positionMint: PublicKey;
+  positionTokenAccount: PublicKey;
+  lockConfigPda: PDA;
+  whirlpool: PublicKey;
+};
+
+/**
+ * Lock the position to prevent any liquidity changes.
+ *
+ * #### Special Errors
+ * `PositionAlreadyLocked` - The provided position is already locked.
+ * `PositionNotLockable` - The provided position is not lockable (e.g. An empty position).
+ *
+ * @category Instructions
+ * @param program - program object containing services required to generate the instruction
+ * @param params - LockPositionParams object.
+ * @returns - Instruction to perform the action.
+ */
+export function lockPositionIx(
+  program: Program<Whirlpool>,
+  params: LockPositionParams,
+): Instruction {
+  const ix = program.instruction.lockPosition(params.lockType, {
+    accounts: {
+      funder: params.funder,
+      positionAuthority: params.positionAuthority,
+      position: params.position,
+      positionMint: params.positionMint,
+      positionTokenAccount: params.positionTokenAccount,
+      lockConfig: params.lockConfigPda.publicKey,
+      whirlpool: params.whirlpool,
+      token2022Program: TOKEN_2022_PROGRAM_ID,
+      systemProgram: SystemProgram.programId,
+    },
+  });
+
+  return {
+    instructions: [ix],
+    cleanupInstructions: [],
+    signers: [],
+  };
+}

legacy-sdk/whirlpool/src/instructions/open-position-with-token-extensions-ix.ts

@@ -41,7 +41,7 @@ export type OpenPositionWithTokenExtensionsParams = {
  * `InvalidTickIndex` - If a provided tick is out of bounds, out of order or not a multiple of the tick-spacing in this pool.
  *
  * @category Instructions
- * @param context - Context object containing services required to generate the instruction
+ * @param program - program object containing services required to generate the instruction
  * @param params - OpenPositionWithTokenExtensionsParams object and a derived PDA that hosts the position's metadata.
  * @returns - Instruction to perform the action.
  */

legacy-sdk/whirlpool/src/ix.ts

@@ -576,7 +576,7 @@ export class WhirlpoolIx {
    * #### Special Errors
    * `InvalidTickIndex` - If a provided tick is out of bounds, out of order or not a multiple of the tick-spacing in this pool.
    *
-   * @param context - Context object containing services required to generate the instruction
+   * @param program - program object containing services required to generate the instruction
    * @param params - OpenPositionWithTokenExtensionsParams object and a derived PDA that hosts the position's metadata.
    * @returns - Instruction to perform the action.
    */
@@ -592,7 +592,7 @@ export class WhirlpoolIx {
    * Mint and TokenAccount are based on Token-2022. And Mint accout will be also closed.
    *
    * @category Instructions
-   * @param context - Context object containing services required to generate the instruction
+   * @param program - program object containing services required to generate the instruction
    * @param params - ClosePositionWithTokenExtensionsParams object
    * @returns - Instruction to perform the action.
    */
@@ -603,6 +603,25 @@ export class WhirlpoolIx {
     return ix.closePositionWithTokenExtensionsIx(program, params);
   }
 
+  /**
+   * Lock the position to prevent any liquidity changes.
+   *
+   * #### Special Errors
+   * `PositionAlreadyLocked` - The provided position is already locked.
+   * `PositionNotLockable` - The provided position is not lockable (e.g. An empty position).
+   *
+   * @category Instructions
+   * @param program - program object containing services required to generate the instruction
+   * @param params - LockPositionParams object.
+   * @returns - Instruction to perform the action.
+   */
+  public static lockPositionIx(
+    program: Program<Whirlpool>,
+    params: ix.LockPositionParams,
+  ) {
+    return ix.lockPositionIx(program, params);
+  }
+
   // V2 instructions
   // TODO: comments
   public static collectFeesV2Ix(

legacy-sdk/whirlpool/src/network/public/fetcher/fetcher-impl.ts

@@ -20,6 +20,7 @@ import type {
 import { DEFAULT_WHIRLPOOL_RETENTION_POLICY } from "..";
 import type {
   FeeTierData,
+  LockConfigData,
   PositionBundleData,
   PositionData,
   TickArrayData,
@@ -30,6 +31,7 @@ import type {
 } from "../../../types/public";
 import {
   ParsableFeeTier,
+  ParsableLockConfig,
   ParsablePosition,
   ParsablePositionBundle,
   ParsableTickArray,
@@ -237,6 +239,19 @@ export class WhirlpoolAccountFetcher
     return this.fetcher.getAccounts(addresses, ParsableTokenBadge, opts);
   }
 
+  getLockConfig(
+    address: Address,
+    opts?: WhirlpoolAccountFetchOptions,
+  ): Promise<LockConfigData | null> {
+    return this.fetcher.getAccount(address, ParsableLockConfig, opts);
+  }
+  getLockConfigs(
+    addresses: Address[],
+    opts?: WhirlpoolAccountFetchOptions,
+  ): Promise<ReadonlyMap<string, LockConfigData | null>> {
+    return this.fetcher.getAccounts(addresses, ParsableLockConfig, opts);
+  }
+
   populateCache<T extends WhirlpoolSupportedTypes>(
     accounts: ReadonlyMap<string, T>,
     parser: ParsableEntity<T>,

legacy-sdk/whirlpool/src/network/public/fetcher/fetcher-types.ts

@@ -8,6 +8,7 @@ import type {
 } from "@orca-so/common-sdk";
 import type {
   FeeTierData,
+  LockConfigData,
   PositionBundleData,
   PositionData,
   TickArrayData,
@@ -30,6 +31,7 @@ export type WhirlpoolSupportedTypes =
   | PositionBundleData
   | WhirlpoolsConfigExtensionData
   | TokenBadgeData
+  | LockConfigData
   | BasicSupportedTypes;
 
 /**
@@ -278,6 +280,26 @@ export interface WhirlpoolAccountFetcherInterface {
     opts?: WhirlpoolAccountFetchOptions,
   ): Promise<ReadonlyMap<string, TokenBadgeData | null>>;
 
+  /**
+   * Fetch and cache the account for a given LockConfig address
+   * @param address The address of the LockConfig account
+   * @param opts {@link WhirlpoolAccountFetchOptions} instance to dictate fetch behavior
+   */
+  getLockConfig(
+    address: Address,
+    opts?: WhirlpoolAccountFetchOptions,
+  ): Promise<LockConfigData | null>;
+
+  /**
+   * Fetch and cache the accounts for a given array of LockConfig addresses
+   * @param addresses The array of LockConfig account addresses
+   * @param opts {@link WhirlpoolAccountFetchOptions} instance to dictate fetch behavior
+   */
+  getLockConfigs(
+    addresses: Address[],
+    opts?: WhirlpoolAccountFetchOptions,
+  ): Promise<ReadonlyMap<string, LockConfigData | null>>;
+
   /**
    * Populate the fetcher's cache with the given {@link WhirlpoolsData} accounts
    * @param accounts The map of addresses to on-chain account data

legacy-sdk/whirlpool/src/network/public/parsing.ts

@@ -6,6 +6,7 @@ import type { AccountInfo, PublicKey } from "@solana/web3.js";
 import * as WhirlpoolIDL from "../../artifacts/whirlpool.json";
 import type {
   FeeTierData,
+  LockConfigData,
   PositionBundleData,
   PositionData,
   TickArrayData,
@@ -195,6 +196,28 @@ export class ParsableTokenBadge {
   }
 }
 
+/**
+ * @category Network
+ */
+@staticImplements<ParsableEntity<LockConfigData>>()
+export class ParsableLockConfig {
+  public static parse(
+    address: PublicKey,
+    accountData: AccountInfo<Buffer> | undefined | null,
+  ): LockConfigData | null {
+    if (!accountData?.data) {
+      return null;
+    }
+
+    try {
+      return parseAnchorAccount(AccountName.LockConfig, accountData);
+    } catch (e) {
+      console.error(`error while parsing LockConfig: ${e}`);
+      return null;
+    }
+  }
+}
+
 const WhirlpoolCoder = new BorshAccountsCoder(WhirlpoolIDL as Idl);
 
 function parseAnchorAccount(