factory state

TOKEN_DECIMALS

Curve amounts are whole tokens. Keeping decimals at zero makes the GRC20 display unit match every supply, quote, sell-limit, and UI amount used by the protocol (MAX\_SUPPLY is 300 million tokens, not 300 display tokens).

FEE_BPS

// 1% protocol fee (bonding curve + AMM)

LP_FEE_BPS

LP\_FEE\_BPS is an additional 1% charged ONLY on graduated-token AMM swaps that is retained in the pool (grows k), so external liquidity providers earn yield. Total AMM swap fee is therefore FEE\_BPS + LP\_FEE\_BPS = 2%.

CREATE_FEE

// 1 GNOT

MIN_SYMBOL_LEN

MAX_SYMBOL_LEN

MAX_NAME_LEN

SAFE_SUPPLY_LIMIT

// 300M - overflow-safe limit for integral()

MAX_SUPPLY

// 300M (was 1e9; unreachable above the safe limit)

MAX_BUY_UGNOT

// 100 GNOT

MAX_SELL_TOKENS

// 10 Million

GRADUATION_THRESHOLD

Graduation Threshold (10,000 GNOT)

MAX_DESCRIPTION_LEN

MAX_IMAGE_URL_LEN

MAX_SOCIAL_URL_LEN

SLOPE_A

Pricing: Price(S) = S/A + B

BASE_B

protocolFeeAccumulator

admin

pendingAdmin

pausedTokensCount

factoryBanker

realmAddr

globalPaused

// Emergency global pause - blocks all trading

nextTokenID

Current GRC20 identity includes a realm-local sequence ID. All three token creation paths must share one counter so emitted token IDs remain unique.

authorizedPools

GnoSwap integration: authorized pool addresses per token symbol -> pool address that can call TransferForDEX

protocolTokenFees

Protocol token fees accumulated from DEX trades (in tokens, per symbol) These can be withdrawn by admin and sold

tokenEntry

GRC20 token storage

tokenRegistry

TokenMeta

init.30

sqrt

safeMul

safeMul multiplies two non-negative int64 values and panics on overflow, turning a silent int64 wrap (which the AMM pricing/liquidity math is otherwise exposed to for large pools) into a graceful revert. AMM-OVERFLOW-1.

integral

spotPrice

splitTradeFee

assertDirectPayer

