How pump-fun/pump-public-docs works
Project type and purpose
• This is an open-source documentation and IDL distribution repo for two Solana on-chain programs: Pump (bonding curves) and PumpSwap (AMM).
• It provides:
• Markdown guides in docs/ explaining fee updates, use cases, integration steps.
• Interface Definition Language files (idl/*.json and idl/*.ts) that describe the on-chain programs’ APIs.
File structure
• Top-level:
• README.md – high-level project overview and integration advice.
• docs/ – detailed upgrade guides and per-program READMEs.
• idl/ – protocol schemas (Pump & Pump AMM) in JSON and TypeScript form.
• No source code beyond IDLs—this repo’s role is to serve docs and type definitions.
README for additional insights
• Purpose: announce and guide implementation of “coin creator fee” updates.
• Integration: recommends using the provided IDL and the two NPM packages:
– @pump-fun/pump-sdk
– @pump-fun/pump-swap-sdk
Main components
a. Developer / Integrator – reads docs, chooses IDL, writes code
b. Documentation Layer (docs/ & README.md) – guides upgrade steps and API usage
c. **IDL Layer (idl/*.json & idl/*.ts)** – binds program interface definitions to code
d. TypeScript SDKs – pump-sdk, pump-swap-sdk (external NPM libraries)
e. Solana JSON-RPC Endpoint – network interface for submitting transactions
f. On-Chain Programs
• Pump Program (bonding curves)
• PumpSwap (AMM) Program
g. Blockchain State Accounts – account data managed by the programs
Relationships & interactions
• Developer consults Documentation → selects matching IDL files → imports into SDK → writes application code.
• SDK uses IDL to serialize instructions → sends RPC calls to Solana JSON-RPC → invokes Pump & PumpSwap programs → updates on-chain accounts.
Architectural patterns & design principles
• Interface-Driven: IDL → SDK codegen → client apps
• Separation of Concerns: docs vs. type definitions vs. network interface vs. on-chain logic
• Extensibility: new instructions or fee updates are added in IDL and docs without touching on-chain code in this repo.
Relevant technologies
• Markdown for documentation
• Anchor IDL (JSON & TS) for interface definitions
• TypeScript NPM packages (@pump-fun/pump-sdk, @pump-fun/pump-swap-sdk)
• Solana JSON-RPC protocol
• On-chain Rust programs (Pump, PumpSwap)
• Component names (Docs, IDL, Pump SDK, PumpSwap SDK, JSON-RPC, Pump, PumpSwap, Accounts)