Index Token Created Events

This page describes how to index newly launched tokens by consuming events emitted by the Portal contract.

Overview

For backward compatibility, a token launch can emit multiple events instead of a single one. Always index TokenCreated, then enrich the token record with any optional events that appear in the same transaction.

Events to index

Required

• TokenCreated: emitted for every token launch.

Optional (apply defaults if missing)

• TokenCurveSet: if missing, curve defaults to the first item in CurveType (legacy curve, curveParameter = 16 ether).
• TokenCurveSetV2: starting from v4.7.0, always emitted even for legacy curve.
• TokenDexSupplyThreshSet: if missing, defaults to the first item in DexThreshType (6.67e8 ether).
• TokenQuoteSet: if missing, defaults to native gas token (zero address).
• TokenMigratorSet: if missing, defaults to V3_MIGRATOR.
• TokenVersionSet: if missing, defaults to legacy token version (see Token version specification).
• FlapTokenTaxSet: if missing, tax is 0 (non-tax token).
• FlapTokenStaged: emitted when a token is staged but not yet created (two-step token launch).
• TokenExtensionEnabled: emitted when an extension is enabled for a token.
• TokenDexPreferenceSet: if missing, defaults to DEX0 with STANDARD fee profile.
• FlapTokenAsymmetricTaxSet: emitted alongside FlapTokenTaxSet for Tax Token V3 launches; carries separate buy and sell tax rates. If missing, treat buy and sell rates as equal to the value from FlapTokenTaxSet.

Event reference (arguments and meaning)

TokenCreated

Emitted for every token launch.

• ts: block timestamp when the token is created.
• creator: address that initiated the token creation.
• nonce: portal nonce for this creation (unique per Portal).
• token: deployed token address.
• name: token name.
• symbol: token symbol.
• meta: IPFS CID of the token metadata JSON.

FlapTokenStaged

Emitted when a token is staged (two-step launch) but not yet created.

• ts: block timestamp when staging happens.
• creator: address that staged the token.
• token: predetermined token address (not yet deployed).

TokenCurveSet

Emitted when the bonding curve configuration is set for legacy curve format.

• token: token address.
• curve: curve contract address.
• curveParameter: curve parameter for the legacy curve (defaults to 16 ether if missing).

TokenCurveSetV2

Emitted when the bonding curve parameters are set in the newer format.

• token: token address.
• r: virtual ETH reserve parameter.
• h: virtual token reserve parameter.
• k: square of virtual liquidity parameter.

TokenDexSupplyThreshSet

Emitted when the DEX listing supply threshold is set.

• token: token address.
• dexSupplyThresh: circulating supply threshold for DEX listing (defaults to the first DexThreshType if missing).

TokenQuoteSet

Emitted when the quote token is set.

• token: token address.
• quoteToken: quote token address (zero address means native gas token).

TokenMigratorSet

Emitted when the migrator type is set.

• token: token address.
• migratorType: migrator enum value.

enum MigratorType {
    V3_MIGRATOR,              // Migrate liquidity to a Uniswap V3-like pool
    V2_MIGRATOR,              // Migrate liquidity to a Uniswap V2-like pool
    V4_UNI_MIGRATOR,          // Migrate liquidity to a Uniswap V4 pool (Base, XLayer)
    PCS_INFINITY_CL_MIGRATOR  // Migrate liquidity to a PancakeSwap Infinity CL pool (BNB)
}

migratorType says which version/protocol shape the liquidity migrates into (V2-style, V3-style, or one of the two CL-style migrators). It does not by itself say which DEX — that's TokenDexPreferenceSet.dexId (below). The two together fully determine the destination.

TokenVersionSet

Emitted when the token implementation version is set.

• token: token address.
• version: token version enum value (see Token version specification).

FlapTokenTaxSet

Emitted when a tax is set for a token.

• token: token address.
• tax: tax rate in basis points (0 means non-tax token).

TokenExtensionEnabled

Emitted when an extension is enabled for a token.

• token: token address.
• extensionID: extension identifier (bytes32).
• extensionAddress: extension contract address.
• version: extension interface version.

TokenDexPreferenceSet

Emitted when DEX preference and fee profile are set.

• token: token address.
• dexId: preferred DEX ID (DEX0, DEX1, DEX2).
• lpFeeProfile: preferred V3 LP fee profile (STANDARD, LOW, HIGH).

dexId is chain-specific — the same enum value maps to a different DEX protocol depending on which chain the Portal is deployed on:

Resolving the destination: dexId + migratorType

dexId picks the DEX protocol (per the table above), and migratorType picks the pool version/shape on that protocol. Read both events from the same token-creation transaction to know exactly where a token will graduate to:

Example — Robinhood Chain, dexId = DEX1 (PancakeSwap) and migratorType = V3_MIGRATOR → the token graduates to PancakeSwap V3 on Robinhood Chain.

If TokenDexPreferenceSet is missing, apply the default noted above (DEX0 with STANDARD fee profile). If TokenMigratorSet is missing, it defaults to V3_MIGRATOR.

FlapTokenAsymmetricTaxSet

Emitted for Tax Token V3 (TOKEN_TAXED_V3) launches alongside FlapTokenTaxSet. Carries the full asymmetric buy and sell tax rates.

• token: token address.
• buyTax: buy tax rate in basis points.
• sellTax: sell tax rate in basis points.

Suggested indexing flow

1. Listen to TokenCreated events on Portal.
2. In the same transaction, collect optional events for the same token address.
3. Apply defaults for any missing optional events.
4. Persist the token record and metadata CID.