assertDirectPayer guards every entry point that reads its ugnot payment from unsafe.OriginSend(). OriginSend() reports the coins attached to the \*origin transaction\*, NOT the coins actually received by this realm. If an intermediary sits between the user and this call (a wrapper realm called with --send, or a \`gnokey maketx run\` ephemeral realm), it can keep the coins while OriginSend() still reports the full amount, letting it credit reserves / mint tokens / receive refunds against funds the realm never received and drain the shared realm account. Requiring the immediate caller to be a pure EOA (IsUserCall, i.e. cur.Previous().PkgPath()=="") guarantees the --send coins landed at realmAddr, so OriginSend() == receipt. See PAY-1 in docs/SECURITY\_AUDIT\_2026-06-13.md and gno docs/resources/effective-gno.md "Verifying inbound Coin payments".

errorf

FMT-1: delegate to ufmt instead of the previous naive strings.Replace formatters, which could not substitute untyped-int constants (no \`case int\`), mangled width verbs, and rendered \`%%\` literally. ufmt handles standard verbs for both int and int64 and collapses \`%%\` -> \`%\`.

sprintf

safeK

safeK computes the informational KLast = x\*y, saturating at MaxInt64 instead of wrapping to a misleading negative value on overflow (KLAST-OVERFLOW-1). KLast is read only by off-chain UI and feeds no on-chain pricing/fee logic, so saturating here keeps swaps/liquidity ops from ever reverting on this purely cosmetic computation.

formatBps

formatBps renders a basis-point value (0-500) as a percentage with two fractional digits, e.g. 500 -> "5.00%", 25 -> "0.25%". ufmt does not apply a width to %d, so the zero-padding of the fractional part is done explicitly.

validateSymbol

validateName

validateDescription

validateImageURL

validateSocialURL

getTokenEntry

LaunchToken

LaunchTemplate

LaunchTemplate creates a token with a royalty rate, intended to be forked royaltyRateBps: 0-500 (0%-5%) of trade fees paid to creator on forks

ForkToken

ForkToken creates a new token that pays royalties to the parent's creator

QuoteBuy

QuoteSell

Buy

Sell

Transfer

Transfer moves tokens from caller to recipient

Approve

Approve sets allowance for spender to spend caller's tokens

TransferFrom

TransferFrom moves tokens using allowance mechanism

Allowance

Allowance returns the remaining allowance

checkGraduation

checkGraduation marks token as graduated when threshold reached Trading continues until admin initiates migration

StartMigration

StartMigration temporarily locks trading while DEX pool is created This matches pump.fun's model - short pause during liquidity migration

CompleteMigration

CompleteMigration unlocks trading after DEX pool is live Trading resumes on both GnoPump and GnoSwap (like pump.fun + Raydium)

AbortMigration

AbortMigration clears a started-but-unfinished migration so bonding-curve trading resumes. MIGRATE-FREEZE-1: StartMigration sets IsMigrating, which panics Buy/Sell; without an abort path a stalled migration freezes the token's market indefinitely with no recourse. Only valid before any internal AMM pool is initialized (after that, finish via CompleteMigration instead).

GetMigrationStatus

GetMigrationStatus returns current migration state for a token

RegisterDEXPool

RegisterDEXPool authorizes a GnoSwap pool address to transfer tokens This is called after pool creation on GnoSwap side

TransferForDEX

TransferForDEX allows authorized GnoSwap pools to transfer tokens during swaps GnoSwap calls this instead of requiring user approvals Fee Structure (taken from transfer amount, in tokens): - Protocol Fee: 1% (100 bps) → accumulated for protocol - Royalty Fee: 0-5% → paid to parent creator (if forked token) - Net Amount: remainder → sent to recipient

WithdrawReservesToPool

WithdrawReservesToPool sends GNOT reserves to GnoSwap pool for liquidity Called during migration process to seed the AMM pool

GetAuthorizedPool

GetDEXInfo

GetDEXInfo returns all info GnoSwap needs to work with a token

GetProtocolTokenFees

GetProtocolTokenFees returns accumulated token fees from DEX trades

WithdrawProtocolTokenFees

WithdrawProtocolTokenFees lets admin withdraw accumulated token fees Tokens are transferred to specified address (admin can sell them)

AMMPool

Pool state for graduated tokens

lpBalances

// symbol -> address -> LP amount

ammPools

// symbol -> pool

InitializeAMMPool

InitializeAMMPool creates the AMM pool during migration Called by admin after graduation to seed liquidity

SwapGNOTForToken

SwapGNOTForToken buys tokens from the AMM pool Constant product: (x + dx)(y - dy) = k dy = y \* dx / (x + dx)

SwapTokenForGNOT

SwapTokenForGNOT sells tokens to the AMM pool for GNOT

QuoteAMMBuy

QuoteAMMBuy returns expected tokens out for GNOT in fee is the TOTAL swap fee (protocol 1% + LP 1% = 2%), matching SwapGNOTForToken.

QuoteAMMSell

QuoteAMMSell returns expected GNOT out for tokens in. fee is the TOTAL swap fee (protocol 1% + LP 1% = 2%), matching SwapTokenForGNOT.

GetAMMPoolInfo

GetAMMPoolInfo returns pool state for a graduated token

GetAMMPrice

GetAMMPrice returns current price from pool (GNOT per token, scaled by 1e6)

AddLiquidity

AddLiquidity lets users add liquidity to graduated token pools They send GNOT and equivalent tokens get pulled from their balance. minLpOut is the caller's slippage bound (0 = no bound): the call reverts if fewer LP tokens than minLpOut would be minted.

RemoveLiquidity

RemoveLiquidity lets LP holders withdraw their share

GetLPBalance

GetLPBalance returns user's LP token balance

GetTradeRoute

GetTradeRoute tells the UI which function to call for a given token Returns: "bonding" for Buy/Sell, "amm" for SwapGNOTForToken/SwapTokenForGNOT

QuoteTrade

QuoteTrade returns expected output regardless of which route will be used

gnoswapRouterAddr

// TODO: Set real address

SetGnoSwapRouter

SetGnoSwapRouter allows admin to configure the GnoSwap router address

GetGnoSwapRouter

GetGnoSwapPoolInfo

GetGnoSwapPoolInfo returns info about our pool for external DEX compatibility

WithdrawProtocolFees

AdminRemoveLiquidity

AdminRemoveLiquidity withdraws the protocol-owned LP position (the initial liquidity credited to realmAddr in InitializeAMMPool) to a treasury address. LOCKED-PROTOCOL-LP-1: without this, the protocol's seeded GNOT + tokens and its accrued LP-fee yield are permanently stranded, because RemoveLiquidity keys the burn on the immediate caller and realmAddr can never be the immediate caller of an exported function.

ProposeAdmin

ProposeAdmin / AcceptAdmin implement a two-step admin handover. ADMIN-ROTATE-1: the admin key was previously immutable and unrecoverable. This lets the current admin hand control to a new key (e.g. a multisig) which must confirm, preventing a handover to a wrong or uncontrolled address.

AcceptAdmin

GetAdmin

GetPendingAdmin

GlobalPause

GlobalPause halts all trading on the factory (emergency use only)

GlobalUnpause

GlobalUnpause resumes trading on the factory

IsGlobalPaused

IsGlobalPaused returns the global pause state

PauseToken

UnpauseToken

GetTokenInfo

BalanceOf

TotalSupply

GetName

GetSymbol

GetDecimals

GetProtocolFees

FactoryState

GetFactoryState

Render