Pump API
Constructor
Allows the SDK to be initiated with custom data.
How to use:
Arguments
fullNodeUrl {string} - Url to initiate the Sui Client RPC
network {Enum} - Enum denoting if its mainnet or testnet
packages {Object} - Record of the deployed Memezfun packages on mainnet and testnet
sharedObjects {object} - Record of the shared object ids on mainnet and testnet
newPumpPool
Creates a pool using the Pump invariant.
How to use:
Arguments
tx {object} - Sui client Transaction class to chain move calls.
creationSuiFee {object} - The Sui fee to create a MemezPool.
memeCoinTreasuryCap {string} - The meme coin treasury cap.
totalSupply {string | number | bigint} - The total supply of the meme coin.
useTokenStandard {boolean} - Whether to use the token standard for the MemezPool.
devPurchaseData {object} - An object containing the quote Coin to to perform the first buy tx and the address of the person who can claim the coins.
metadata {object} - A record of the social metadata of the meme coin.
configurationKey {string} - The configuration key to use for the MemezPool.
migrationWitness {string} - The migration witness to use for the MemezPool.
stakeholders {string[]} - The addresses of the stakeholders. It can be empty or undefined.
quoteCoinType {string} - The quote coin type to use for the MemezPool.
Return
tx {object} - Sui client Transaction class to chain move calls.
metadataCap {object} - The metadata object.
pump
Swaps quote coin for a meme coin in a pool.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
quoteCoin {object} - The quote coin to sell for the meme coin.
minAmountOut {string | number | bigint} - The minimum amount of meme coin expected to be received.
Return
tx {object} - Sui client Transaction class to chain move calls.
memeCoin {object} - The meme coin bought.
dump
Swaps meme coin for quote coin in a pool.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
memeCoin {object} - The meme coin to sell for Sui coin.
minAmountOut {string | number | bigint} - The minimum amount of sui coin expected to be received.
Return
tx {object} - Sui client Transaction class to chain move calls.
quoteCoin {object} - The Quote coin bought.
pumpToken
Swaps quote coin for the meme token using the Token Standard.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
quoteCoin {object} - The Sui coin to sell for the meme coin.
minAmountOut {string | number | bigint} - The minimum amount meme coin expected to be received.
Return
tx {object} - Sui client Transaction class to chain move calls.
memeToken {object} - The meme token bought.
memeCoinType {string} - The type of the meme coin.
dumpToken
Swaps the meme token for quote coin.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
memeToken {object} - The meme token to sell for Sui coin.
minAmountOut {string | number | bigint} - The minimum amount sui coin expected to be received.
Return
tx {object} - Sui client Transaction class to chain move calls.
quoteCoin {object} - The quote coin bought.
devClaim
Allows the developer to claim the first purchased coins. It can only be done after the pool migrates.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
Return
tx {object} - Sui client Transaction class to chain move calls.
memeCoin {object} - The meme coin bought by the developer during deployment.
keepToken
Utility function to return the Token to the sender.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
token {string | object} - The objectId of the meme token to keep.
Return
tx {object} - Sui client Transaction class to chain move calls.
memeCoin {object} - The meme coin bought by the developer during deployment.
toCoin
Converts a meme token to a meme coin. This is for pools that use the Token Standard. It can only be done after the pool migrates.
Implementation
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
memeToken {object} - The meme token to convert to a meme coin.
Return
tx {object} - Sui client Transaction class to chain move calls.
memeCoin {object} - The meme coin converted from token.
migrate
Migrates the pool to DEX based on the MigrationWitness.
The migrator is a hot potato that needs to be consumed. Please use the Migrator SDK to consume and migrate to a DEX. At the moment, we only have a test migrator as Memez is deployed on testnet.
How to use
Arguments
tx {object} - Sui client Transaction class to chain move calls.
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
Return
tx {object} - Sui client Transaction class to chain move calls.
migrator {object} - The hot potato migrator containing the balances.
quotePump
Quotes the amount of meme coin received after selling the quote coin.
How to use
Arguments
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
amount {string | number | bigint} - The amount of Sui being sold.
Return
memeAmountOut {bigint} - The amount of meme coin that will be received.
swapFeeIn {bigint} - The swap fee paid in Sui.
quoteDump
Quotes the amount of quote coin received after selling the meme coin.
How to use
Arguments
pool {string | object} - The objectId of the MemezPool or the full parsed pool.
amount {string | number | bigint} - The amount of Mem coin being sold.
Return
quoteAmountOut {bigint} - The amount of quote coin that will be received.
swapFeeIn {bigint} - The swap fee paid in Meme coin.
burnFee {bigint} - Burn fee in meme coin.
getPumpData
Returns the Pump configuration for a specific integrator using a configuration key.
How to use
Arguments
configurationKey {string} - The struct tag of a configuration key. E.g. package::module::Key
totalSupply {string | bigint | number} - The total supply of the meme coin. E.g. 1 Sui would be 1e9.
Return
burnTax - The tax value of the burner in bps.
virtualLiquidity - The starting virtual liquidity in the pool in Sui.
targetQuoteLiquidity - The amount of quote required for the pool to migrate.
liquidityProvision - The amount of Meme coin that will be supplied to a DEX after migration.
Last updated
Was this helpful?