SDK Installation
Complete guide to installing and configuring the Aegis SDK in your project.
Installation
Install the SDK and required dependencies:
npm install @aegis-vaults/sdk @solana/web3.js @coral-xyz/anchor bn.jsQuick Start
Create a simple script to test the installation:
import { AegisClient } from '@aegis-vaults/sdk';
const client = new AegisClient({
cluster: 'devnet',
});
console.log('Program ID:', client.programId.toBase58());
// ET9WDoFE2bf4bSmciLL7q7sKdeSYeNkWbNMHbAMBu2ZJConfiguration Options
The AegisClient constructor accepts comprehensive configuration:
const client = new AegisClient({
// Network Configuration
cluster: 'devnet', // 'devnet' | 'mainnet-beta' | 'testnet'
connection: customConnection, // Or provide custom Connection
programId: 'PROGRAM_ID', // Default: devnet program
// Guardian API
guardianApiUrl: 'https://aegis-guardian-production.up.railway.app',
// Transaction Settings
commitment: 'confirmed', // 'processed' | 'confirmed' | 'finalized'
confirmTimeout: 60000, // Milliseconds (default: 60s)
autoRetry: true, // Auto-retry failed transactions
maxRetries: 3, // Max retry attempts
// Override Behavior
autoRequestOverride: true, // Auto-notify Guardian on blocked tx
});See Installation Guide for detailed environment setup.
Next Steps
- API Reference - Complete method documentation
- Code Examples - Real-world usage patterns
- Error Handling - Handle errors gracefully