🧠Core Concepts

Token Registry Workflow

The token registration process follows a specific workflow:

1. Submission: Users submit tokens with required metadata

2. Review: Governance reviews token submissions

3. Approval/Rejection: Tokens are either approved or rejected by authorized addresses

4. Updates: Approved tokens can receive metadata updates through proposals

Token Statuses

Tokens in the registry can have one of the following statuses:

• PENDING: Newly submitted tokens awaiting review

• APPROVED: Verified tokens that have passed governance review

• REJECTED: Tokens that failed verification or were removed

• NONE: Default status for unregistered tokens

Metadata Management

The metadata system is designed to be flexible and extensible:

• Required Fields: Basic token information (name, symbol, decimals)

• Standard Metadata: Common fields like logoURI, description, and social links

• Custom Fields: Governance can add new metadata fields as needed

• Field Properties: Fields can be marked as required or optional

Governance with TokentrollerV1

TokentrollerV1 provides governance and access control through:

• Owner: System administrator with highest privileges

• Trusted Helpers: Additional addresses authorized for administrative operations

• Permission System: Granular control over token operations

• Upgradeable Design: Ability to update governance implementation

Key governance functions include:

• Token approval/rejection

• Metadata field management

• Edit proposal review

• Helper contract authorization

Metadata Fields

Standard metadata fields include:

• logoURI: IPFS hash for the token logo

• description: Token description with character limit

• isERC4626: Boolean flag for vault tokens

• isPool: Indicates if token represents a liquidity pool

• websiteURI: Official token website

• socialLinks: Discord, GitHub, Twitter, Telegram

• Custom Properties: Additional fields as defined by governance

Batch Operations

The Helper contract provides efficient batch operations for:

• Adding multiple tokens

• Approving multiple tokens

• Processing multiple edit proposals

• Updating metadata in bulk

These operations help reduce transaction costs and improve administrative efficiency.