Getting Started

The official TypeScript SDK for the ATFi Protocol.

Installation

npm install atfi viem wagmi
# or
pnpm add atfi viem wagmi

Setup

Initialize the SDK with a PublicClient (for reading data) and WalletClient (for transactions). We recommend using wagmi hooks in React.

import { ATFiSDK } from 'atfi';
import { usePublicClient, useWalletClient } from 'wagmi';

function useATFi() {
  const publicClient = usePublicClient();
  const { data: walletClient } = useWalletClient();

  if (!publicClient) return null;

  return new ATFiSDK(publicClient, walletClient);
}

Configuration

The SDK automatically detects the chain ID and uses the correct contract addresses for Base Mainnet (8453) or Base Sepolia (84532). You generally do not need to provide addresses manually.