Skip to main content

Package Overview

The Saros Main SDK provides a comprehensive toolkit for building complete DeFi protocols on Solana. This SDK enables developers to create full-featured DeFi ecosystems with traditional AMM trading, yield farming, staking, and governance - all integrated into a cohesive protocol architecture.

What is the Main SDK?

The Main SDK provides a complete DeFi ecosystem foundation, integrating proven traditional AMM mechanics with advanced features like yield farming, governance, and staking into a cohesive protocol architecture. Core Features:
  • Traditional AMM - Proven constant product (x × y = k) mechanics with uniform liquidity
  • Yield Farming - Multi-token farming strategies with configurable rewards
  • Governance - Token-weighted voting and proposal execution systems
  • Staking - Single and multi-asset staking pools with reward distribution
Key Benefits:
  • Complete Ecosystem - All DeFi primitives integrated and working together
  • Battle-Tested - Traditional AMM mechanics proven across market cycles
  • User-Friendly - Simple, predictable mechanics accessible to all users
  • Modular Architecture - Use components independently or together

Package Details

AspectDetails
Package@saros-finance/sdk
Versionv2.4.0+
NetworksSolana Devnet, Mainnet-beta
LanguageJavaScript (ES6+)
FrameworkProtocol-agnostic
LicenseISC

Installation

Required Dependencies: The Main SDK requires Solana Web3.js for blockchain interactions and Wallet Adapter Base for wallet integration. Both packages are essential for full DeFi functionality.
# Core Saros SDK for complete DeFi ecosystem development
npm install @saros-finance/sdk

# Required Solana dependencies (matching SDK versions)
npm install @solana/web3.js@^1.31.0
npm install @project-serum/anchor@^0.25.0-beta.1
npm install bn.js@^5.2.0

Quick Start Example

import sarosSdk, {
  getSwapAmountSaros,
  swapSaros,
  getPoolInfo,
  depositAllTokenTypes,
  withdrawAllTokenTypes
} from '@saros-finance/sdk';
import { Connection, PublicKey } from '@solana/web3.js';
import BN from 'bn.js';

// Initialize connection
const connection = new Connection('https://api.devnet.solana.com');

// Access farm and stake services
const { SarosFarmService, SarosStakeServices } = sarosSdk;

// Get AMM swap quote using actual API
const fromMint = "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"; // USDC
const toMint = "So11111111111111111111111111111111111111112"; // SOL
const fromAmount = 1000000; // 1 USDC
const slippage = 0.5;

const swapEstimate = await getSwapAmountSaros(
  connection,
  fromMint,
  toMint, 
  fromAmount,
  slippage,
  poolParams // Pool configuration object required
);

console.log(`Estimated output: ${swapEstimate.amountOut} lamports`);

// Execute swap
const swapResult = await swapSaros(
  connection,
  wallet, // User wallet
  fromMint,
  toMint,
  fromAmount,
  swapEstimate.amountOut,
  slippage
);

// Farm staking using actual API
const farmResult = await SarosFarmService.stakePool(
  connection,
  payerAccount,
  new PublicKey("YourFarmAddress"),
  new BN(1000000),
  new PublicKey("SFarmWM5wLFNEw1q5ofqL7CrwBMwdcqQgK6oQuoBGZJ"), // SAROS_FARM_ADDRESS
  rewardsArray, // Complex rewards configuration
  new PublicKey("LPTokenAddress")
);

// Note: Governance functionality not yet implemented in SDK

Use Cases

Traditional AMM Protocol
  • ✅ Launch token with constant product AMM trading
  • ✅ Create farming incentives with multi-token rewards
  • ✅ Implement staking pools for additional utility
  • ⏳ Governance system (planned, not yet implemented)
Multi-Asset DeFi Platform
  • ✅ Support multiple trading pairs with AMM mechanics
  • ✅ Farming rewards across asset categories
  • ✅ Liquidity provision with deposit/withdraw functions
  • ⏳ Advanced treasury management (planned)
DeFi Infrastructure Development
  • ✅ Build on proven constant product AMM formulas
  • ✅ Integrate yield farming with customizable rewards
  • ✅ Access low-level swap and liquidity functions
  • ✅ Support for custom pool configurations
Current SDK Status: The SDK provides full AMM trading, farming, and staking functionality. Governance features are documented but not yet implemented in the current version (v2.4.0).

Your Journey to Complete DeFi Protocol Development

Follow this structured path to master comprehensive DeFi development. Each step builds on the previous one, taking you from DeFi beginner to advanced protocol architect.

DeFi Ecosystem Components

Traditional AMM Trading

// Proven constant product formula (x * y = k)
const ammPool = {
  formula: 'constant_product',
  liquidityDistribution: 'uniform',
  priceRange: [0, '∞'],
  userExperience: 'predictable',
  capitalEfficiency: 'standard'
};

Yield Farming Infrastructure

// Multi-token farming with flexible rewards
const farmingProgram = {
  rewardTokens: ['SAROS', 'USDC', 'SOL'],
  stakingAssets: ['LP-USDC-SOL', 'SAROS'],
  vestingSchedules: 'configurable',
  boostMechanisms: 'governance_stake_multiplier'
};

Governance System

// Comprehensive protocol governance
const governance = {
  votingMechanism: 'token_weighted',
  proposalTypes: ['parameter_changes', 'treasury_management', 'protocol_upgrades'],
  executionDelay: '48_hours',
  quorumRequirement: '4_percent'
};

Staking Mechanisms

// Flexible staking with multiple reward sources
const stakingSystem = {
  stakingAssets: ['SAROS', 'LP_TOKENS'],
  rewardSources: ['protocol_fees', 'token_emissions', 'treasury_yield'],
  lockupPeriods: 'configurable',
  slashingProtection: 'built_in'
};

Architecture Advantages

Unified Integration

  • Cross-Module Synergies - AMM fees fund farming rewards, staking provides governance power
  • Consistent User Experience - Same wallet, same interface across all features
  • Simplified Development - One SDK handles entire DeFi protocol stack

Battle-Tested Mechanics

  • Proven AMM Formula - Constant product mechanics tested across market cycles
  • Predictable Behavior - Well-understood risks and returns for users
  • Regulatory Clarity - Traditional mechanics have clearer regulatory precedents

Community-Focused Design

  • Broad Accessibility - No specialized knowledge required to participate
  • Democratic Governance - Equal access to protocol decision-making
  • Inclusive Economics - Rewards distributed across entire community

Use Case Examples

Community DeFi Protocol
  • Launch token with AMM trading
  • Create farming incentives for early adopters
  • Implement governance for community control
  • Add staking for additional utility
Multi-Asset DeFi Hub
  • Support 20+ trading pairs with uniform experience
  • Farming rewards across multiple asset categories
  • Treasury management through governance voting
  • Cross-asset staking and reward distribution
Traditional Finance Bridge
  • Familiar AMM mechanics for TradFi users
  • Predictable yield farming similar to CD rates
  • Democratic governance resembling shareholder voting
  • Staking similar to dividend-earning stocks

Performance Characteristics

Traditional AMM Metrics (compared to DLMM):
MetricMain SDKDLMMTrade-off
Capital Efficiency1x (baseline)10-100xSimplicity vs Efficiency
User ComplexityLowHighAccessibility vs Optimization
PredictabilityHighVariableConsistency vs Maximum Yield
Management RequiredNoneActivePassive vs Active Returns

Community & Resources