# Overview

## Doppler V3 SDK Overview

### What is the Doppler V3 SDK?

The Doppler V3 SDK is a TypeScript library that provides developers with comprehensive tools to interact with the Doppler protocol's V3 implementation. It enables seamless integration with Doppler's token creation, price discovery, and liquidity migration systems across multiple EVM-compatible networks.

The SDK abstracts the complexity of smart contract interactions, providing type-safe methods for creating tokens, managing pools, and handling the complete lifecycle of assets on the Doppler protocol. It's designed to support both read-only operations for data querying and write operations for token deployment and pool management.

### How does Doppler v3 work?

Doppler v3 has a few configurations depending on an application's goals. It can be created to migrate post-bonding curve liquidity into Uniswap v2 to accumulate more fees overtime, Uniswap v4 to support application specific fee tiers, or left within positions on Uniswap v3. Here's an overview.

With "migration" to Uniswap v2

<figure><img src="https://3892644133-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fit0zR3kmdiX4qfUZmnKI%2Fuploads%2FTJqhEhufyYEY9IDaF6DH%2Fdoppler-roadmap-dark%20(3).png?alt=media&#x26;token=c9a3c64d-f11d-4878-bf26-ba408a547604" alt=""><figcaption></figcaption></figure>

With "migration" to Uniswap v4

<figure><img src="https://3892644133-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fit0zR3kmdiX4qfUZmnKI%2Fuploads%2FcbPOyya8I0CP3NPza1mQ%2Fdoppler-roadmap-dark%20(5).png?alt=media&#x26;token=3cc061f7-8cb2-4968-9335-96b170ce223a" alt=""><figcaption></figcaption></figure>

Without "migration"

<figure><img src="https://3892644133-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fit0zR3kmdiX4qfUZmnKI%2Fuploads%2F9jEt3lZ0xuaHXIDPAb0X%2Fdoppler-roadmap-dark%20(2).png?alt=media&#x26;token=a09e55e0-831a-4638-a944-73097c5bd6f7" alt=""><figcaption></figcaption></figure>

### What is Drift?

