@fenelabs/fene-sdk 0.3.2 → 0.3.3

package/package.json

@@ -1,68 +1,51 @@
 {
   "name": "@fenelabs/fene-sdk",
-  "version": "0.3.2",
-  "description": "Fene Network SDK for interacting with Resonance FPoS blockchain",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "version": "0.3.3",
+  "description": "TypeScript SDK for Fene API",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
     }
   },
   "files": [
-    "dist",
-    "README.md",
-    "CHANGELOG.md",
-    "LICENSE"
+    "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
     "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
-    "lint": "eslint src",
-    "type-check": "tsc --noEmit",
-    "prepublishOnly": "npm run build && npm run type-check"
-  },
-  "dependencies": {
-    "ethers": "^6.9.0"
-  },
-  "devDependencies": {
-    "@types/node": "^20.10.0",
-    "tsup": "^8.0.1",
-    "typescript": "^5.3.0"
+    "lint": "tsc --noEmit",
+    "test": "vitest run",
+    "prepublishOnly": "pnpm run build"
   },
   "keywords": [
     "resonance",
-    "blockchain",
-    "ethereum",
-    "staking",
+    "api",
     "sdk",
-    "poa",
-    "proof-of-authority",
-    "web3",
-    "validator",
-    "delegator",
-    "dpos",
-    "organization",
-    "politics",
-    "typescript"
+    "blockchain",
+    "fene"
   ],
-  "author": "avenbreaks",
+  "author": "Fene Labs",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/fenelabs/fene-sdk"
   },
-  "bugs": {
-    "url": "https://github.com/fenelabs/fene-sdk/issues"
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.3.0",
+    "vitest": "^1.0.0"
   },
-  "homepage": "https://github.com/fenelabs/fene-sdk#readme",
-  "publishConfig": {
-    "access": "public"
+  "peerDependencies": {
+    "viem": "^2.0.0"
   },
-  "engines": {
-    "node": ">=16.0.0"
+  "peerDependenciesMeta": {
+    "viem": {
+      "optional": true
+    }
   }
-}
+}

package/CHANGELOG.md

