Skip to content

examples

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
__tests__
__tests__
 
 
_lib
_lib
 
 
01-create-token.ts
01-create-token.ts
 
 
02-create-and-buy.ts
02-create-and-buy.ts
 
 
03-buy-tokens.ts
03-buy-tokens.ts
 
 
04-sell-tokens.ts
04-sell-tokens.ts
 
 
05-buy-by-sol-amount.ts
05-buy-by-sol-amount.ts
 
 
06-sell-by-percentage.ts
06-sell-by-percentage.ts
 
 
07-sell-all.ts
07-sell-all.ts
 
 
08-sell-to-target-sol.ts
08-sell-to-target-sol.ts
 
 
09-mayhem-mode.ts
09-mayhem-mode.ts
 
 
10-cashback-token.ts
10-cashback-token.ts
 
 
11-buy-quote-offline.ts
11-buy-quote-offline.ts
 
 
12-sell-quote-offline.ts
12-sell-quote-offline.ts
 
 
13-market-cap.ts
13-market-cap.ts
 
 
14-target-sol.ts
14-target-sol.ts
 
 
15-max-safe-sell.ts
15-max-safe-sell.ts
 
 
16-launch-price-ladder.ts
16-launch-price-ladder.ts
 
 
17-fee-tiers.ts
17-fee-tiers.ts
 
 
18-fee-recipients.ts
18-fee-recipients.ts
 
 
19-breaking-fee-validation.ts
19-breaking-fee-validation.ts
 
 
20-price-impact-offline.ts
20-price-impact-offline.ts
 
 
21-derive-pdas.ts
21-derive-pdas.ts
 
 
22-decode-global.ts
22-decode-global.ts
 
 
23-decode-bonding-curve.ts
23-decode-bonding-curve.ts
 
 
24-decode-fee-config.ts
24-decode-fee-config.ts
 
 
25-decode-pool.ts
25-decode-pool.ts
 
 
26-parse-transaction-events.ts
26-parse-transaction-events.ts
 
 
27-decode-trade-events.ts
27-decode-trade-events.ts
 
 
28-volume-accumulators.ts
28-volume-accumulators.ts
 
 
29-sharing-config.ts
29-sharing-config.ts
 
 
30-event-catalog.ts
30-event-catalog.ts
 
 
31-fetch-global-state.ts
31-fetch-global-state.ts
 
 
32-curve-summary.ts
32-curve-summary.ts
 
 
33-graduation-progress.ts
33-graduation-progress.ts
 
 
34-token-price.ts
34-token-price.ts
 
 
35-price-impact.ts
35-price-impact.ts
 
 
36-live-quotes.ts
36-live-quotes.ts
 
 
37-batch-curves.ts
37-batch-curves.ts
 
 
38-batch-pools.ts
38-batch-pools.ts
 
 
39-routed-trading.ts
39-routed-trading.ts
 
 
40-websocket-trades.ts
40-websocket-trades.ts
 
 
41-amm-buy.ts
41-amm-buy.ts
 
 
42-amm-sell.ts
42-amm-sell.ts
 
 
43-amm-deposit.ts
43-amm-deposit.ts
 
 
44-amm-withdraw.ts
44-amm-withdraw.ts
 
 
45-canonical-pool.ts
45-canonical-pool.ts
 
 
46-fee-sharing-create.ts
46-fee-sharing-create.ts
 
 
47-fee-sharing-distribute.ts
47-fee-sharing-distribute.ts
 
 
48-creator-fees.ts
48-creator-fees.ts
 
 
49-token-incentives.ts
49-token-incentives.ts
 
 
50-vanity-mint.ts
50-vanity-mint.ts
 
 
README.md
README.md
 
 
tsconfig.json
tsconfig.json
 
 

README.md

Runnable Examples

Fifty self-contained, tested examples covering the full surface of @nirholas/pump-sdk: token creation, bonding curve trading, curve math, fees, PDAs, account decoding, event parsing, live mainnet reads, AMM pools, fee sharing, incentives, and vanity mints.

Every example:

  • runs against the SDK source in this repo (@nirholas/pump-sdk is path-mapped to src/),
  • exports its core logic as plain functions with a main() walkthrough on top,
  • has a matching offline Jest test in __tests__/,
  • has a step-by-step tutorial in ../tutorials/examples/.

No example ever broadcasts a transaction. Examples that build spend instructions print them and stop; sending is always your explicit, separate step. Read-only examples fetch live mainnet state.

Run one

npm install
npm run example 11        # by number
npm run example 11-buy-quote-offline   # or by name

List all runnable examples:

npm run example

Test them all

npm run test:examples

The example tests are fully offline and deterministic: they exercise the exported functions with the same mainnet-shaped fixtures the SDK unit suite uses.

Configuration (all optional)

Env var Purpose Default
PUMP_RPC_URL RPC endpoint for live examples public mainnet RPC
MINT Token mint for the live read examples a token discovered off the live Pump log stream
GRADUATED_MINT Graduated token for the AMM and routing examples a pool discovered off the live AMM log stream
PUMP_WALLET Path to a solana-keygen JSON keypair ephemeral keypair
PUMP_WALLET_SECRET base58 secret key ephemeral keypair

Categories

Range Category What it covers
01-10 Token Lifecycle createV2, create-and-buy, buy, sell, sell-all, sell-by-percentage, mayhem mode, cashback
11-20 Curve Math & Fees offline quotes, market cap, fee tiers, breaking fee recipients, price impact
21-30 Accounts & Events every PDA, decoding all account types, parsing all protocol events
31-40 Live Data mainnet reads: global state, curve summaries, graduation, prices, batch fetches, WebSocket feeds
41-50 AMM & Advanced AMM trading and liquidity, fee sharing, creator fees, incentives, vanity mints

The shared helpers live in _lib/: connection, wallet loading, and BN-safe formatting.