Reading Bond Details

Bonding Details

Returns the complete current state of a token and its bonding curve.

/**
 * @dev Retrieves the details of a bond token.
 * @param token The address of the bond token.
 * @return detail The BondDetail struct containing the royalty, bond info, and steps of the bond token.
*/
function getDetail( 
    address token 
) external view returns (BondDetail memory detail);

Bond Status

/**
 * @notice Current lifecycle status of a bond.
 */
enum BondStatus {
    Active,
    Finalized,
    Migrated
}

Value	Status	Description
0	Active	Bonding curve trading is available
1	Finalized	Sale supply has been reached and trading has stopped
2	Migrated	Liquidity has been migrated to the DEX

Bond Information

The nested BondInfo structure contains the main token and bond state.

struct BondInfo { 
    BondStatus status; 
    address creator; 
    address token; 
    address pair; 
    uint8 decimals; 
    string symbol; 
    string name; 
    string metadataUrl; 
    uint40 createdAt; 
    uint256 currentSupply; 
    uint256 saleSupply; 
    uint256 liquiditySupply; 
    uint128 priceForNextMint; 
    address reserveToken; 
    uint8 reserveDecimals; 
    string reserveSymbol; 
    string reserveName; 
    uint256 reserveBalance; 
}

Integration Notes

All token and reserve amounts are returned in their smallest onchain units. Use decimals and reserveDecimals from getDetail when formatting values for users.