Merge pull request #77 from macalinao/igm/replica-miner-init

various improvements to quarry/react-quarry

Author: macalinao

.changeset/blue-glasses-matter.md

@@ -0,0 +1,5 @@
+---
+"@macalinao/quarry": patch
+---
+
+Fix deposit/withdraw bugs

.changeset/giant-islands-stand.md

@@ -0,0 +1,7 @@
+---
+"@macalinao/react-quarry": minor
+"@macalinao/quarry": minor
+"@macalinao/grill": minor
+---
+
+Fix bugs around quarry merge miner initialization, more pda hooks

bun.lock

@@ -148,6 +148,7 @@
       "version": "0.1.0",
       "dependencies": {
         "@macalinao/clients-quarry": "^0.4.2",
+        "@macalinao/gill-extra": "workspace:*",
         "@macalinao/token-utils": "workspace:*",
         "@solana-program/token": "^0.6.0",
         "nonempty-array": "^0.1.4",

packages/grill/src/hooks/create-pda-hook.ts

@@ -1,11 +1,12 @@
 import type { PdaFn } from "@macalinao/gill-extra";
+import type { Address } from "@solana/kit";
 import { useQuery } from "@tanstack/react-query";
 import { createPdaQuery } from "./pda-query-utils.js";
 
 /**
  * Hook for computing a PDA from some arguments.
  */
-export type PdaHook<TArgs, TResult> = (
+export type PdaHook<TArgs, TResult = Address> = (
   args: TArgs | null | undefined,
 ) => TResult | null | undefined;
 

packages/grill/src/hooks/create-pdas-hook.ts

@@ -1,8 +1,12 @@
 import type { PdaFn } from "@macalinao/gill-extra";
+import type { Address } from "@solana/kit";
 import { useQueries } from "@tanstack/react-query";
 import { createPdaQuery } from "./pda-query-utils.js";
 
-export type PdasHook<TArgs, TResult> = <T extends readonly TArgs[]>(
+/**
+ * Hook for computing multiple PDAs from some arguments.
+ */
+export type PdasHook<TArgs, TResult = Address> = <T extends readonly TArgs[]>(
   args: T | null | undefined,
 ) => { [K in keyof T]: TResult } | null | undefined;
 

packages/quarry/package.json

@@ -59,6 +59,7 @@
   },
   "dependencies": {
     "@macalinao/clients-quarry": "^0.4.2",
+    "@macalinao/gill-extra": "workspace:*",
     "@macalinao/token-utils": "workspace:*",
     "@solana-program/token": "^0.6.0",
     "nonempty-array": "^0.1.4"

packages/quarry/src/ixs/merge-miner/claim-rewards.ts

@@ -1,13 +1,12 @@
 import type { MergePool, Rewarder } from "@macalinao/clients-quarry";
+import type { AccountInfo } from "@macalinao/gill-extra";
 import type { Address, Instruction, TransactionSigner } from "@solana/kit";
 import {
   findMergeMinerPda,
   findMinerPda,
-  findMinterPda,
   findQuarryPda,
-  getClaimRewardsMMInstruction,
-  getWithdrawTokensMMInstruction,
-  QUARRY_MINT_WRAPPER_PROGRAM_ADDRESS,
+  getClaimRewardsMMInstructionAsync,
+  getWithdrawTokensMMInstructionAsync,
 } from "@macalinao/clients-quarry";
 import {
   findAssociatedTokenPda,
@@ -24,10 +23,12 @@ export interface QuarryStakeAccounts {
   minerVault: Address;
 }
 
-export interface MergePoolAccount {
-  address: Address;
-  data: Pick<MergePool, "primaryMint" | "replicaMint">;
-}
+/**
+ * A merge pool account with primary/replica mint exposed.
+ */
+export type MergePoolAccount = AccountInfo<
+  Pick<MergePool, "primaryMint" | "replicaMint">
+>;
 
 export interface ClaimRewardsCommonArgs {
   quarryMint: Address;
@@ -57,12 +58,6 @@ export async function claimRewardsCommon({
 }: ClaimRewardsCommonArgs): Promise<Instruction[]> {
   const instructions: Instruction[] = [];
 
-  // Derive the minter PDA
-  const [minter] = await findMinterPda({
-    wrapper: rewarder.data.mintWrapper,
-    authority: stake.rewarder,
-  });
-
   // Get or create associated token accounts for the merge miner
   const [mmQuarryTokenAccount] = await findAssociatedTokenPda({
     mint: quarryMint,
@@ -119,30 +114,23 @@ export async function claimRewardsCommon({
 
   // Claim rewards instruction
   instructions.push(
-    getClaimRewardsMMInstruction({
+    await getClaimRewardsMMInstructionAsync({
       mintWrapper: rewarder.data.mintWrapper,
-      mintWrapperProgram: QUARRY_MINT_WRAPPER_PROGRAM_ADDRESS,
-      minter,
       rewardsTokenMint: rewarder.data.rewardsTokenMint,
-      rewardsTokenAccount: mmRewardsTokenAccount,
-      claimFeeTokenAccount: rewarder.data.claimFeeTokenAccount,
       stakeTokenAccount: mmQuarryTokenAccount,
       pool: stake.pool,
       mm: stake.mm,
       rewarder: stake.rewarder,
       quarry: stake.quarry,
-      miner: stake.miner,
       minerVault: stake.minerVault,
     }),
   );
 
   // Withdraw rewards tokens from merge miner to owner
   instructions.push(
-    getWithdrawTokensMMInstruction({
+    await getWithdrawTokensMMInstructionAsync({
       owner: mmOwner,
       pool: stake.pool,
-      mm: stake.mm,
-      mmTokenAccount: mmRewardsTokenAccount,
       withdrawMint: rewarder.data.rewardsTokenMint,
       tokenDestination: ownerRewardsTokenAccount,
     }),
@@ -161,13 +149,9 @@ export async function claimPrimaryRewards({
 }: {
   mergePool: MergePoolAccount;
   mmOwner: TransactionSigner;
-  rewarder: {
-    address: Address;
-    data: Pick<
-      Rewarder,
-      "mintWrapper" | "rewardsTokenMint" | "claimFeeTokenAccount"
-    >;
-  };
+  rewarder: AccountInfo<
+    Pick<Rewarder, "mintWrapper" | "rewardsTokenMint" | "claimFeeTokenAccount">
+  >;
 }): Promise<Instruction[]> {
   const stake = await getPrimaryStakeAccounts({
     rewarder: rewarder.address,

packages/quarry/src/ixs/merge-miner/deposit.ts renamed to packages/quarry/src/ixs/merge-miner/create-deposit-merge-miner-ixs.ts

@@ -7,7 +7,7 @@ import {
   getTransferInstruction,
   TOKEN_PROGRAM_ADDRESS,
 } from "@solana-program/token";
-import { getCreateInitMergeMinerIxs } from "./init.js";
+import { getCreateInitMergeMinerIxs } from "./init/get-create-init-merge-miner-ixs.js";
 import {
   createStakePrimaryMinerIx,
   createStakeReplicaMinerIx,
@@ -19,6 +19,7 @@ import {
 export interface DepositMergeMinerArgs extends MergeMinerAmountArgs {
   /** The merge miner owner (defaults to payer) */
   mmOwner?: TransactionSigner;
+  initMergeMiner?: boolean;
 }
 
 /**
@@ -43,6 +44,7 @@ export async function createDepositMergeMinerIxs({
   payer,
   replicaRewarders = [],
   mmOwner = payer,
+  initMergeMiner,
 }: DepositMergeMinerArgs): Promise<{
   ixs: Instruction[];
 }> {
@@ -55,14 +57,17 @@ export async function createDepositMergeMinerIxs({
     tokenProgram: TOKEN_PROGRAM_ADDRESS,
   });
 
-  // Initialize merge miner and primary miner if needed
-  const { ixs: initIxs } = await getCreateInitMergeMinerIxs({
-    rewarder,
-    mergePool,
-    owner: mmOwner.address,
-    payer,
-  });
-  instructions.push(...initIxs);
+  if (initMergeMiner) {
+    // Initialize merge miner and primary miner if needed
+    const { ixs: initIxs } = await getCreateInitMergeMinerIxs({
+      rewarder,
+      replicaRewarders,
+      mergePool,
+      owner: mmOwner.address,
+      payer,
+    });
+    instructions.push(...initIxs);
+  }
 
   // Get merge miner address
   const [mmAddress] = await findMergeMinerPda({

packages/quarry/src/ixs/merge-miner/withdraw.ts renamed to packages/quarry/src/ixs/merge-miner/create-withdraw-merge-miner-ixs.ts

@@ -2,7 +2,7 @@ import type { Address, Instruction, TransactionSigner } from "@solana/kit";
 import type { MergeMinerAmountArgs } from "./types.js";
 import {
   findMergeMinerPda,
-  getWithdrawTokensMMInstruction,
+  getWithdrawTokensMMInstructionAsync,
 } from "@macalinao/clients-quarry";
 import {
   findAssociatedTokenPda,
@@ -21,7 +21,11 @@ import {
 export interface WithdrawMergeMinerArgs extends MergeMinerAmountArgs {
   /** Owner of the merge miner */
   owner: TransactionSigner;
-  /** Destination of the tokens, defaults to the owner's primary ATA */
+  /**
+   * Destination of the tokens, defaults to the owner's primary ATA
+   *
+   * Note: this must be a token account.
+   */
   tokenDestination?: Address;
 }
 
@@ -37,12 +41,6 @@ export async function createWithdrawMergeMinerIxs({
   owner,
   payer,
 }: WithdrawMergeMinerArgs): Promise<Instruction[]> {
-  const [mmTokenAccount] = await findAssociatedTokenPda({
-    mint: mergePool.data.primaryMint,
-    owner: owner.address,
-    tokenProgram: TOKEN_PROGRAM_ADDRESS,
-  });
-
   // Get merge miner address
   const [mmAddress] = await findMergeMinerPda({
     pool: mergePool.address,
@@ -71,19 +69,6 @@ export async function createWithdrawMergeMinerIxs({
       primaryMint: mergePool.data.primaryMint,
       amount,
     }),
-    // Stake replica tokens back into the merge miner
-    ...(await Promise.all(
-      replicaRewarders.map(
-        async (replicaRewarder) =>
-          await createStakeReplicaMinerIx({
-            mmOwner: owner,
-            pool: mergePool.address,
-            mm: mmAddress,
-            rewarder: replicaRewarder,
-            replicaMint: mergePool.data.replicaMint,
-          }),
-      ),
-    )),
   ];
 
   if (!tokenDestination) {
@@ -104,15 +89,29 @@ export async function createWithdrawMergeMinerIxs({
     tokenDestination = destinationATA;
   }
 
-  const withdrawIx = getWithdrawTokensMMInstruction({
+  const withdrawIx = await getWithdrawTokensMMInstructionAsync({
     owner,
     pool: mergePool.address,
-    mm: mmAddress,
-    mmTokenAccount,
     withdrawMint: mergePool.data.primaryMint,
     tokenDestination,
   });
   ixs.push(withdrawIx);
 
+  ixs.push(
+    // Stake replica tokens back into the merge miner
+    ...(await Promise.all(
+      replicaRewarders.map(
+        async (replicaRewarder) =>
+          await createStakeReplicaMinerIx({
+            mmOwner: owner,
+            pool: mergePool.address,
+            mm: mmAddress,
+            rewarder: replicaRewarder,
+            replicaMint: mergePool.data.replicaMint,
+          }),
+      ),
+    )),
+  );
+
   return ixs;
 }

packages/quarry/src/ixs/merge-miner/helpers.ts

@@ -1,7 +1,6 @@
 import type { Address } from "@solana/kit";
 import type { MinerAddresses } from "./types.js";
 import {
-  findMergeMinerPda,
   findMergePoolPda,
   findMinerPda,
   findQuarryPda,
@@ -34,23 +33,6 @@ export async function getMergePoolAddresses({
   return { pool, replicaMint };
 }
 
-/**
- * Helper to get the merge miner PDA
- */
-export async function getMergeMinerAddress({
-  pool,
-  owner,
-}: {
-  pool: Address;
-  owner: Address;
-}): Promise<Address> {
-  const [mm] = await findMergeMinerPda({
-    pool,
-    owner,
-  });
-  return mm;
-}
-
 /**
  * Helper to derive miner addresses from a mint and authority
  */