@cetusprotocol/aggregator-sdk 1.1.4 → 1.1.6

package/.github/workflows/test.yml

@@ -0,0 +1,152 @@
+name: Automated Testing with Success Rate
+
+on:
+  push:
+    branches: [ main, develop, refactor-v3 ]
+  pull_request:
+    branches: [ main, develop, refactor-v3 ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      
+    - name: Setup Bun
+      uses: oven-sh/setup-bun@v1
+      with:
+        bun-version: latest
+        
+    - name: Install dependencies
+      run: bun install
+      
+    - name: Run tests with coverage and statistics
+      run: |
+        echo "🧪 Running all tests..."
+        
+        # Run tests with JSON output for parsing
+        bun test --json --outputFile=test-results.json --coverage || true
+        
+        # Also run regular test output for display
+        echo "📊 Test Results:"
+        bun test --verbose || TEST_EXIT_CODE=$?
+        
+        # Parse test results and calculate success rate
+        echo "📈 Calculating test success rate..."
+        
+        # Create a simple Node.js script to parse JSON results
+        cat > calculate-stats.js << 'EOF'
+        const fs = require('fs');
+        
+        try {
+          // Try to read the JSON results file
+          let results;
+          if (fs.existsSync('test-results.json')) {
+            const data = fs.readFileSync('test-results.json', 'utf8');
+            results = JSON.parse(data);
+          } else {
+            console.log('⚠️  JSON results file not found, using alternative method');
+            process.exit(1);
+          }
+          
+          // Calculate statistics
+          const totalTests = results.numTotalTests || 0;
+          const passedTests = results.numPassedTests || 0;
+          const failedTests = results.numFailedTests || 0;
+          const successRate = totalTests > 0 ? ((passedTests / totalTests) * 100).toFixed(2) : 0;
+          
+          console.log('\n📊 =================================');
+          console.log('📊 TEST EXECUTION SUMMARY');
+          console.log('📊 =================================');
+          console.log(`📊 Total Tests: ${totalTests}`);
+          console.log(`✅ Passed Tests: ${passedTests}`);
+          console.log(`❌ Failed Tests: ${failedTests}`);
+          console.log(`📈 Success Rate: ${successRate}%`);
+          console.log('📊 =================================\n');
+          
+          // Set environment variables for GitHub Actions
+          console.log(`::set-output name=total_tests::${totalTests}`);
+          console.log(`::set-output name=passed_tests::${passedTests}`);
+          console.log(`::set-output name=failed_tests::${failedTests}`);
+          console.log(`::set-output name=success_rate::${successRate}`);
+          
+          // Exit with non-zero code if tests failed
+          if (failedTests > 0) {
+            process.exit(1);
+          }
+          
+        } catch (error) {
+          console.error('Error parsing test results:', error);
+          process.exit(1);
+        }
+        EOF
+        
+        # Run the statistics calculation
+        node calculate-stats.js || {
+          echo "⚠️  Falling back to alternative statistics calculation..."
+          
+          # Alternative method using grep on test output
+          echo "📊 ================================="
+          echo "📊 TEST EXECUTION SUMMARY"
+          echo "📊 ================================="
+          
+          # Count test files
+          TEST_FILES=$(find tests -name "*.test.ts" | wc -l)
+          echo "📊 Total Test Files: $TEST_FILES"
+          
+          # Try to get basic stats from bun test output
+          echo "📊 Running tests again for statistics..."
+          bun test 2>&1 | tee test-output.log
+          
+          # Parse the output for basic statistics
+          if grep -q "Tests:" test-output.log; then
+            STATS=$(grep "Tests:" test-output.log | tail -1)
+            echo "📊 $STATS"
+          fi
+          
+          echo "📊 ================================="
+          
+          # Clean up
+          rm -f test-output.log
+        }
+        
+        # Clean up
+        rm -f calculate-stats.js test-results.json
+        
+        # Exit with the original test exit code
+        exit ${TEST_EXIT_CODE:-0}
+      
+    - name: Upload test results
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: test-results
+        path: |
+          coverage/
+          test-results.json
+        retention-days: 30
+        
+    - name: Comment PR with test results
+      uses: actions/github-script@v6
+      if: github.event_name == 'pull_request'
+      with:
+        script: |
+          const output = `## 🧪 Test Results
+          
+          **Test Execution Summary:**
+          - Total Tests: \${{ steps.test.outputs.total_tests || 'N/A' }}
+          - Passed Tests: \${{ steps.test.outputs.passed_tests || 'N/A' }}
+          - Failed Tests: \${{ steps.test.outputs.failed_tests || 'N/A' }}
+          - Success Rate: \${{ steps.test.outputs.success_rate || 'N/A' }}%
+          
+          \${{ steps.test.outputs.failed_tests > 0 && '❌ Some tests failed. Please review the test output above.' || '✅ All tests passed!' }}
+          `;
+          
+          github.rest.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: output
+          });

