Contract Interaction ( Testnet)

This document will help you to build on chain applications using buy & sell methods on the tokens created on pump.flow.

Documentation for Fundamental Functions in PumpFlowTokenFactory (Testnet)

buyTokens

Code Block:

function buyTokens(address memeTokenAddress, uint256 totalCost) public payable nonReentrant

Description:

This function allows users to purchase tokens of a specific meme token using the bonding curve pricing model. The cost is deducted from the user's msg.value.

Parameters:

  • memeTokenAddress: The address of the meme token to be purchased.

  • totalCost: The total amount (in native currency) the user is willing to spend.

Requirements:

  • The user must send msg.value equal to or greater than totalCost.

  • The token must not be blocked or have reached its bonding curve limit.

  • The available token supply must not exceed the predefined maximum before DEX integration (Maximum 805 million tokens can be sold on curve).

Process:

  1. Verify that the msg.value is sufficient.

  2. Ensure the token is not blocked and has not exceeded bonding curve thresholds.

  3. Deduct the trading fee from the total cost.

  4. Calculate the number of tokens the user can purchase using the bonding curve formula.

  5. Transfer tokens to the user and update bonding curve metrics (e.g., currentSupply, fundingRaised).

  6. Emit the TokensPurchased event.

Events Emitted:

  • TokensPurchased: Contains details of the purchase, including the buyer, token address, total cost, number of tokens, and updated bonding curve progress.

  • BondingCurveReached: Emitted if the purchase causes the token to reach the bonding curve limit.

sellTokens

Code Block:

function sellTokens(address memeTokenAddress, uint256 numTokens) public payable nonReentrant

Description:

This function allows users to sell their meme tokens back to the platform, receiving native blockchain currency in return, as determined by the bonding curve.

Parameters:

  • memeTokenAddress: The address of the meme token being sold.

  • numTokens: The number of tokens the user wants to sell.

Requirements:

  • The caller must hold at least numTokens of the specified meme token.

  • The bonding curve must not have been reached.

  • The platform contract must have sufficient funds to cover the refund.

  • The caller must first approve the contract to transfer the specified number of tokens on their behalf using the approve function of the token contract.

Process:

  1. Verify that the token is not blocked and has not reached the bonding curve.

  2. Check that the caller holds enough tokens and that the contract has sufficient funds to refund.

  3. Calculate the refund amount using the bonding curve formula.

  4. Deduct the trading fee from the refund amount.

  5. Transfer the tokens from the user to the contract.

  6. Send the refund (minus fees) to the user.

  7. Update bonding curve metrics (e.g., currentSupply, fundingRaised).

  8. Emit the TokensSold event.

Events Emitted:

  • TokensSold: Contains details of the sale, including the seller, token address, number of tokens, refund amount, and updated bonding curve progress.

getBoundingCurvePercentage

Code Block:

function getBoundingCurvePercentage(address memeTokenAddress) public view returns (uint256)

Description:

Retrieves the percentage progress of a meme token’s current supply relative to its bonding curve threshold.

Parameters:

  • memeTokenAddress: The address of the meme token.

Returns:

  • A percentage value (scaled by 100) indicating the progress towards the bonding curve.

getRemainingTokensInLaunchpad

Code Block:

function getRemainingTokensInLaunchpad(address memeTokenAddress) public view returns (uint256)

Description:

Fetches the remaining token balance in the launchpad for a specific meme token.

Parameters:

  • memeTokenAddress: The address of the meme token.

Returns:

  • The number of tokens remaining in the launchpad.

getAllMemeTokens

Code Block:

function getAllMemeTokens() public view returns (MemeToken[] memory)

Description:

Returns a list of all meme tokens created through the platform, excluding blocked tokens.

Returns:

  • An array of MemeToken structs containing details of each token.

Notes:

Use this function to retrieve comprehensive information about all active tokens on the platform.

Important Notes for Developers:

  1. Token Approval: Before calling sellTokens, ensure you call the approve function of the respective meme token contract to allow the factory to handle the tokens on your behalf.

Contract Addresses (Testnet):

  • PumpFlowTokenFactory: 0xBBfA869CF253aB76742AB9bc7902f783546BC830

PumpFlowTokenFactory Contract ABI:

[
  {
    "inputs": [
      { "internalType": "address", "name": "memeTokenAddress", "type": "address" },
      { "internalType": "uint256", "name": "totalCost", "type": "uint256" }
    ],
    "name": "buyTokens",
    "outputs": [],
    "stateMutability": "payable",
    "type": "function"
  },
  {
    "inputs": [
      { "internalType": "address", "name": "memeTokenAddress", "type": "address" },
      { "internalType": "uint256", "name": "numTokens", "type": "uint256" }
    ],
    "name": "sellTokens",
    "outputs": [],
    "stateMutability": "payable",
    "type": "function"
  },
  {
    "inputs": [
      { "internalType": "address", "name": "memeTokenAddress", "type": "address" }
    ],
    "name": "getBoundingCurvePercentage",
    "outputs": [
      { "internalType": "uint256", "name": "", "type": "uint256" }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [
      { "internalType": "address", "name": "memeTokenAddress", "type": "address" }
    ],
    "name": "getRemainingTokensInLaunchpad",
    "outputs": [
      { "internalType": "uint256", "name": "", "type": "uint256" }
    ],
    "stateMutability": "view",
    "type": "function"
  },
  {
    "inputs": [],
    "name": "getAllMemeTokens",
    "outputs": [
      {
        "internalType": "struct PumpFlowTokenFactory.MemeToken[]",
        "name": "",
        "type": "tuple[]"
      }
    ],
    "stateMutability": "view",
    "type": "function"
  }
]

Meme Token Contract ABI:

[
  {
    "inputs": [
      { "internalType": "address", "name": "spender", "type": "address" },
      { "internalType": "uint256", "name": "value", "type": "uint256" }
    ],
    "name": "approve",
    "outputs": [],
    "stateMutability": "nonpayable",
    "type": "function"
  }
]
PreviousHow to Create a TokenNextFAQ

Last updated