@paxoslabs/earn-sdk/CHANGELOG.md

Paxos Labs Earn SDK

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

<!-- auto-changelog-above -->

## [Unreleased]

### Documentation
- **Comprehensive SDK Documentation (Phase 008)**:
  - Complete README.md overhaul with 5-minute quick start guide
  - New documentation structure under `docs/`:
    - `getting-started.md` - Detailed installation and first API call guide
    - `api-reference/` - Complete API documentation for all SDK functions
      - `vault-discovery.md` - Vault and asset discovery via Earn API
      - `deposits.md` - Standard deposit flows (viem + wagmi patterns)
      - `deposits-permit.md` - Gas-optimized permit deposits (EIP-2612)
      - `withdrawals.md` - Complete withdrawal flows with deadline protection
      - `caching.md` - Performance optimization with vault caching
      - `types.md` - TypeScript type definitions reference
    - `guides/` - Tutorial-style integration guides
      - `react-integration.md` - Three React patterns (direct, custom hooks, TanStack Query)
      - `error-handling.md` - Error handling patterns for API and transactions
      - `multi-chain.md` - Multi-chain deployment and chain selection
    - `examples/` - Fully executable example projects
      - `viem-deposit/` - Complete viem deposit example with tests
      - `wagmi-deposit/` - Complete wagmi deposit example with React hooks
      - `wagmi-withdraw/` - Complete wagmi withdrawal example
  - 56 viem code examples and 33 wagmi code examples across all documentation
  - 100% coverage of all 48 functional requirements
  - All code examples are TypeScript with full type safety
  - MSW (Mock Service Worker) integration for runnable examples
  - Validation script for documentation quality assurance

## [0.0.1-alpha.1] - 2025-11-01

### Features
- Initial SDK implementation with comprehensive EarnVault support
- Multi-chain support (PRIME) Earn vaults
- Complete deposit functionality with approval management and slippage protection
- Cross-chain bridging support for deposit and withdrawal flows
- **New Withdraw Flow (Phase 5)**:
  - Prepare withdrawal transactions with `prepareWithdrawTransactionData()`
  - Automatic vault data fetching and caching via `fetchSupportedAssets()`
  - Three-field vault resolution (yieldType + wantToken + chainId)
  - Configurable slippage protection (default 1%, in basis points)
  - Full TypeScript type safety for all withdraw operations
  - Comprehensive error handling with specific error codes
- Exchange rate calculations and approval management
- Complete TypeScript support with full type safety

### Build System
- Added automated release workflow with conventional commits
- Configured semantic versioning with alpha/beta/rc support
- Implemented comprehensive CI/CD pipeline with quality gates
- Added security auditing and dependency scanning
- Configured automated NPM publishing with provenance