Getting Started

This guide will help you start using FEY Protocol, whether you want to stake $FEY, deploy a token, or integrate with the protocol.

Quick Overview

FEY Protocol is live on Base Mainnet with these core contracts:

Factory: 0x8EEF0dC80ADf57908bB1be0236c2a72a7e379C2d
FEY Token: 0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D
xFeyVault (Staking): 0x72f5565Ab147105614ca4Eb83ecF15f751Fd8C50
Main Pool: FEY/WETH on Uniswap V4

For Token Stakers

1. Get $FEY Tokens

$FEY tokens are available on Uniswap V4 (FEY/WETH pool):

Pool ID: 0xe155c517c53f078f4b443c99436e42c1b80fd2fb1b3508f431c46b8365e4f3f0
Token Contract: 0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D

2. Stake Your $FEY

The xFeyVault staking contract is live on Base Mainnet! Stake your $FEY tokens to earn rewards from protocol activity.

Contract Address: 0x72f5565Ab147105614ca4Eb83ecF15f751Fd8C50

Staking provides:

Protocol fees from all network activity
LP rewards from managed positions
Buyback distributions from WETH conversions

The vault uses the ERC4626 standard, so you'll receive xFEY shares when you deposit $FEY tokens. Your share of the vault increases as fees accumulate and buybacks are executed.

3. Monitor Your Rewards

You can monitor your staking rewards by:

Checking your xFEY balance (shares increase in value as rewards accumulate)
Viewing the vault's total assets and your share percentage
Tracking buyback executions and fee claims through on-chain events

For Token Creators

1. Prepare Your Token Metadata

Before deploying, prepare:

Name: Your token name
Symbol: Token symbol (keep it short)
Image: Token logo/image URL
Metadata: JSON metadata URL
Context: Additional context string

2. Configure Your Deployment

Token deployments require several configuration parameters:

interface DeploymentConfig {
  tokenConfig: {
    name: string;
    symbol: string;
    image: string;
    metadata: string;
    context: string;
    tokenAdmin: address;
    salt: uint256;
    originatingChainId: uint256;
  };
  poolConfig: {
    hook: address; // Use FEY Hook
    pairedToken: address; // Will be overridden to FEY
    tickIfToken0IsFey: int24;
    tickSpacing: int24;
    poolData: bytes;
  };
  lockerConfig: {
    locker: address;
    tickLower: int24[];
    tickUpper: int24[];
    positionBps: uint16[];
    rewardBps: uint16[];
    rewardAdmins: address[];
    rewardRecipients: address[];
  };
  // ... additional configs
}

3. Deploy Your Token

Call the Factory contract:

function deployToken(DeploymentConfig memory config)
  external payable returns (address tokenAddress);

4. Earn Creator Rewards

After deployment:

Earn 1% of trading volume in $FEY
Receive LP rewards from protocol positions
Stake earned $FEY to compound returns

For Developers

1. Contract Integration

Key contracts for integration:

const contracts = {
  factory: "0x8EEF0dC80ADf57908bB1be0236c2a72a7e379C2d",
  feyToken: "0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D",
  xFeyVault: "0x72f5565Ab147105614ca4Eb83ecF15f751Fd8C50",
  hook: "0x5B409184204b86f708d3aeBb3cad3F02835f68cC",
  feeLocker: "0xf739FC4094F3Df0a1Be08E2925b609F3C3Aa13c6",
  lpLocker: "0x975aF6a738f502935AFE64633Ad3EA2A3eb3e7Fa",
};

2. Query Protocol State

Use cast or web3 libraries to query state:

# Check FEY total supply
cast call 0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D \
  "totalSupply()(uint256)" --rpc-url https://mainnet.base.org
 
# Get token deployment info
cast call 0x8EEF0dC80ADf57908bB1be0236c2a72a7e379C2d \
  "tokenDeploymentInfo(address)" [TOKEN_ADDRESS] \
  --rpc-url https://mainnet.base.org

3. Build Extensions

To build protocol extensions:

Implement IFeyExtension interface
Get extension approved in the allowlist contract
Test integration with deployment flow

See Building Extensions → for detailed instructions.

4. Monitor Protocol Activity

Track protocol events:

TokenCreated: New token deployments
ClaimFees: Fee distributions
ExtensionTriggered: Extension usage

Network Information

Base Mainnet Details

Chain ID: 8453
RPC: https://mainnet.base.org
Explorer: BaseScan

Key Addresses

Contract	Address
Factory	`0x8EEF0dC80ADf57908bB1be0236c2a72a7e379C2d`
FEY Token	`0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D`
xFeyVault (Staking)	`0x72f5565Ab147105614ca4Eb83ecF15f751Fd8C50`
Hook	`0x5B409184204b86f708d3aeBb3cad3F02835f68cC`
Fee Locker	`0xf739FC4094F3Df0a1Be08E2925b609F3C3Aa13c6`
LP Locker	`0x975aF6a738f502935AFE64633Ad3EA2A3eb3e7Fa`

View complete address list →

Support & Resources

Ready to dive deeper? Explore the Protocol Architecture → or check out specific Contract Documentation →.