PumpFunSDK README

Important

Never click links in this repository leaving github, never click links in Issues, don't run code that others post without reading it, this software is provided "as is," without warranty.

Overview

The PumpDotFunSDK is designed to interact with the Pump.fun decentralized application. It provides methods for creating, buying, and selling tokens using the Solana blockchain. The SDK handles the necessary transactions and interactions with the Pump.fun program.

Installation

npm i pumpdotfun-sdk

Usage Example

First you need to create a .env file and set your RPC URL like in the .env.example

Then you need to fund an account with atleast 0.004 SOL that is generated when running the command below

npx ts-node example/basic/index.ts

1import dotenv from "dotenv";
2import { Connection, Keypair, LAMPORTS_PER_SOL } from "@solana/web3.js";
3import { DEFAULT_DECIMALS, PumpFunSDK } from "pumpdotfun-sdk";
4import NodeWallet from "@coral-xyz/anchor/dist/cjs/nodewallet";
5import { AnchorProvider } from "@coral-xyz/anchor";
6import {
7  getOrCreateKeypair,
8  getSPLBalance,
9  printSOLBalance,
10  printSPLBalance,
11} from "./util";
12
13dotenv.config();
14
15const KEYS_FOLDER = __dirname + "/.keys";
16const SLIPPAGE_BASIS_POINTS = 100n;
17
18const getProvider = () => {
19  if (!process.env.HELIUS_RPC_URL) {
20    throw new Error("Please set HELIUS_RPC_URL in .env file");
21  }
22
23  const connection = new Connection(process.env.HELIUS_RPC_URL || "");
24  const wallet = new NodeWallet(new Keypair());
25  return new AnchorProvider(connection, wallet, { commitment: "finalized" });
26};
27
28const createAndBuyToken = async (sdk, testAccount, mint) => {
29  const tokenMetadata = {
30    name: "TST-7",
31    symbol: "TST-7",
32    description: "TST-7: This is a test token",
33    filePath: "example/basic/random.png",
34  };
35
36  const createResults = await sdk.createAndBuy(
37    testAccount,
38    mint,
39    tokenMetadata,
40    BigInt(0.0001 * LAMPORTS_PER_SOL),
41    SLIPPAGE_BASIS_POINTS,
42    {
43      unitLimit: 250000,
44      unitPrice: 250000,
45    }
46  );
47
48  if (createResults.success) {
49    console.log("Success:", `https://pump.fun/${mint.publicKey.toBase58()}`);
50    printSPLBalance(sdk.connection, mint.publicKey, testAccount.publicKey);
51  } else {
52    console.log("Create and Buy failed");
53  }
54};
55
56const buyTokens = async (sdk, testAccount, mint) => {
57  const buyResults = await sdk.buy(
58    testAccount,
59    mint.publicKey,
60    BigInt(0.0001 * LAMPORTS_PER_SOL),
61    SLIPPAGE_BASIS_POINTS,
62    {
63      unitLimit: 250000,
64      unitPrice: 250000,
65    }
66  );
67
68  if (buyResults.success) {
69    printSPLBalance(sdk.connection, mint.publicKey, testAccount.publicKey);
70    console.log("Bonding curve after buy", await sdk.getBondingCurveAccount(mint.publicKey));
71  } else {
72    console.log("Buy failed");
73  }
74};
75
76const sellTokens = async (sdk, testAccount, mint) => {
77  const currentSPLBalance = await getSPLBalance(
78    sdk.connection,
79    mint.publicKey,
80    testAccount.publicKey
81  );
82  console.log("currentSPLBalance", currentSPLBalance);
83
84  if (currentSPLBalance) {
85    const sellResults = await sdk.sell(
86      testAccount,
87      mint.publicKey,
88      BigInt(currentSPLBalance * Math.pow(10, DEFAULT_DECIMALS)),
89      SLIPPAGE_BASIS_POINTS,
90      {
91        unitLimit: 250000,
92        unitPrice: 250000,
93      }
94    );
95
96    if (sellResults.success) {
97      await printSOLBalance(sdk.connection, testAccount.publicKey, "Test Account keypair");
98      printSPLBalance(sdk.connection, mint.publicKey, testAccount.publicKey, "After SPL sell all");
99      console.log("Bonding curve after sell", await sdk.getBondingCurveAccount(mint.publicKey));
100    } else {
101      console.log("Sell failed");
102    }
103  }
104};
105
106const main = async () => {
107  try {
108    const provider = getProvider();
109    const sdk = new PumpFunSDK(provider);
110    const connection = provider.connection;
111
112    const testAccount = getOrCreateKeypair(KEYS_FOLDER, "test-account");
113    const mint = getOrCreateKeypair(KEYS_FOLDER, "mint");
114
115    await printSOLBalance(connection, testAccount.publicKey, "Test Account keypair");
116
117    const globalAccount = await sdk.getGlobalAccount();
118    console.log(globalAccount);
119
120    const currentSolBalance = await connection.getBalance(testAccount.publicKey);
121    if (currentSolBalance === 0) {
122      console.log("Please send some SOL to the test-account:", testAccount.publicKey.toBase58());
123      return;
124    }
125
126    console.log(await sdk.getGlobalAccount());
127
128    let bondingCurveAccount = await sdk.getBondingCurveAccount(mint.publicKey);
129    if (!bondingCurveAccount) {
130      await createAndBuyToken(sdk, testAccount, mint);
131      bondingCurveAccount = await sdk.getBondingCurveAccount(mint.publicKey);
132    }
133
134    if (bondingCurveAccount) {
135      await buyTokens(sdk, testAccount, mint);
136      await sellTokens(sdk, testAccount, mint);
137    }
138  } catch (error) {
139    console.error("An error occurred:", error);
140  }
141};
142
143main();

