Merge remote-tracking branch 'origin/main' into refactoring-more-modu…

…larity
marinade-finance · Feb 11, 2024 · 3ac3543 · 3ac3543
2 parents f9361d8 + 47d08aa
commit 3ac3543
Show file tree

Hide file tree

Showing 7 changed files with 123 additions and 100 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,28 @@
+## v5.0.10
+
+### Fix:
+
+    - Remove directed vote instruction from stake transaction to prevent accidental vote reset
+
+## v5.0.9
+
+### Fix:
+
+    - Naming consistency
+
+## v5.0.8
+
+### Fix:
+
+    - Update directed stake sdk and method call
+    - Add warning about low liquidity on unstake via our pool
+
+## v5.0.7
+
+### Feat:
+
+    - Add method to support delayed unstake with PublicKey instead of Keypair
+
 ## v5.0.6
 
 ### Feat:

diff --git a/fixtures/programs/directed_stake.so b/fixtures/programs/directed_stake.so
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@marinade.finance/marinade-ts-sdk",
-  "version": "5.0.6",
+  "version": "5.0.10",
   "description": "Marinade SDK for Typescript",
   "main": "dist/src/index.js",
   "repository": {
@@ -36,7 +36,7 @@
   "license": "ISC",
   "dependencies": {
     "@coral-xyz/anchor": "^0.28.0",
-    "@marinade.finance/directed-stake-sdk": "^0.0.4",
+    "@marinade.finance/directed-stake-sdk": "^0.1.0",
     "@marinade.finance/native-staking-sdk": "^1.0.0",
     "@solana/spl-stake-pool": "^0.7.0",
     "@solana/spl-token": "^0.3.8",

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/marinade.ts b/src/marinade.ts
@@ -5,7 +5,6 @@ import {
 } from './util/anchor'
 import {
   DepositOptions,
-  DepositStakeAccountOptions,
   MarinadeResult,
   ValidatorStats,
 } from './marinade.types'
@@ -43,10 +42,6 @@ import {
   validatorDuplicationFlag,
 } from './marinade-state/marinade-state'
 import BN from 'bn.js'
-import {
-  createDirectedStakeVoteIx,
-  getDirectedStakeSdk,
-} from './marinade-directed-stake'
 import { MarinadeProgram } from './programs/marinade-program'
 import {
   depositInstructionBuilder as marinadeDepositInstructionBuilder,
@@ -211,18 +206,6 @@ export async function deposit(
 
   transaction.add(depositInstruction)
 
-  const directedStakeSdk = getDirectedStakeSdk(
-    marinadeProgram.provider.connection,
-    ownerAddress
-  )
-  const directedStakeInstruction = await createDirectedStakeVoteIx(
-    directedStakeSdk,
-    options.directToValidatorVoteAddress
-  )
-  if (directedStakeInstruction) {
-    transaction.add(directedStakeInstruction)
-  }
-
   return {
     associatedMSolTokenAccountAddress,
     transaction,
@@ -304,13 +287,11 @@ export async function liquidUnstake(
  * @param {MarinadeProgram} marinadeProgram - Instance providing marinade methods, backed by Anchor program
  * @param {PublicKey} ownerAddress - The owner (staker authority) of the stake account to be deposited
  * @param {PublicKey} stakeAccountAddress - The account to be deposited
- * @param {DepositStakeAccountOptions} options - Additional deposit options
  */
 export async function depositStakeAccount(
   marinadeProgram: MarinadeProgram,
   ownerAddress: PublicKey,
-  stakeAccountAddress: PublicKey,
-  options: DepositStakeAccountOptions = {}
+  stakeAccountAddress: PublicKey
 ): Promise<MarinadeResult.DepositStakeAccount> {
   const stakeAccountInfo = await getParsedStakeAccountInfo(
     marinadeProgram.provider.connection,
@@ -325,8 +306,7 @@ export async function depositStakeAccount(
     marinadeProgram,
     ownerAddress,
     stakeAccountInfo,
-    rent,
-    options
+    rent
   )
 }
 
@@ -341,13 +321,11 @@ export async function depositStakeAccount(
  * @param {MarinadeProgram} marinadeProgram - Instance providing marinade methods, backed by Anchor program
  * @param {PublicKey} ownerAddress - The owner of the stake account to be deposited
  * @param {PublicKey} stakeAccountAddress - The account to be deposited
- * @param {DepositStakeAccountOptions} options - Additional deposit options
  */
 export async function depositDeactivatingStakeAccount(
   marinadeProgram: MarinadeProgram,
   ownerAddress: PublicKey,
-  stakeAccountAddress: PublicKey,
-  options: DepositStakeAccountOptions = {}
+  stakeAccountAddress: PublicKey
 ): Promise<MarinadeResult.DepositDeactivatingStakeAccount> {
   const stakeAccountInfo = await getParsedStakeAccountInfo(
     marinadeProgram.provider.connection,
@@ -423,18 +401,6 @@ export async function depositDeactivatingStakeAccount(
 
   delegateTransaction.instructions.push(depositInstruction)
 
-  const directedStakeSdk = getDirectedStakeSdk(
-    marinadeProgram.provider.connection,
-    ownerAddress
-  )
-  const directedStakeInstruction = await createDirectedStakeVoteIx(
-    directedStakeSdk,
-    options.directToValidatorVoteAddress
-  )
-  if (directedStakeInstruction) {
-    delegateTransaction.add(directedStakeInstruction)
-  }
-
   return {
     transaction: delegateTransaction,
     associatedMSolTokenAccountAddress,
@@ -450,14 +416,12 @@ export async function depositDeactivatingStakeAccount(
  * @param {PublicKey} ownerAddress - The owner (staker authority) of the stake account to be deposited
  * @param {ParsedStakeAccountInfo} stakeAccountInfo - Parsed Stake Account info
  * @param {number} rent - Rent needed for a stake account
- * @param {DepositStakeAccountOptions} options - Additional deposit options
  */
 export async function depositStakeAccountByAccount(
   marinadeProgram: MarinadeProgram,
   ownerAddress: PublicKey,
   stakeAccountInfo: ParsedStakeAccountInfo,
-  rent: number,
-  options: DepositStakeAccountOptions = {}
+  rent: number
 ): Promise<MarinadeResult.DepositStakeAccount> {
   const transaction = new Transaction()
   const currentEpoch = await marinadeProgram.provider.connection.getEpochInfo()
@@ -576,18 +540,6 @@ export async function depositStakeAccountByAccount(
 
   transaction.add(depositStakeAccountInstruction)
 
-  const directedStakeSdk = getDirectedStakeSdk(
-    marinadeProgram.provider.connection,
-    ownerAddress
-  )
-  const directedStakeInstruction = await createDirectedStakeVoteIx(
-    directedStakeSdk,
-    options.directToValidatorVoteAddress
-  )
-  if (directedStakeInstruction) {
-    transaction.add(directedStakeInstruction)
-  }
-
   return {
     associatedMSolTokenAccountAddress,
     voterAddress,
@@ -617,8 +569,7 @@ export async function partiallyDepositStakeAccount(
   marinadeProgram: MarinadeProgram,
   ownerAddress: PublicKey,
   stakeAccountAddress: PublicKey,
-  solToKeep: BN,
-  options: DepositStakeAccountOptions = {}
+  solToKeep: BN
 ): Promise<MarinadeResult.PartiallyDepositStakeAccount> {
   const stakeAccountInfo = await getParsedStakeAccountInfo(
     marinadeProgram.provider.connection,
@@ -654,8 +605,7 @@ export async function partiallyDepositStakeAccount(
     marinadeProgram,
     ownerAddress,
     stakeAccountInfo,
-    rent,
-    options
+    rent
   )
 
   splitStakeTx.instructions.push(...depositTx.instructions)
@@ -688,8 +638,7 @@ export async function depositActivatingStakeAccount(
   marinadeProgram: MarinadeProgram,
   ownerAddress: PublicKey,
   stakeAccountAddress: PublicKey,
-  solToKeep: BN,
-  options: DepositStakeAccountOptions = {}
+  solToKeep: BN
 ): Promise<MarinadeResult.PartiallyDepositStakeAccount> {
   const stakeAccountInfo = await getParsedStakeAccountInfo(
     marinadeProgram.provider.connection,
@@ -738,9 +687,7 @@ export async function depositActivatingStakeAccount(
   transaction.add(...withdrawTx.instructions)
 
   const { transaction: depositTx, associatedMSolTokenAccountAddress } =
-    await deposit(marinadeProgram, ownerAddress, lamportsToWithdraw, {
-      directToValidatorVoteAddress: options.directToValidatorVoteAddress,
-    })
+    await deposit(marinadeProgram, ownerAddress, lamportsToWithdraw)
 
   transaction.instructions.push(...depositTx.instructions)
 
@@ -962,6 +909,57 @@ export async function orderUnstake(
   }
 }
 
+/**
+ * Returns a transaction with the instructions to
+ * Order Unstake to create a ticket which can be claimed later (with {@link claim}).
+ *
+ * @param {MarinadeProgram} marinadeProgram - Instance providing marinade methods, backed by Anchor program
+ * @param {PublicKey} ownerAddress - The owner of the tokens to be un-staked
+ * @param {PublicKey} ticketAccountPublicKey - ticketAccountPublicKey - The public key of the ticket account that will sign the transaction
+ * @param {BN} msolAmount - The amount of mSOL in lamports to order for unstaking
+ */
+export async function orderUnstakeWithPublicKey(
+  marinadeProgram: MarinadeProgram,
+  ownerAddress: PublicKey,
+  ticketAccountPublicKey: PublicKey,
+  msolAmount: BN
+): Promise<MarinadeResult.OrderUnstakeWithPublicKey> {
+  const associatedMSolTokenAccountAddress = utils.token.associatedAddress({
+    mint: marinadeProgram.marinadeState.msolMint,
+    owner: ownerAddress,
+  })
+  const rent =
+    await marinadeProgram.provider.connection.getMinimumBalanceForRentExemption(
+      TICKET_ACCOUNT_SIZE
+    )
+  const createAccountInstruction = SystemProgram.createAccount({
+    fromPubkey: ownerAddress,
+    newAccountPubkey: ticketAccountPublicKey,
+    lamports: rent,
+    space: TICKET_ACCOUNT_SIZE,
+    programId: marinadeProgram.program.programId,
+  })
+
+  const orderUnstakeInstruction = await orderUnstakeInstructionBuilder({
+    program: marinadeProgram.program,
+    marinadeState: marinadeProgram.marinadeState,
+    msolAmount,
+    ownerAddress,
+    associatedMSolTokenAccountAddress,
+    newTicketAccount: ticketAccountPublicKey,
+  })
+
+  const transaction = new Transaction().add(
+    createAccountInstruction,
+    orderUnstakeInstruction
+  )
+
+  return {
+    transaction,
+    associatedMSolTokenAccountAddress,
+  }
+}
+
 /**
  * Returns a transaction with the instructions to
  * claim a ticket (created by {@link orderUnstake} beforehand).
@@ -1008,8 +1006,7 @@ export async function depositStakePoolToken(
   lookupTableAddress: PublicKey,
   stakePoolTokenAddress: PublicKey,
   amountToDeposit: number,
-  validators: ValidatorStats[],
-  options: DepositOptions = {}
+  validators: ValidatorStats[]
 ): Promise<MarinadeResult.LiquidateStakePoolToken> {
   const lookupTable = (
     await marinadeProgram.provider.connection.getAddressLookupTable(
@@ -1097,18 +1094,6 @@ export async function depositStakePoolToken(
 
   instructions.push(depositInstruction)
 
-  const directedStakeSdk = getDirectedStakeSdk(
-    marinadeProgram.provider.connection,
-    ownerAddress
-  )
-  const directedStakeInstruction = await createDirectedStakeVoteIx(
-    directedStakeSdk,
-    options.directToValidatorVoteAddress
-  )
-  if (directedStakeInstruction) {
-    instructions.push(directedStakeInstruction)
-  }
-
   const { blockhash: recentBlockhash } =
     await marinadeProgram.provider.connection.getLatestBlockhash('finalized')
 

diff --git a/src/marinade.types.ts b/src/marinade.types.ts
@@ -58,6 +58,11 @@ export namespace MarinadeResult {
     transaction: Transaction
   }
 
+  export interface OrderUnstakeWithPublicKey {
+    associatedMSolTokenAccountAddress: PublicKey
+    transaction: Transaction
+  }
+
   export interface Claim {
     transaction: Transaction
   }
@@ -73,17 +78,6 @@ export interface DepositOptions {
    * The address of the owner account for the associated mSOL account.
    */
   mintToOwnerAddress?: PublicKey
-  /**
-   * The vote address of the validator to direct your stake to.
-   */
-  directToValidatorVoteAddress?: PublicKey
-}
-
-export interface DepositStakeAccountOptions {
-  /**
-   * The vote address of the validator to direct your stake to.
-   */
-  directToValidatorVoteAddress?: PublicKey
 }
 
 export interface ValidatorStats {