Overview

The Ferra Aggregator SDK is a powerful TypeScript library for integrating decentralized exchange (DEX) aggregation functionality into your Sui blockchain applications. It provides seamless access to multiple DEX protocols including CLMM and DLMM through a unified interface.

Key Features

  • Multi-DEX Support: Integrate with Ferra CLMM, DLMM, and other major DEX protocols

  • Intelligent Routing: Automatic best price discovery across multiple liquidity sources

  • Type Safety: Full TypeScript support with comprehensive type definitions

  • Flexible Configuration: Customizable for mainnet, testnet, and local development

  • Error Handling: Comprehensive error management with detailed error codes

  • Caching: Built-in caching for improved performance

Supported Networks

  • Sui Mainnet: Production-ready deployment

  • Sui Testnet: Testing and development environment

  • Local Networks: Custom RPC endpoints for development

Supported DEX Protocols

  • Ferra CLMM: Concentrated Liquidity Market Maker

  • Ferra DLMM: Dynamic Liquidity Market Maker

  • Future Integrations: Cetus, Navi, SuiSwap, Turbos (coming soon)

Architecture

The SDK is built with a modular architecture:

FerraAggregatorSDK
├── QuoterModule     # Price discovery and route optimization
├── AggSwapModule    # Multi-step swap execution
├── Configuration    # Network and protocol settings
├── Utils            # Helper functions and validators
└── Error Handling   # Comprehensive error management

Core Components

  • SDK Core: Main SDK class managing configuration and modules

  • Quoter Module: Handles price queries and route discovery

  • Swap Module: Executes complex multi-hop swaps

  • Transaction Builder: Constructs Sui Move transactions

  • Cache System: Optimizes API calls and data retrieval

Getting Started

Ready to integrate the Ferra Aggregator SDK? Start with our Installation Guide or jump directly to the Quick Start tutorial to build your first swap application.

Support

  • Documentation: Complete API reference and guides

  • GitHub Issues: Bug reports and feature requests

  • Community: Join our developer community for support and discussions

PreviousTypescript SDKNextInstallation

Last updated