@pump-fun/pump-sdk 1.27.0 → 1.28.0

package/src/sdk.ts

@@ -1,7 +1,10 @@
 import { AnchorProvider, Program } from "@coral-xyz/anchor";
+import {
+  coinCreatorVaultAtaPda,
+  coinCreatorVaultAuthorityPda,
+} from "@pump-fun/pump-swap-sdk";
 import {
   createAssociatedTokenAccountIdempotentInstruction,
-  ASSOCIATED_TOKEN_PROGRAM_ID,
   getAssociatedTokenAddressSync,
   NATIVE_MINT,
   TOKEN_2022_PROGRAM_ID,
@@ -13,20 +16,36 @@ import {
   PublicKey,
   TransactionInstruction,
 } from "@solana/web3.js";
-import pumpIdl from "./idl/pump.json";
-import { Pump } from "./idl/pump";
 import BN from "bn.js";
+
+import { getStaticRandomFeeRecipient } from "./bondingCurve";
 import {
   NoShareholdersError,
   TooManyShareholdersError,
   ZeroShareError,
-  ShareCalculationOverflowError,
   InvalidShareTotalError,
   DuplicateShareholderError,
-  PoolRequiredForGraduatedError,
 } from "./errors";
-
-import { bondingCurvePda, canonicalPumpPoolPda, creatorVaultPda, getGlobalParamsPda, getMayhemStatePda, getSolVaultPda, getTokenVaultPda, pumpPoolAuthorityPda, ammCreatorVaultPda, feeSharingConfigPda } from "./pda";
+import { getFeeRecipient } from "./fees";
+import { Pump } from "./idl/pump";
+import pumpIdl from "./idl/pump.json";
+import { PumpAmm } from "./idl/pump_amm";
+import PumpAmmIdl from "./idl/pump_amm.json";
+import { PumpFees } from "./idl/pump_fees";
+import PumpFeesIdl from "./idl/pump_fees.json";
+import { OFFLINE_PUMP_PROGRAM } from "./onlineSdk";
+import {
+  bondingCurvePda,
+  canonicalPumpPoolPda,
+  creatorVaultPda,
+  getGlobalParamsPda,
+  getMayhemStatePda,
+  getSolVaultPda,
+  getTokenVaultPda,
+  pumpPoolAuthorityPda,
+  feeSharingConfigPda,
+  userVolumeAccumulatorPda,
+} from "./pda";
 import {
   BondingCurve,
   FeeConfig,
@@ -38,24 +57,16 @@ import {
   DistributeCreatorFeesEvent,
   MinimumDistributableFeeEvent,
 } from "./state";
-import { getStaticRandomFeeRecipient } from "./bondingCurve";
-import { getFeeRecipient } from "./fees";
-import { OFFLINE_PUMP_PROGRAM } from "./onlineSdk";
-import PumpAmmIdl from "./idl/pump_amm.json";
-import { PumpAmm } from "./idl/pump_amm";
-import PumpFeesIdl from "./idl/pump_fees.json";
-import { PumpFees } from "./idl/pump_fees";
-import { coinCreatorVaultAtaPda, coinCreatorVaultAuthorityPda, PUMP_AMM_EVENT_AUTHORITY_PDA, pumpAmmPda } from "@pump-fun/pump-swap-sdk";
 
 export function getPumpProgram(connection: Connection): Program<Pump> {
   return new Program(
     pumpIdl as Pump,
-    new AnchorProvider(connection, null as any, {})
+    new AnchorProvider(connection, null as any, {}),
   );
 }
 
 export const PUMP_PROGRAM_ID = new PublicKey(
-  "6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P"
+  "6EF8rrecthR5Dkzon8Nwu78hRvfCKubJ14M5uBEwF6P",
 );
 
 export function getPumpAmmProgram(connection: Connection): Program<PumpAmm> {
@@ -65,9 +76,7 @@ export function getPumpAmmProgram(connection: Connection): Program<PumpAmm> {
   );
 }
 
-export function getPumpFeeProgram(
-    connection: Connection,
-): Program<PumpFees> {
+export function getPumpFeeProgram(connection: Connection): Program<PumpFees> {
   return new Program(
     PumpFeesIdl as PumpFees,
     new AnchorProvider(connection, null as any, {}),
@@ -75,21 +84,21 @@ export function getPumpFeeProgram(
 }
 
 export const PUMP_AMM_PROGRAM_ID = new PublicKey(
-  "pAMMBay6oceH9fJKBRHGP5D4bD4sWpmSwMn52FMfXEA"
+  "pAMMBay6oceH9fJKBRHGP5D4bD4sWpmSwMn52FMfXEA",
 );
 
 export const MAYHEM_PROGRAM_ID = new PublicKey(
-  "MAyhSmzXzV1pTf7LsNkrNwkWKTo4ougAJ1PPg47MD4e"
+  "MAyhSmzXzV1pTf7LsNkrNwkWKTo4ougAJ1PPg47MD4e",
 );
 
 export const PUMP_FEE_PROGRAM_ID = new PublicKey(
-  "pfeeUxB6jkeY1Hxd7CsFCAjcbHA9rWtchMGdZ6VojVZ"
+  "pfeeUxB6jkeY1Hxd7CsFCAjcbHA9rWtchMGdZ6VojVZ",
 );
 
 export const BONDING_CURVE_NEW_SIZE = 151;
 
 export const PUMP_TOKEN_MINT = new PublicKey(
-  "pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn"
+  "pumpCmXqMfrsAkQ5r49WcJnRayYRqmXz6ae8H7H9Dfn",
 );
 
 export const MAX_SHAREHOLDERS = 10;
@@ -104,40 +113,40 @@ export class PumpSdk {
     // Create offline programs for fee and AMM
     this.offlinePumpFeeProgram = new Program(
       PumpFeesIdl as PumpFees,
-      new AnchorProvider(null as any, null as any, {})
+      new AnchorProvider(null as any, null as any, {}),
     );
     this.offlinePumpAmmProgram = new Program(
       PumpAmmIdl as PumpAmm,
-      new AnchorProvider(null as any, null as any, {})
+      new AnchorProvider(null as any, null as any, {}),
     );
   }
 
   decodeGlobal(accountInfo: AccountInfo<Buffer>): Global {
     return this.offlinePumpProgram.coder.accounts.decode<Global>(
       "global",
-      accountInfo.data
+      accountInfo.data,
     );
   }
 
   decodeFeeConfig(accountInfo: AccountInfo<Buffer>): FeeConfig {
     return this.offlinePumpProgram.coder.accounts.decode<FeeConfig>(
       "feeConfig",
-      accountInfo.data
+      accountInfo.data,
     );
   }
 
   decodeBondingCurve(accountInfo: AccountInfo<Buffer>): BondingCurve {
     return this.offlinePumpProgram.coder.accounts.decode<BondingCurve>(
       "bondingCurve",
-      accountInfo.data
+      accountInfo.data,
     );
   }
 
   decodeBondingCurveNullable(
-    accountInfo: AccountInfo<Buffer>
+    accountInfo: AccountInfo<Buffer>,
   ): BondingCurve | null {
     try {
-      let data = accountInfo.data;
+      const data = accountInfo.data;
       // Ensure buffer is at least 82 bytes
       if (data.length < 82) {
         const padded = Buffer.alloc(82);
@@ -149,37 +158,37 @@ export class PumpSdk {
       }
 
       return this.decodeBondingCurve(accountInfo);
-    } catch (e) {
-      console.warn("Failed to decode bonding curve", e);
+    } catch (error) {
+      console.warn("Failed to decode bonding curve", error);
       return null;
     }
   }
 
   decodeGlobalVolumeAccumulator(
-    accountInfo: AccountInfo<Buffer>
+    accountInfo: AccountInfo<Buffer>,
   ): GlobalVolumeAccumulator {
     return this.offlinePumpProgram.coder.accounts.decode<GlobalVolumeAccumulator>(
       "globalVolumeAccumulator",
-      accountInfo.data
+      accountInfo.data,
     );
   }
 
   decodeUserVolumeAccumulator(
-    accountInfo: AccountInfo<Buffer>
+    accountInfo: AccountInfo<Buffer>,
   ): UserVolumeAccumulator {
     return this.offlinePumpProgram.coder.accounts.decode<UserVolumeAccumulator>(
       "userVolumeAccumulator",
-      accountInfo.data
+      accountInfo.data,
     );
   }
 
   decodeUserVolumeAccumulatorNullable(
-    accountInfo: AccountInfo<Buffer>
+    accountInfo: AccountInfo<Buffer>,
   ): UserVolumeAccumulator | null {
     try {
       return this.decodeUserVolumeAccumulator(accountInfo);
-    } catch (e) {
-      console.warn("Failed to decode user volume accumulator", e);
+    } catch (error) {
+      console.warn("Failed to decode user volume accumulator", error);
       return null;
     }
   }
@@ -227,6 +236,7 @@ export class PumpSdk {
     creator,
     user,
     mayhemMode,
+    cashback = false,
   }: {
     mint: PublicKey;
     name: string;
@@ -235,9 +245,10 @@ export class PumpSdk {
     creator: PublicKey;
     user: PublicKey;
     mayhemMode: boolean;
+    cashback?: boolean;
   }): Promise<TransactionInstruction> {
     return await this.offlinePumpProgram.methods
-      .createV2(name, symbol, uri, creator, mayhemMode)
+      .createV2(name, symbol, uri, creator, mayhemMode, [cashback ?? false])
       .accountsPartial({
         mint,
         user,
@@ -281,7 +292,7 @@ export class PumpSdk {
         await this.extendAccountInstruction({
           account: bondingCurvePda(mint),
           user,
-        })
+        }),
       );
     }
 
@@ -289,7 +300,7 @@ export class PumpSdk {
       mint,
       user,
       true,
-      tokenProgram
+      tokenProgram,
     );
 
     if (!associatedUserAccountInfo) {
@@ -299,8 +310,8 @@ export class PumpSdk {
           associatedUser,
           user,
           mint,
-          tokenProgram
-        )
+          tokenProgram,
+        ),
       );
     }
 
@@ -316,7 +327,7 @@ export class PumpSdk {
         slippage,
         tokenProgram,
         mayhemMode: bondingCurve.isMayhemMode,
-      })
+      }),
     );
 
     return instructions;