The Doppler V3 SDK is built on top of [Drift](https://delvtech.github.io/drift/), a modern blockchain interaction framework that simplifies Web3 development by:

* Providing unified interfaces for different wallet providers and RPC endpoints
* Handling transaction lifecycle management with automatic retry logic
* Offering type-safe contract interaction patterns
* Supporting both read and write operations with consistent error handling

### Core Concepts

#### Supported Networks

The V3 SDK supports multiple networks where Doppler protocol contracts are deployed:

| Network              | Chain ID | Environment | Purpose                 |
| -------------------- | -------- | ----------- | ----------------------- |
| **Base Mainnet**     | `8453`   | Production  | Live token deployments  |
| **Unichain Mainnet** | `130`    | Production  | Live token deployments  |
| **Ink**              | `57073`  | Production  | Live token deployments  |
| **Base Sepolia**     | `84532`  | Testnet     | Development and testing |

Network addresses and configurations are automatically managed through the `DOPPLER_V3_ADDRESSES` constant, making it easy to switch between networks.

#### Factory Classes

The SDK provides two main factory classes for different interaction patterns:

| Class              | Purpose                              | Use Cases                           |
| ------------------ | ------------------------------------ | ----------------------------------- |
| `ReadFactory`      | Query protocol state and read data   | Analytics, monitoring, data display |
| `ReadWriteFactory` | Create tokens and manage deployments | Token creation, pool management     |

#### Asset Lifecycle Management

The SDK handles the complete Doppler asset lifecycle:

1. **Token Creation**: Deploy new DERC20 tokens with customizable parameters
2. **Price Discovery**: Manage initial liquidity and price discovery phases
3. **Migration**: Handle liquidity migration to Uniswap V2 pools (or V4 with fee streaming)
4. **Pool Operations**: Interact with both price discovery and migrated pools

### Key Features

#### Token Creation & Configuration

The SDK provides comprehensive token creation capabilities:

* **Flexible Configuration**: Support for custom token parameters, sale configurations, and governance settings
* [**Configuration Types**](#default-configurations-and-customization): Utilize `DefaultConfigs` for predefined config types
* **Parameter Validation**: Automatic validation of creation parameters to prevent deployment errors
* **Gas Estimation**: Built-in simulation capabilities for accurate gas estimation

#### Pool Interaction

Comprehensive pool management and querying:

* **Pool State Queries**: Access to slot0, token information, and fee structures
* **Event Tracking**: Retrieve mint, burn, and swap events from pools
* **Multi-Protocol Support**: Handle both V3 price discovery pools and migrated V2/V4 pools
* **Real-time Data**: Live access to pool liquidity, prices, and trading activity

#### V4 Migration Support

Built-in support for migrating to Uniswap V4 with advanced features:

* **Fee Streaming Configuration**: Set up fee distribution to multiple beneficiaries
* **Beneficiary Management**: Automatic sorting and validation of beneficiary data
* **Migration Validation**: Ensure proper configuration before migration execution

### Contract Integration

#### Core Contracts

The SDK integrates with several key contract types:

| Contract Type       | Purpose                         | SDK Integration                    |
| ------------------- | ------------------------------- | ---------------------------------- |
| `Airlock`           | Main factory for token creation | `ReadFactory`, `ReadWriteFactory`  |
| `TokenFactory`      | DERC20 token deployment         | Automatic integration via factory  |
| `GovernanceFactory` | Governance contract creation    | Configurable through creation flow |
| `PoolInitializer`   | V3 pool initialization          | Automatic pool setup               |
| `LiquidityMigrator` | Handle pool migrations          | Migration flow management          |
| `UniswapV3Pool`     | Price discovery pools           | `ReadUniswapV3Pool` class          |

#### Event Handling

The SDK provides access to important protocol events:

* **Create Events**: Track new token deployments with full asset data
* **Migrate Events**: Monitor liquidity migrations between pool types
* **Pool Events**: Access mint, burn, and swap events from individual pools
* **Transfer Events**: Track token transfers and balance changes

***

### Default Configurations & Customization

#### **Sale Configuration**

Token sale parameters, pricing, and distribution

| Key               | Type   | Default       | Purpose                   |
| ----------------- | ------ | ------------- | ------------------------- |
| `initialSupply`   | bigint | 1,000,000,000 | Starting supply of tokens |
| `numTokensToSell` | bigint | 900,000,000   | Amount of tokens to sell  |

```typescript
import {
  DefaultConfigs,
  DEFAULT_INITIAL_SUPPLY_WAD,
  DEFAULT_NUM_TOKENS_TO_SELL_WAD
} from 'doppler-v3-sdk';

const saleConfig: DefaultConfigs['defaultSaleConfig'] = {
  initialSupply: DEFAULT_INITIAL_SUPPLY_WAD, // parseEther("1_000_000_000")
  numTokensToSell: DEFAULT_NUM_TOKENS_TO_SELL_WAD, // parseEther("900_000_000")
};
```

***

#### Pool Configuration

Fee tiers, tick spacing, and initial liquidity

| Key                 | Type   | Default     | Purpose                                  |
| ------------------- | ------ | ----------- | ---------------------------------------- |
| `startTick`         | number | 175,000     | Lower price bound                        |
| `endTick`           | number | 225,000     | Upper price bound                        |
| `numPositions`      | number | 15          | Uniswap v3 positions placed              |
| `maxSharesToBeSold` | bigint | 0.35        | percentage of supply used in the auction |
| `fee`               | number | 10,000 (1%) | swap fees                                |

```typescript
import {
  DefaultConfigs,
  DEFAULT_START_TICK,
  DEFAULT_END_TICK,
  DEFAULT_NUM_POSITIONS,
  DEFAULT_MAX_SHARE_TO_BE_SOLD,
  DEFAULT_FEE,
} from 'doppler-v3-sdk';

const poolConfig: DefaultConfigs['defaultV3PoolConfig'] = {
  startTick: DEFAULT_START_TICK, // 175_000
  endTick: DEFAULT_END_TICK, // 225_000
  numPositions: DEFAULT_NUM_POSITIONS, // 15
  maxShareToBeSold: DEFAULT_MAX_SHARE_TO_BE_SOLD, // parseEther("0.35")
  fee: DEFAULT_FEE, // 10_000, 1% fee tier
};
```

***

#### Governance Configuration

Voting parameters, proposal thresholds, and timelock settings

| Key                        | Type   | Default   | Purpose                              |
| -------------------------- | ------ | --------- | ------------------------------------ |
| `initialVotingDelay`       | number | 172,800   | when voting can begin                |
| `initialVotingPeriod`      | number | 1,209,600 | how long a vote lasts                |
| `initialProposalThreshold` | bigInt | 0         | required tokens to create a proposal |

```typescript
import {
  DefaultConfigs,
  DEFAULT_INITIAL_VOTING_DELAY,
  DEFAULT_INITIAL_VOTING_PERIOD,
  DEFAULT_INITIAL_PROPOSAL_THRESHOLD,
} from 'doppler-v3-sdk';

const governanceConfig: DefaultConfigs['defaultGovernanceConfig'] = {
  initialVotingDelay: DEFAULT_INITIAL_VOTING_DELAY, // 172_800
  initialVotingPeriod: DEFAULT_INITIAL_VOTING_PERIOD, // 1_209_600
  initialProposalThreshold: DEFAULT_INITIAL_PROPOSAL_THRESHOLD, // BigInt(0);
};
```

***

#### Vesting Configuration

Token vesting schedules and inflation parameters

| Key               | Type                            | Default                          | Purpose                           |
| ----------------- | ------------------------------- | -------------------------------- | --------------------------------- |
| `yearlyMintRate`  | bigint                          | 0.02 (2%)                        | annual token inflation            |
| `vestingDuration` | bigint                          | 31,536,000 (one year in seconds) | vesting cadence                   |
| `recipients`      | [Address\[\]](https://viem.sh/) | \[]                              | vesting recipients                |
| `amounts`         | bigint\[]                       | \[]                              | vesting amount for each recipient |

```typescript
import {
  DefaultConfigs,
  DEFAULT_YEARLY_MINT_RATE_WAD,
  DEFAULT_VESTING_DURATION,
} from 'doppler-v3-sdk';
import { parseEther } from "viem";

const vestingConfig: DefaultConfigs['defaultVestingConfig'] = {
  yearlyMintRate: DEFAULT_YEARLY_MINT_RATE_WAD, // parseEther("0.02")
  vestingDuration: DEFAULT_VESTING_DURATION, // BigInt(ONE_YEAR_IN_SECONDS)
  recipients: ["0x..."], // custom recipients
  amounts: [parseEther('50_000_000')], // custom amounts
};
```

***

### Error Handling & Validation

#### Built-in Validations

The SDK includes comprehensive validation for:

* **Parameter Consistency**: Ensure all configuration parameters are compatible
* **Network Compatibility**: Validate contract addresses for the target network
* **Mathematical Constraints**: Check that numerical parameters meet protocol requirements
* **Beneficiary Configuration**: Validate fee streaming beneficiary shares sum to 100%

#### Error Types

Common error scenarios handled by the SDK:

* **Configuration Errors**: Invalid parameter combinations or missing required fields
* **Network Errors**: RPC failures, transaction timeouts, and connection issues
* **Contract Errors**: Revert reasons, gas estimation failures, and execution errors
* **Validation Errors**: Parameter validation failures and constraint violations

## Next steps

For detailed implementation examples, see the [Getting Started Guide](https://docs.doppler.lol/reference/legacy-sdks-and-migration-guides/v3/getting-started) and explore the comprehensive API documentation in the [Factory Reference](https://docs.doppler.lol/reference/legacy-sdks-and-migration-guides/v3/factory).