package/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+  "licenser.license": "AL2",
+  "licenser.author": "0xBondSui <sugar@cetus.zone>",
+  "licenser.projectName": "Cetus Aggregator TS SDK",
+  "licenser.useSingleLineStyle": true,
+  "licenser.disableAutoSave": false,
+  "licenser.disableAutoHeaderInsertion": false
+}

package/CLAUDE.md

@@ -0,0 +1,101 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+The **Cetus Aggregator SDK** is a TypeScript library for the Sui blockchain ecosystem that provides swap aggregation across 25+ decentralized exchanges (DEXs). The SDK finds optimal trading routes, best prices, and lowest slippage by integrating multiple DEXs including Cetus, DeepBook, Kriya, FlowX, Turbos, Aftermath, and many others.
+
+## Development Commands
+
+### Build and Development
+
+- `bun run build` - Compile TypeScript to CommonJS/ESM with type definitions using tsup
+- `bun run dev` - Development mode with file watching
+- `bun run clean` - Remove build artifacts and dependencies
+- `bun run publish:test` - Publish experimental version to bun
+
+### Testing
+
+- `bun test` - Run Jest test suite with ESM support
+- Tests are organized by aggregator versions (v2/v3) in `/tests/` directory
+- Individual DEX tests located in `/tests/aggregatorv2/router/`
+- Mathematical function tests in `/tests/math.test.ts`
+
+## Architecture
+
+### Core Components
+
+**Main Entry Points:**
+
+- `src/index.ts` - Main export barrel
+- `src/client.ts` - Aggregator v2 client implementation
+- `src/clientv3.ts` - Aggregator v3 client implementation
+
+**Key Directories:**
+
+- `src/transaction/` - DEX-specific swap implementations (25+ integrations)
+- `src/utils/` - Utility functions for coins, transactions, API calls
+- `src/types/` - TypeScript type definitions
+- `src/movecall/` - Move contract interaction helpers
+- `src/api/` - API interaction layer
+- `src/math/` - Mathematical calculations for trading
+
+### DEX Integration Pattern
+
+Each DEX has its own transaction module in `src/transaction/` following a consistent pattern:
+
+- Import from main client class (AggregatorClient/AggregatorClient)
+- Implement DEX-specific swap logic
+- Handle transaction building and execution
+- Support both amount-in and amount-out calculations
+
+### TypeScript Configuration
+
+- Uses path mapping: `~/*` maps to `src/*`
+- Jest configured with same path mapping
+- Targets ES6 with CommonJS modules
+- Strict TypeScript enabled
+
+### Key Dependencies
+
+- `@mysten/sui@^1.6.0` - Official Sui SDK for blockchain interactions
+- `@pythnetwork/pyth-sui-js@^2.1.0` - Pyth oracle integration for price feeds
+- `bn.js@^5.2.1` - Big number handling for precise calculations
+- `decimal.js@^10.4.3` - Decimal arithmetic for financial calculations
+
+### Multi-Version Support
+
+The SDK supports both Aggregator v2 and v3 APIs:
+
+- v2: Legacy aggregator with extensive DEX support
+- v3: Newer aggregator with enhanced features and performance
+
+### Testing Strategy
+
+- Unit tests for mathematical functions (`tests/math.test.ts`)
+- Integration tests for each DEX in `tests/aggregatorv2/router/`
+- Router functionality tests (`tests/aggregatorv2/router.test.ts`)
+- Wallet interaction tests (`tests/wallet.test.ts`)
+
+### Build Process
+
+Uses `tsup` for bundling with:
+
+- Multiple output formats (CJS, ESM, TypeScript declarations)
+- Tree shaking enabled
+- Code splitting support
+- Development watch mode
+
+### Contract Addresses
+
+The SDK works with multiple contract versions on Sui mainnet:
+
+- CetusAggregatorV2: `0x3864c7c59a4889fec05d1aae4bc9dba5a0e0940594b424fbed44cb3f6ac4c032`
+- CetusAggregatorV2ExtendV1: `0x39402d188b7231036e52266ebafad14413b4bf3daea4ac17115989444e6cd516`
+- CetusAggregatorV2ExtendV2: `0x368d13376443a8051b22b42a9125f6a3bc836422bb2d9c4a53984b8d6624c326`
+- CetusAggregatorSimple: `0x594d67abc0778023ac852800578271dd7e18698ad06e6298034858c77612333d`
+
+### Environment Setup
+
+The SDK works with Sui mainnet and testnet environments via the `Env` enum. Configure clients with appropriate RPC endpoints and package configurations for the target network.