@dutchiono/fey-sdk

Complete TypeScript SDK for interacting with the FEY Protocol on Base (Ethereum L2).

Made by: @ionoi (Farcaster) • @dutchiono (X/Twitter)

What is this?

This is a complete npm package providing TypeScript/JavaScript SDK for interacting with the FEY Protocol smart contracts on Base. It includes:

• All Contract ABIs: Factory, Token, Hook, Fee Locker, LP Locker, and Pool Extension Allowlist
• Query Functions: Easy-to-use functions for reading contract state
• Transaction Builders: Build deployment and admin transactions
• Event Parsers: Parse blockchain events with full type safety
• TypeScript Types: Complete type definitions for all data structures

Installation

Install the package from npm:

npm install @dutchiono/fey-sdk

Or with yarn:

yarn add @dutchiono/fey-sdk

Or with pnpm:

pnpm add @dutchiono/fey-sdk

Using as an npm Package

Once installed, import and use the SDK in your project:

import { ethers } from 'ethers';
import {
  getTokenDeploymentInfo,
  getTokenData,
  getPoolInfo,
  parseTokenCreatedEvent,
  FEY_FACTORY_ADDRESS,
} from '@dutchiono/fey-sdk';

The package is published to npm and can be used in any Node.js or browser project that supports ES modules.

Quick Start

import { ethers } from 'ethers';
import {
  getTokenDeploymentInfo,
  getTokenData,
  getPoolInfo,
  getAvailableFees,
  FEY_FACTORY_ADDRESS,
  FEY_HOOK_ADDRESS,
} from '@dutchiono/fey-sdk';

const provider = new ethers.JsonRpcProvider('https://mainnet.base.org');

// Get token deployment info
const deploymentInfo = await getTokenDeploymentInfo(
  provider,
  '0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D' // FEY token
);

// Get complete token data
const tokenData = await getTokenData(provider, deploymentInfo.token);

// Get pool information
const poolInfo = await getPoolInfo(provider, poolId);

// Check available fees
const fees = await getAvailableFees(
  provider,
  feeOwner,
  tokenAddress
);

Features

• Factory Contract: Deploy tokens, query deployment info, admin functions
• Token Contract: ERC20 + metadata + governance functions
• Hook Contract: Pool queries, fee management, MEV protection
• Fee Locker: Fee queries and claims
• LP Locker: Reward queries and collection
• Pool Extension Allowlist: Extension enablement checks

Documentation

Full documentation available at: https://feydocs.lat/guides/sdk

Contract Addresses

• Factory: 0x8eef0dc80adf57908bb1be0236c2a72a7e379c2d
• Hook: 0x5B409184204b86f708d3aeBb3cad3F02835f68cC
• Fee Locker: 0xf739FC4094F3Df0a1Be08E2925b609F3C3Aa13c6
• LP Locker: 0x975aF6a738f502935AFE64633Ad3EA2A3eb3e7Fa
• FEY Token: 0xD09cf0982A32DD6856e12d6BF2F08A822eA5D91D

Contributing

Contributions welcome! This SDK is maintained as part of the FEY Protocol ecosystem.

Links

• Documentation: https://feydocs.lat/guides/sdk
• GitHub Repository: https://github.com/dutchiono/fey_sdk
• NPM Package: https://www.npmjs.com/package/@dutchiono/fey-sdk
• FEY Protocol Docs: https://feydocs.lat

License

MIT