> ## Documentation Index
> Fetch the complete documentation index at: https://docs.b3.fun/llms.txt
> Use this file to discover all available pages before exploring further.

# BondKit Introduction

Product for launching ERC20 bond tokens on Base with a bonding phase and seamless Uniswap v4 migration.

## What is BondKit?

BondKit is a complete token launch platform for creating ERC20 "bond tokens" on Base mainnet. It provides an end‑to‑end solution that handles everything from initial token creation through bonding curve trading and finally migration to Uniswap v4 for full decentralized trading.

### Key Components

**Smart Contracts**

**Audited On-Chain Infrastructure**
    - Factory contract for deploying new tokens
    - ERC20 implementation with bonding curve logic
    - Automatic Uniswap v4 pool initialization
    - Gas-optimized minimal proxy pattern
  **TypeScript SDK**

**Developer-Friendly Tools**
    - Simple API for all contract interactions
    - Type-safe interfaces with full TypeScript support
    - Built-in transaction management
    - Event subscriptions and monitoring
  **Analytics Backend**

**Real-Time Data Services**
    - Transaction history tracking
    - OHLCV chart data generation
    - Token metadata storage
    - REST API for frontend integration

## How BondKit Works

```mermaid
graph LR
    A[Create Token] --> B[Bonding Phase]
    B --> C[Target Reached]
    C --> D[Migrate to DEX]
    D --> E[Uniswap v4 Trading]

    style A fill:#4CAF50,stroke:#2E7D32,stroke-width:2px,color:#fff
    style B fill:#FF9800,stroke:#F57C00,stroke-width:2px,color:#fff
    style C fill:#9C27B0,stroke:#6A1B9A,stroke-width:2px,color:#fff
    style D fill:#2196F3,stroke:#1565C0,stroke-width:2px,color:#fff
    style E fill:#00BCD4,stroke:#00838F,stroke-width:2px,color:#fff
```

### The Three-Phase Lifecycle

1. **Creation Phase**: Deploy your token with custom parameters
2. **Bonding Phase**: Automated market making via bonding curve
3. **DEX Phase**: Full decentralized trading on Uniswap v4

## Core Features

**🏭 Factory Pattern Deployment**

- **Gas-Efficient Clones**: Uses minimal proxy pattern to reduce deployment costs by ~90%
    - **Standardized Implementation**: All tokens share the same battle-tested logic
    - **One-Click Deployment**: Simple function call to create a new token

  **📈 Dynamic Bonding Curve**

- **Configurable Aggressiveness**: Factor from 0-100 controls price progression
    - **Automatic Price Discovery**: Market-driven pricing during bonding phase
    - **Buy & Sell Support**: Full two-way trading during bonding
    - **5% Trading Fee**: Applied to both buys and sells, distributed to fee recipient

  **🎯 Target-Based Migration**

- **Customizable Targets**: Set your funding goal in ETH or allowed ERC20
    - **Automatic Threshold Detection**: Contract tracks progress to target
    - **One-Click Migration**: Simple call to `migrateToDex()` when ready
    - **Price Calculation**: `sqrtPriceX96` computed on-chain for fair initial pricing

  **🔄 Uniswap v4 Integration**

- **Automatic Pool Creation**: Pool initialized with bonding curve exit price
    - **Liquidity Provision**: Accumulated funds become initial liquidity
    - **Ownership Renouncement**: Contract becomes fully decentralized post-migration
    - **Seamless Transition**: No manual intervention required

  **📊 Analytics & Monitoring**

- **Real-Time Indexing**: All transactions recorded and processed
    - **OHLCV Data**: Professional trading charts available via API
    - **Transaction History**: Complete audit trail for every token
    - **Portfolio Tracking**: Monitor multiple tokens and positions

## Use Cases

**🚀 Token Launches**

**For Projects & Creators**
    - Fair launch mechanisms
    - Community-driven price discovery
    - No upfront liquidity required
    - Built-in anti-bot protection

  **🎮 Gaming & NFTs**

**For GameFi Projects**
    - In-game currency launches
    - NFT project tokens
    - Reward token distribution
    - Player-owned economies

  **🏢 DApp Integration**

**For Developers**
    - Programmatic token creation
    - White-label solutions
    - Custom frontend integration
    - API-driven automation

## Technical Capabilities

### Smart Contract Features
- ✅ ERC20-compliant bond tokens with extended functionality
- ✅ Factory pattern for gas-efficient deployments
- ✅ Configurable parameters (supply, target, aggressiveness)
- ✅ Built-in fee distribution mechanism
- ✅ Automatic Uniswap v4 migration

### SDK Features
- ✅ Full TypeScript support with type definitions
- ✅ Promise-based async operations
- ✅ Event listeners and subscriptions
- ✅ Transaction receipt handling
- ✅ Error handling and retry logic

### Analytics Features
- ✅ Real-time price tracking
- ✅ Volume and liquidity metrics
- ✅ Historical transaction data
- ✅ OHLCV candlestick data
- ✅ User portfolio tracking

## Get started

**[Request Access](https://b3builders.typeform.com/bsmntdevelopers)**

Launch with BondKit on Base
  **[Chat with the Team](https://discord.gg/b3dotfun)**

Questions or feedback? Talk to us on Discord

## Key Terminology

**Core Concepts**

| Term | Definition |
    |------|------------|
    | **Bonding Phase** | Initial trading period with algorithmic pricing via bonding curve |
    | **Bond Token** | ERC20 token with built-in bonding curve mechanics |
    | **Target Amount** | Funding goal that triggers migration eligibility |
    | **Migration** | Transition from bonding curve to Uniswap v4 |
    | **Quote Asset** | The currency used to buy tokens (ETH or allowed ERC20) |

  **Technical Terms**

| Term | Definition |
    |------|------------|
    | **Minimal Proxy** | Gas-efficient contract cloning pattern |
    | **Aggressiveness Factor** | Parameter (0-100) controlling price curve steepness |
    | **sqrtPriceX96** | Uniswap v4 price format for pool initialization |
    | **Fee Recipient** | Address receiving trading fees during bonding |
    | **LP Split Ratio** | Liquidity provider fee percentage in basis points |

  **SDK Terms**

| Term | Definition |
    |------|------------|
    | **Factory Contract** | Main contract for deploying new bond tokens |
    | **Implementation** | Template contract cloned for each token |
    | **Public Client** | Read-only blockchain connection |
    | **Wallet Client** | Write-enabled blockchain connection |
    | **Provider** | Web3 connection interface (e.g., MetaMask) |

## Important Parameters

**Current Network**: Base Mainnet only

  **Supported Trading Tokens**:
  - B3 Token (primary on Base mainnet)
  - ETH (when configured as zero address)
  - Additional ERC20 tokens can be whitelisted

  **Fee Structure**:
  - 5% on all bonding phase trades
  - Customizable LP split ratio for migration

  **Security**:
  - Audited smart contracts
  - Automatic ownership renouncement post-migration
  - No admin keys after DEX phase begins

## Next Steps

**Install SDK**

Set up the BondKit SDK in your project
    ```bash
    pnpm add @b3dotfun/sdk
    ```
  **Read Quickstart**

Learn the basics with our step-by-step guide
  **Explore Examples**

Check out working implementations and demos
  **Join Community**

Get help and share feedback on Discord