@@ -333,6 +344,7 @@ export class PumpSdk {
     amount,
     solAmount,
     mayhemMode,
+    cashback = false,
   }: {
     global: Global;
     mint: PublicKey;
@@ -344,12 +356,13 @@ export class PumpSdk {
     amount: BN;
     solAmount: BN;
     mayhemMode: boolean;
+    cashback?: boolean;
   }): Promise<TransactionInstruction[]> {
     const associatedUser = getAssociatedTokenAddressSync(
       mint,
       user,
       true,
-      TOKEN_2022_PROGRAM_ID
+      TOKEN_2022_PROGRAM_ID,
     );
     return [
       await this.createV2Instruction({
@@ -360,6 +373,7 @@ export class PumpSdk {
         creator,
         user,
         mayhemMode,
+        cashback,
       }),
       await this.extendAccountInstruction({
         account: bondingCurvePda(mint),
@@ -370,7 +384,7 @@ export class PumpSdk {
         associatedUser,
         user,
         mint,
-        TOKEN_2022_PROGRAM_ID
+        TOKEN_2022_PROGRAM_ID,
       ),
       await this.buyInstruction({
         global,
@@ -422,7 +436,7 @@ export class PumpSdk {
         user,
         associatedUser,
         user,
-        mint
+        mint,
       ),
       await this.buyInstruction({
         global,
@@ -470,7 +484,7 @@ export class PumpSdk {
       feeRecipient: getFeeRecipient(global, mayhemMode),
       amount,
       solAmount: solAmount.add(
-        solAmount.mul(new BN(Math.floor(slippage * 10))).div(new BN(1000))
+        solAmount.mul(new BN(Math.floor(slippage * 10))).div(new BN(1000)),
       ),
       tokenProgram,
     });
@@ -487,6 +501,7 @@ export class PumpSdk {
     slippage,
     tokenProgram = TOKEN_PROGRAM_ID,
     mayhemMode = false,
+    cashback = false,
   }: {
     global: Global;
     bondingCurveAccountInfo: AccountInfo<Buffer>;
@@ -498,6 +513,7 @@ export class PumpSdk {
     slippage: number;
     tokenProgram: PublicKey;
     mayhemMode: boolean;
+    cashback?: boolean;
   }): Promise<TransactionInstruction[]> {
     const instructions: TransactionInstruction[] = [];
 
@@ -506,7 +522,7 @@ export class PumpSdk {
         await this.extendAccountInstruction({
           account: bondingCurvePda(mint),
           user,
-        })
+        }),
       );
     }
 
@@ -518,10 +534,11 @@ export class PumpSdk {
         feeRecipient: getFeeRecipient(global, mayhemMode),
         amount,
         solAmount: solAmount.sub(
-          solAmount.mul(new BN(Math.floor(slippage * 10))).div(new BN(1000))
+          solAmount.mul(new BN(Math.floor(slippage * 10))).div(new BN(1000)),
         ),
         tokenProgram,
-      })
+        cashback,
+      }),
     );
 
     return instructions;
@@ -559,7 +576,7 @@ export class PumpSdk {
       mint,
       bondingCurve,
       true,
-      tokenProgram
+      tokenProgram,
     );
 
     const poolAuthority = pumpPoolAuthorityPda(mint);
@@ -567,7 +584,7 @@ export class PumpSdk {
       mint,
       poolAuthority,
       true,
-      tokenProgram
+      tokenProgram,
     );
 
     const pool = canonicalPumpPoolPda(mint);
@@ -575,7 +592,7 @@ export class PumpSdk {
       mint,
       pool,
       true,
-      tokenProgram
+      tokenProgram,
     );
     return this.offlinePumpProgram.methods
       .migrate()
@@ -591,7 +608,7 @@ export class PumpSdk {
   }
 
   async syncUserVolumeAccumulator(
-    user: PublicKey
+    user: PublicKey,
   ): Promise<TransactionInstruction> {
     return await this.offlinePumpProgram.methods
       .syncUserVolumeAccumulator()
@@ -631,7 +648,7 @@ export class PumpSdk {
   }
 
   async closeUserVolumeAccumulator(
-    user: PublicKey
+    user: PublicKey,
   ): Promise<TransactionInstruction> {
     return await this.offlinePumpProgram.methods
       .closeUserVolumeAccumulator()
@@ -662,7 +679,7 @@ export class PumpSdk {
         mint,
         user,
         true,
-        tokenProgram
+        tokenProgram,
       ),
       mint,
       creator,
@@ -699,7 +716,7 @@ export class PumpSdk {
         associatedUser,
         user,
         creatorVault: creatorVaultPda(creator),
-        tokenProgram: tokenProgram,
+        tokenProgram,
       })
       .instruction();
   }
@@ -712,6 +729,7 @@ export class PumpSdk {
     solAmount,
     feeRecipient = getStaticRandomFeeRecipient(),
     tokenProgram = TOKEN_PROGRAM_ID,
+    cashback = false,
   }: {
     user: PublicKey;
     mint: PublicKey;
@@ -720,6 +738,7 @@ export class PumpSdk {
     solAmount: BN;
     feeRecipient: PublicKey;
     tokenProgram: PublicKey;
+    cashback?: boolean;
   }): Promise<TransactionInstruction> {
     return await this.getSellInstructionInternal({
       user,
@@ -729,6 +748,7 @@ export class PumpSdk {
       amount,
       solAmount,
       tokenProgram,
+      cashback,
     });
   }
 
@@ -740,6 +760,7 @@ export class PumpSdk {
     amount,
     solAmount,
     tokenProgram,
+    cashback = false,
   }: {
     user: PublicKey;
     mint: PublicKey;
@@ -748,7 +769,9 @@ export class PumpSdk {
     amount: BN;
     solAmount: BN;
     tokenProgram: PublicKey;
+    cashback?: boolean;
   }): Promise<TransactionInstruction> {
+    const userVolumeAccumulator = userVolumeAccumulatorPda(user);
     return await this.offlinePumpProgram.methods
       .sell(amount, solAmount)
       .accountsPartial({
@@ -758,12 +781,23 @@ export class PumpSdk {
           mint,
           user,
           true,
-          tokenProgram
+          tokenProgram,
         ),
         user,
         creatorVault: creatorVaultPda(creator),
-        tokenProgram: tokenProgram,
+        tokenProgram,
       })
+      .remainingAccounts(
+        cashback
+          ? [
+              {
+                pubkey: userVolumeAccumulator,
+                isWritable: true,
+                isSigner: false,
+              },
+            ]
+          : [],
+      )
       .instruction();
   }
 
@@ -794,7 +828,6 @@ export class PumpSdk {
       .instruction();
   }
 
-
   /**
    * Updates the fee shares for a token's creator fee distribution.
    *
@@ -803,7 +836,6 @@ export class PumpSdk {
    * @param params.mint - The mint address of the token
    * @param params.curShareholders - Array of current shareholders
    * @param params.newShareholders - Array of new shareholders and their share percentages
-   *
    * @requirements for newShareholders:
    * - Must contain at least 1 shareholder (cannot be empty)
    * - Maximum of 10 shareholders allowed
@@ -811,13 +843,11 @@ export class PumpSdk {
    * - Total shares must equal exactly 10,000 basis points (100%)
    * - No duplicate addresses allowed
    * - shareBps is in basis points where 1 bps = 0.01% (e.g., 1500 = 15%)
-   *
    * @throws {NoShareholdersError} If shareholders array is empty
    * @throws {TooManyShareholdersError} If more than 10 shareholders
    * @throws {ZeroShareError} If any shareholder has zero or negative shares
    * @throws {InvalidShareTotalError} If total shares don't equal 10,000 basis points
    * @throws {DuplicateShareholderError} If duplicate addresses are found
-   *
    * @example
    * ```typescript
    * const instruction = await PUMP_SDK.updateFeeShares({
@@ -848,7 +878,10 @@ export class PumpSdk {
     }
 
     if (newShareholders.length > MAX_SHAREHOLDERS) {
-      throw new TooManyShareholdersError(newShareholders.length, MAX_SHAREHOLDERS);
+      throw new TooManyShareholdersError(
+        newShareholders.length,
+        MAX_SHAREHOLDERS,
+      );
     }
 
     let totalShares = 0;
@@ -872,26 +905,31 @@ export class PumpSdk {
     }
 
     const sharingConfigPda = feeSharingConfigPda(mint);
-    const coinCreatorVaultAuthority = coinCreatorVaultAuthorityPda(sharingConfigPda);
+    const coinCreatorVaultAuthority =
+      coinCreatorVaultAuthorityPda(sharingConfigPda);
 
     return await this.offlinePumpFeeProgram.methods
       .updateFeeShares(
-        newShareholders.map(sh => ({
+        newShareholders.map((sh) => ({
           address: sh.address,
           shareBps: sh.shareBps,
-        }))
+        })),
       )
       .accountsPartial({
         authority,
         mint,
-        coinCreatorVaultAta: coinCreatorVaultAtaPda(coinCreatorVaultAuthority, NATIVE_MINT, TOKEN_PROGRAM_ID),
+        coinCreatorVaultAta: coinCreatorVaultAtaPda(
+          coinCreatorVaultAuthority,
+          NATIVE_MINT,
+          TOKEN_PROGRAM_ID,
+        ),
       })
       .remainingAccounts(
         currentShareholders.map((pubkey) => ({
           pubkey,
           isWritable: true,
           isSigner: false,
-        }))
+        })),
       )
       .instruction();
   }
@@ -899,7 +937,7 @@ export class PumpSdk {
   decodeDistributeCreatorFeesEvent(data: Buffer): DistributeCreatorFeesEvent {
     return this.offlinePumpProgram.coder.types.decode<DistributeCreatorFeesEvent>(
       "distributeCreatorFeesEvent",
-      data
+      data,
     );
   }
 
@@ -923,7 +961,7 @@ export class PumpSdk {
           pubkey: shareholder.address,
           isWritable: true,
           isSigner: false,
-        }))
+        })),
       )
       .instruction();
   }
@@ -931,7 +969,7 @@ export class PumpSdk {
   decodeMinimumDistributableFee(data: Buffer): MinimumDistributableFeeEvent {
     return this.offlinePumpProgram.coder.types.decode<MinimumDistributableFeeEvent>(
       "minimumDistributableFeeEvent",
-      data
+      data,
     );
   }
 
@@ -955,10 +993,23 @@ export class PumpSdk {
           pubkey: shareholder.address,
           isWritable: true,
           isSigner: false,
-        }))
+        })),
       )
       .instruction();
   }
+
+  async claimCashbackInstruction({
+    user,
+  }: {
+    user: PublicKey;
+  }): Promise<TransactionInstruction> {
+    return await this.offlinePumpProgram.methods
+      .claimCashback()
+      .accountsPartial({
+        user,
+      })
+      .instruction();
+  }
 }
 
 export const PUMP_SDK = new PumpSdk();
@@ -975,9 +1026,7 @@ export const PUMP_SDK = new PumpSdk();
  * @param params.creator - The creator address to check
  *                         - For ungraduated coins: use BondingCurve.creator
  *                         - For graduated coins: use Pool.coinCreator (from AMM pool)
- *
  * @returns true if the creator has migrated to fee sharing config, false otherwise
- *
  * @example
  * ```typescript
  * import { isCreatorUsingSharingConfig } from "@pump-fun/sdk";

package/src/state.ts

@@ -1,5 +1,5 @@
-import BN from "bn.js";
 import { PublicKey } from "@solana/web3.js";
+import BN from "bn.js";
 
 export interface Global {
   // unused

package/src/tokenIncentives.ts

@@ -1,4 +1,5 @@
 import BN from "bn.js";
+
 import { GlobalVolumeAccumulator, UserVolumeAccumulator } from "./state";
 
 export function totalUnclaimedTokens(
@@ -17,7 +18,7 @@ export function totalUnclaimedTokens(
     return result;
   }
 
-  let currentTimestampBn = new BN(currentTimestamp);
+  const currentTimestampBn = new BN(currentTimestamp);
 
   if (currentTimestampBn.lt(startTime)) {
     return result;
@@ -74,7 +75,7 @@ export function currentDayTokens(
     return new BN(0);
   }
 
-  let currentTimestampBn = new BN(currentTimestamp);
+  const currentTimestampBn = new BN(currentTimestamp);
 
   if (currentTimestampBn.lt(startTime) || currentTimestampBn.gt(endTime)) {
     return new BN(0);