Python SDK + optional CLI for Pump.fun’s PumpSwap AMM on Solana
Project description
PumpSwapAMM
Python SDK + CLI client for PumpSwap AMM on Solana.
- Trade, create, and manage - Pools (aka Pairs), and Tokens.
- Grind addresses ending with
...pumpfor your tokens. - Support for Bunny.net API to store images and metadata off-chain.
The module implements ways to fetch pool keys and price or account reserves, deriving addresses, finding pools and more...
Tip wallet: 3oFDwxVtZEpSGeNgdWRiJtNiArv4k9FiMsMz3yjudgeS, Thanks đź’™
https://github.com/user-attachments/assets/50336975-fcab-4e15-b021-62be9ba1ab12
📹 Watch the demo video
Contact & Support
Discord: FLOCK4H.CAVE, Telegram: FLOCK4H.CAVE
Telegram private handle: @dubskii420
Setup
Most convenient:
If module or a command can't be found, try installing with administrative rights
$ pip install PumpSwapAMM
If above fails for any reason:
$ git clone https://github.com/FLOCK4H/PumpSwapAMM
$ cd PumpSwapAMM
$ pip install .
CLI & Bunny.net Setup
[!TIP]
pumpswapCLI is being shipped with PumpSwapAMM, but when not using CLI the Bunny.net setup is unnecessary. Also,import pumpswapclienables you to use metaplex api to create and mint your tokens in your own application.
- Create a storage zone
- Create + Connect Pull Zone
- Save information for later:
- Pull zone name
- FPT & API Access -> Password
- Storage zone name
-
Run
pumpswapcommand -
Create
.envfile with below schema or you will be prompted to enter credentials at app's start
ACCESS_KEY=bunny-password-key
STORAGE_ZONE_NAME=bunny-storage-zone-name
PRIVATE_KEY=your-solana-private-key
RPC_URL="https://mainnet.helius-rpc.com/?api-key=your-api-key"
REGION=
PULL_ZONE_NAME=yourzonename
You can leave all Bunny related fields empty if you're not creating tokens/ don't want to use Bunny:
- ACCESS_KEY
- STORAGE_ZONE_NAME
- REGION
- PULL_ZONE_NAME
[NEW] PumpSwapCLI
- Create tokens via Metaplex, mint & modify authorities via user-friendly CLI application
- Deploy and manage PumpSwap Liquidity Pools including:
- Create Pool
- Withdraw
- Deposit
- Trade tokens on PumpSwap.
Usage
Check out the example.py and example_pool.py scripts for a plug&play implementation
class PumpSwap(
async_client: AsyncClient,
signer: Keypair
)
(method) def buy(
pool_data: dict,
sol_amount: float,
slippage_pct: float,
fee_sol: float
) -> Coroutine[Any, Any, bool]
Args:
pool_data: dict
sol_amount: float
slippage_pct: float
fee_sol: float
Returns:
bool: True if successful, False otherwise
(method) def sell(
pool_data: dict,
sell_pct: float,
slippage_pct: float,
fee_sol: float
) -> Coroutine[Any, Any, bool]
Args:
pool_data: dict
sell_pct: float
slippage_pct: float
fee_sol: float
Returns:
bool: True if successful, False otherwise
(function) def fetch_pool(
pool: str,
async_client: AsyncClient
) -> Coroutine[Any, Any, dict[str, Any]]
(function) def fetch_pool_base_price(
pool_keys: Any,
async_client: Any
) -> Coroutine[Any, Any, tuple[Decimal, Any, Any] | None]
(method) def derive_pool_address(
creator: Pubkey,
base_mint: Pubkey,
quote_mint: Pubkey,
index: int = 0
) -> Pubkey
(method) def create_pool(
base_mint: Pubkey,
base_amount_tokens: float,
quote_amount_sol: float,
decimals_base: int = 6,
index: int = 0,
fee_sol: float = 0.0005,
mute: bool = False
) -> Coroutine[Any, Any, bool]
(method) def withdraw(
pool_data: dict,
withdraw_pct: float,
fee_sol: float = 0.0003,
mute: bool = False
) -> Coroutine[Any, Any, bool]
(method) def deposit(
pool_data: dict,
base_amount_tokens: float,
slippage_pct: float = 1,
fee_sol: float = 0.0003,
sol_cap: float | None = None,
mute: bool = False
) -> Coroutine[Any, Any, bool]
# METAPLEX REGION
class BunnyCDNUploader(
region: str,
storage_zone_name: str,
access_key: str,
pull_zone_name: str
)
(function) async def create_and_mint_fungible_token(
async_client: AsyncClient,
metadata_uploader: Any,
signer: Keypair,
image_path: str,
name: str,
symbol: str,
description: str,
decimals: int,
initial_supply: int,
remove_auth: bool = True,
custom_mint: bool = False,
priority_fee_sol: float = 0.0005,
is_meta_uploaded: bool = False,
metadata_uri: str = None
) -> None
(function) async def await_tx_confirmation(
client: AsyncClient,
tx_sig: str,
max_attempts: int = 15,
delay_sec: float = 2
) -> bool
(function) def build_create_metadata_v3_ix(
metadata_pda: Pubkey,
mint_pubkey: Pubkey,
mint_authority: Pubkey,
payer: Pubkey,
update_authority: Pubkey,
name: str,
symbol: str,
uri: str,
is_mutable: bool = False
) -> Instruction
(function) async def mint_to(
async_client: AsyncClient,
mint_pubkey: Pubkey,
user_pubkey: Pubkey,
signer: Keypair,
amount: int,
decimals: int
) -> bool
(function) async def remove_authority(
async_client: AsyncClient,
mint_pubkey: Pubkey,
user_pubkey: Pubkey,
signer: Keypair
) -> bool
Examples
import asyncio
from solders.pubkey import Pubkey # type: ignore
from solana.rpc.async_api import AsyncClient
from solders.keypair import Keypair # type: ignore
from PumpSwapAMM import PumpSwap, fetch_pool
from solana.rpc.commitment import Processed
PRIVATE_KEY = "YOUR_PRIVATE_KEY_HERE"
RPC_ENDPOINT = "ANY_RPC_ENDPOINT" # e.g. "https://mainnet.helius-rpc.com/?api-key=YOUR_API_KEY_HERE"
async_client = AsyncClient(RPC_ENDPOINT)
async_payer_keypair = Keypair.from_base58_string(PRIVATE_KEY)
async def main():
# 1) Initialize PumpSwap client
client = PumpSwap(async_client, signer=async_payer_keypair)
# Example pool: https://solscan.io/account/8HmuBwTTYiLZcxUpUBwx4axwyogiaTwmhxyvE5qjc4ku
pool = "8HmuBwTTYiLZcxUpUBwx4axwyogiaTwmhxyvE5qjc4ku"
mint = "8oubm4nEgTFFa6SQWUoav9hpGt6MCrWQt5yXUBWEpump"
# 2) Fetch pool data
pool_keys = await fetch_pool(pool, async_client)
base_price, base_balance_tokens, quote_balance_sol = await client.fetch_pool_base_price(pool_keys)
# fetch decimals of the token
mint_info = await async_client.get_account_info_json_parsed(
Pubkey.from_string(mint),
commitment=Processed
)
if not mint_info:
print("Error: Failed to fetch mint info (tried to fetch token decimals).")
return
dec_base = mint_info.value.data.parsed['info']['decimals']
# 3) Prepare pool data
pool_data = {
"pool_pubkey": Pubkey.from_string(pool),
"token_base": Pubkey.from_string(pool_keys["base_mint"]),
"token_quote": Pubkey.from_string(pool_keys["quote_mint"]),
"pool_base_token_account": pool_keys["pool_base_token_account"],
"pool_quote_token_account": pool_keys["pool_quote_token_account"],
"base_balance_tokens": base_balance_tokens,
"quote_balance_sol": quote_balance_sol,
"decimals_base": dec_base
}
# 4) Buy
await client.buy(
pool_data,
sol_amount=0.002,
slippage_pct=10,
fee_sol=0.0005,
)
print("Waiting 10 seconds...")
await asyncio.sleep(10)
# 5) Sell
await client.sell(
pool_data,
sell_pct=100,
slippage_pct=10,
fee_sol=0.0005,
)
await client.close()
if __name__ == "__main__":
asyncio.run(main())
import asyncio
from solders.pubkey import Pubkey # type: ignore
from solana.rpc.async_api import AsyncClient
from solders.keypair import Keypair # type: ignore
from solana.rpc.commitment import Processed
from PumpSwapAMM import PumpSwap, fetch_pool, WSOL_MINT
from PumpSwapAMM.fetch_reserves import fetch_pool_base_price
PRIVATE_KEY = "YOUR_PRIVATE_KEY_HERE"
RPC_ENDPOINT = "ANY_RPC_ENDPOINT" # e.g. "https://mainnet.helius-rpc.com/?api-key=YOUR_API_KEY_HERE"
async_client = AsyncClient(RPC_ENDPOINT)
async_payer_keypair = Keypair.from_base58_string(PRIVATE_KEY)
async def main():
"""
Every PumpSwapAMM function takes in 'mute' argument,
which is set to False by default.
If set to True, it will not print any logs.
"""
client = PumpSwap(async_client, signer=async_payer_keypair)
pool_addr = None
mint_id = "8oubm4nEgTFFa6SQWUoav9hpGt6MCrWQt5yXUBWEpump"
# 1. create a brand-new pool
# Comment it out when pool is already created and you just want to withdraw/ deposit (like with the one above)
pool_addr = await client.create_pool(
base_mint = Pubkey.from_string(mint_id),
base_amount_tokens = 990_000_000, # How many tokens to deposit, in this case 990_000_000 equals to 990M tokens
quote_amount_sol = 0.01, # How much SOL to deposit
decimals_base = 6,
index = 0,
fee_sol = 0.001,
)
if not pool_addr:
return
print("Pool PDA:", pool_addr)
# Here stop the comment if so
if not pool_addr:
# If we didnt create the pool in this session we can still derive the pool address
pool_addr = client.derive_pool_address(
creator=async_payer_keypair.pubkey(),
base_mint=Pubkey.from_string(mint_id),
quote_mint=WSOL_MINT
)
pool_addr = str(pool_addr)
print("Pool PDA:", pool_addr)
pool_keys = await fetch_pool(pool_addr, async_client)
_, base_bal, quote_bal = await fetch_pool_base_price(pool_keys, async_client)
# Compose pool data
pool_data = {
"pool_pubkey": Pubkey.from_string(pool_addr),
"token_base": Pubkey.from_string(pool_keys["base_mint"]),
"token_quote": Pubkey.from_string(pool_keys["quote_mint"]),
"lp_mint": pool_keys["lp_mint"],
"pool_base_token_account": pool_keys["pool_base_token_account"],
"pool_quote_token_account": pool_keys["pool_quote_token_account"],
"base_balance_tokens": base_bal,
"quote_balance_sol": quote_bal,
"decimals_base": dec_base,
}
# fetch decimals of the token
mint_info = await async_client.get_account_info_json_parsed(
Pubkey.from_string(mint_id),
commitment=Processed
)
if not mint_info:
print("Error: Failed to fetch mint info (tried to fetch token decimals).")
return
dec_base = mint_info.value.data.parsed['info']['decimals']
# 2. Deposit tokens into the pool if the pool is already created
# await client.deposit(
# pool_data = pool_data,
# base_amount_tokens = 2_000_000, # <- NOT SOL any more
# slippage_pct = 1.0,
# fee_sol = 0.0002,
# sol_cap = 0.1
# )
print("Waiting for 15 seconds to withdraw...")
await asyncio.sleep(15)
# 3. Withdraw reserves from the pool
await client.withdraw(
pool_data = pool_data,
withdraw_pct = 100,
fee_sol = 0.0002,
)
await client.close()
if __name__ == "__main__":
asyncio.run(main())
Issues
- "get_account_info_json_parsed" may throw a 401 or 403 if you're using helius/ (any other triton) dedicated node or staked APIs
LICENSE
Standard MIT License
THE 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pumpswapamm-2.0.8.tar.gz.
File metadata
- Download URL: pumpswapamm-2.0.8.tar.gz
- Upload date:
- Size: 33.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
42f0a10b3afa9110998947bd5cc90202b8b1194515b5aacbd60e8a6fb2407499
|
|
| MD5 |
acc6383f4da042181d196b67ffcdd348
|
|
| BLAKE2b-256 |
5b495f325cebff05a9c79edabadb7274d5522856e257b5f6590242b8c5e19cd6
|
File details
Details for the file PumpSwapAMM-2.0.8-py3-none-any.whl.
File metadata
- Download URL: PumpSwapAMM-2.0.8-py3-none-any.whl
- Upload date:
- Size: 36.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ece5a37dbaa17da868df2cad1239e46f47257bdcee815a14964d788b5bb46d2b
|
|
| MD5 |
c8eb3f8d5b3984a5e571c1d34fedf552
|
|
| BLAKE2b-256 |
ca70f18d1194bfd2fc4a5baa2d6bbd540900f5e163e1b021710e9b676860cb4e
|