PumpDotFunSDK Class

The PumpDotFunSDK class provides methods to interact with the PumpFun protocol. Below are the method signatures and their descriptions.

createAndBuy

1async createAndBuy(
2  creator: Keypair,
3  mint: Keypair,
4  createTokenMetadata: CreateTokenMetadata,
5  buyAmountSol: bigint,
6  slippageBasisPoints: bigint = 500n,
7  priorityFees?: PriorityFee,
8  commitment: Commitment = DEFAULT_COMMITMENT,
9  finality: Finality = DEFAULT_FINALITY
10): Promise<TransactionResult>

• Creates a new token and buys it.
• Parameters:
  • creator: The keypair of the token creator.
  • mint: The keypair of the mint account.
  • createTokenMetadata: Metadata for the token.
  • buyAmountSol: Amount of SOL to buy.
  • slippageBasisPoints: Slippage in basis points (default: 500).
  • priorityFees: Priority fees (optional).
  • commitment: Commitment level (default: DEFAULT_COMMITMENT).
  • finality: Finality level (default: DEFAULT_FINALITY).
• Returns: A promise that resolves to a TransactionResult.

buy

1async buy(
2  buyer: Keypair,
3  mint: PublicKey,
4  buyAmountSol: bigint,
5  slippageBasisPoints: bigint = 500n,
6  priorityFees?: PriorityFee,
7  commitment: Commitment = DEFAULT_COMMITMENT,
8  finality: Finality = DEFAULT_FINALITY
9): Promise<TransactionResult>

• Buys a specified amount of tokens.
• Parameters:
  • buyer: The keypair of the buyer.
  • mint: The public key of the mint account.
  • buyAmountSol: Amount of SOL to buy.
  • slippageBasisPoints: Slippage in basis points (default: 500).
  • priorityFees: Priority fees (optional).
  • commitment: Commitment level (default: DEFAULT_COMMITMENT).
  • finality: Finality level (default: DEFAULT_FINALITY).
• Returns: A promise that resolves to a TransactionResult.

sell

1async sell(
2  seller: Keypair,
3  mint: PublicKey,
4  sellTokenAmount: bigint,
5  slippageBasisPoints: bigint = 500n,
6  priorityFees?: PriorityFee,
7  commitment: Commitment = DEFAULT_COMMITMENT,
8  finality: Finality = DEFAULT_FINALITY
9): Promise<TransactionResult>