@@ -1,176 +0,0 @@
-# Changelog
-
-All notable changes to the Resonance SDK 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).
-
-## [0.2.1] - 2025-12-10
-
-### Added
-
-#### Analytics Helper Utilities
-- **Error handling helpers**: `isValidatorNotFound()`, `isServiceUnavailable()`, `isTimeout()`
-- **Data validation helpers**: `isStaleData()`, `isCachedData()`, `validatePagination()`
-- **Sync monitoring helpers**: `isSyncHealthy()`, `isSyncDegraded()`, `getSyncLag()`
-- **Data freshness**: `getDataFreshness()` - Calculate freshness score (0-100)
-- **Number formatting**: `formatNumber()`, `weiToEther()` - Format large numbers
-- **Batch optimization**: `getOptimalBatchSize()` - Calculate optimal pagination size
-
-#### Retry Logic
-- **`withRetry()`** - Execute functions with automatic retry on transient errors
-- **`createRetryWrapper()`** - Create retry-wrapped versions of functions
-- Configurable retry options: max retries, backoff, custom predicates
-- Built-in retry for timeout and 503 errors
-- Exponential backoff with max delay cap
-
-### Changed
-- Enhanced README with utility function documentation
-- Added `examples/analytics-advanced.ts` with advanced usage patterns
-- Improved error handling examples
-
-## [0.2.0] - 2025-12-10
-
-### Added
-
-#### Analytics API Module (Subgraph Data)
-- **New `analytics` module** for accessing subgraph-indexed blockchain data
-- `getProtocolStats()` - Get protocol-level statistics (total staking, validator counts, rewards)
-- `getSyncStatus()` - Check synchronization status of analytics workers
-- `getAllValidators()` - Get paginated list of validators with analytics data
-- `getTopValidators()` - Get top validators sorted by uptime
-- `getValidatorAnalytics()` - Get detailed analytics for a specific validator
-- `getValidatorRewards()` - Get validator rewards and stakes with **mandatory pagination**
-- `getAllValidatorRewards()` - Auto-pagination helper for fetching complete reward data
-
-#### New Types
-- `ValidatorAnalytics` - Validator analytics data structure
-- `ValidatorAnalyticsListResponse` - Paginated validator list response
-- `ProtocolStats` - Protocol-level statistics
-- `ValidatorRewardsResponse` - Validator rewards with metadata
-- `SyncStatusResponse` - Worker synchronization status
-- `RewardDTO`, `StakeDTO`, `RewardSummary` - Reward-related types
-- `ResponseMetadata` - Response metadata with cache and pagination info
-- `PaginationOptions`, `ValidatorListOptions` - Pagination interfaces
-
-### Changed
-- Updated main SDK class to include `analytics` module
-- Enhanced README with comprehensive analytics documentation
-- Added `examples/analytics-usage.ts` with complete usage examples
-
-### Notes
-- Analytics data is sourced from The Graph subgraph and may have slight delays
-- Rewards endpoint requires pagination to prevent excessive data transfer
-- Always check `metadata.cached` and `metadata.stale` flags for data freshness
-- Use `getSyncStatus()` to verify subgraph synchronization before critical operations
-
-## [0.1.1] - 2025-11-26
-
-### Fixed
-- Fixed referral validate endpoint to use correct query parameter `code` instead of `referral_code`
-- Fixed indentation in referrals.ts validate method
-
-### Changed
-- Updated JSDoc comment to reflect correct query parameter format `?code=CODE`
-
-## [0.1.0] - 2024-11-26
-
-### Added
-
-#### Core SDK Features
-- Initial release of Resonance Network SDK
-- Full TypeScript support with comprehensive type definitions
-- Support for both CommonJS and ES modules
-- Browser and Node.js compatibility
-
-#### API Modules
-- **Global API**: Network statistics, APR calculations, and leaderboards
-  - `getStats()` - Get global network statistics
-  - `getNetworkAPR()` - Get network APR
-  - `getNetworkAPRBreakdown()` - Get detailed APR breakdown
-  - `getLeaderboardDelegators()` - Get delegator leaderboard
-  - `getLeaderboardValidators()` - Get validator leaderboard
-
-- **Validators API**: Complete validator information and metrics
-  - `getAll()` - List all validators
-  - `get()` - Get validator details
-  - `getDelegators()` - Get validator's delegators
-  - `getStakeBreakdown()` - Get stake distribution
-  - `getEpoch()` - Get epoch-specific data
-  - `getHistory()` - Get historical data
-  - `getWithdrawals()` - Get withdrawal history
-  - `getMetrics()` - Get performance metrics
-  - `getSlashing()` - Get slashing events
-  - `getAPR()` - Get validator-specific APR
-
-- **Delegators API**: Delegator data and staking information
-  - `getAll()` - List all delegators
-  - `get()` - Get delegator details
-  - `getStakes()` - Get stake breakdown
-  - `getRewards()` - Get reward history
-  - `getWithdrawals()` - Get withdrawal history
-  - `getUnbonding()` - Get unbonding status
-  - `getValidators()` - Get active validators
-
-- **Referrals API**: Referral code management
-  - `validate()` - Validate referral code
-  - `create()` - Create new referral code (authenticated)
-  - `apply()` - Apply referral code
-  - `delete()` - Delete referral code (authenticated)
-  - `unlink()` - Unlink delegator from referral (authenticated)
-  - `getDelegatorReferral()` - Get delegator's referral info
-  - `getValidatorReferral()` - Get validator's referral info
-
-- **Slashing API**: Slashing events and penalties
-  - `getEvents()` - Get slashing events with optional filters
-
-#### Authentication
-- Web3 wallet authentication support
-- JWT token management
-- Session storage for token persistence
-- Automatic token expiration checking
-- Support for both validator and delegator roles
-
-#### HTTP Client
-- Custom timeout configuration
-- Custom header support
-- Automatic error handling
-- Query parameter building
-- Request/response type safety
-
-#### Developer Experience
-- Comprehensive TypeScript types for all API responses
-- Example files for common use cases
-- React hooks example for authentication
-- Full JSDoc documentation
-- ESLint configuration
-- Build tooling with tsup
-
-### Documentation
-- Complete README with usage examples
-- API reference documentation
-- React and Next.js integration examples
-- Node.js usage examples
-- Authentication flow examples
-- Error handling examples
-
-### Build & Distribution
-- CommonJS (CJS) build for Node.js
-- ES Module (ESM) build for modern bundlers
-- TypeScript declaration files (.d.ts)
-- Tree-shakeable exports
-
-## [Unreleased]
-
-### Planned Features
-- WebSocket support for real-time updates
-- Caching layer for frequently accessed data
-- Rate limiting and retry logic
-- GraphQL support (if API adds GraphQL)
-- Additional utility functions for common operations
-- React hooks package (@resonance/sdk-react)
-- Vue composables package (@resonance/sdk-vue)
-
----
-
-[0.1.0]: https://github.com/resonance-network/sdk/releases/tag/v0.1.0