• Sells a specified amount of tokens.
• Parameters:
  • seller: The keypair of the seller.
  • mint: The public key of the mint account.
  • sellTokenAmount: Amount of tokens to sell.
  • slippageBasisPoints: Slippage in basis points (default: 500).
  • priorityFees: Priority fees (optional).
  • commitment: Commitment level (default: DEFAULT_COMMITMENT).
  • finality: Finality level (default: DEFAULT_FINALITY).
• Returns: A promise that resolves to a TransactionResult.

addEventListener

1addEventListener<T extends PumpFunEventType>(
2  eventType: T,
3  callback: (event: PumpFunEventHandlers[T], slot: number, signature: string) => void
4): number

• Adds an event listener for the specified event type.
• Parameters:
  • eventType: The type of event to listen for.
  • callback: The callback function to execute when the event occurs.
• Returns: An identifier for the event listener.

removeEventListener

1removeEventListener(eventId: number): void

• Removes the event listener with the specified identifier.
• Parameters:
  • eventId: The identifier of the event listener to remove.

Running the Examples

Basic Example

To run the basic example for creating, buying, and selling tokens, use the following command:

1npx ts-node example/basic/index.ts

Event Subscription Example

This example demonstrates how to set up event subscriptions using the PumpFun SDK.

Script: example/events/events.ts

1import dotenv from "dotenv";
2import { Connection, Keypair } from "@solana/web3.js";
3import { PumpFunSDK } from "pumpdotfun-sdk";
4import NodeWallet from "@coral-xyz/anchor/dist/cjs/nodewallet";
5import { AnchorProvider } from "@coral-xyz/anchor";
6
7dotenv.config();
8
9const getProvider = () => {
10  if (!process.env.HELIUS_RPC_URL) {
11    throw new Error("Please set HELIUS_RPC_URL in .env file");
12  }
13
14  const connection = new Connection(process.env.HELIUS_RPC_URL || "");
15  const wallet = new NodeWallet(new Keypair());
16  return new AnchorProvider(connection, wallet, { commitment: "finalized" });
17};
18
19const setupEventListeners = async (sdk) => {
20  const createEventId = sdk.addEventListener("createEvent", (event, slot, signature) => {
21    console.log("createEvent", event, slot, signature);
22  });
23  console.log("Subscribed to createEvent with ID:", createEventId);
24
25  const tradeEventId = sdk.addEventListener("tradeEvent", (event, slot, signature) => {
26    console.log("tradeEvent", event, slot, signature);
27  });
28  console.log("Subscribed to tradeEvent with ID:", tradeEventId);
29
30  const completeEventId = sdk.addEventListener("completeEvent", (event, slot, signature) => {
31    console.log("completeEvent", event, slot, signature);
32  });
33  console.log("Subscribed to completeEvent with ID:", completeEventId);
34};
35
36const main = async () => {
37  try {
38    const provider = getProvider();
39    const sdk = new PumpFunSDK(provider);
40
41    // Set up event listeners
42    await setupEventListeners(sdk);
43  } catch (error) {
44    console.error("An error occurred:", error);
45  }
46};
47
48main();

Running the Event Subscription Example

To run the event subscription example, use the following command:

1npx ts-node example/events/events.ts

Contributing

We welcome contributions! Please submit a pull request or open an issue to discuss any changes.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Here is a sample "Use at Your Own Risk" disclaimer for a GitHub repository:

---

Disclaimer

This software is provided "as is," without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.

Use at your own risk. The authors take no responsibility for any harm or damage caused by the use of this software. Users are responsible for ensuring the suitability and safety of this software for their specific use cases.

By using this software, you acknowledge that you have read, understood, and agree to this disclaimer.

---

Feel free to customize it further to suit the specific context and requirements of your project.

---

By following this README, you should be able to install the PumpDotFun SDK, run the provided examples, and understand how to set up event listeners and perform token operations.