@defindex/sdk
Version:
Official TypeScript SDK for DeFindex API
430 lines • 17.9 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.DefindexSDK = void 0;
const http_client_1 = require("./clients/http-client");
/**
* DeFindex SDK - TypeScript client for DeFindex API
*
* @example
* ```typescript
* // Basic initialization
* const sdk = new DefindexSDK({
* baseUrl: 'https://api.defindex.io'
* });
*
* // With API key authentication
* const sdk = new DefindexSDK({
* apiKey: 'sk_your_api_key_here',
* baseUrl: 'https://api.defindex.io'
* });
* ```
*/
class DefindexSDK {
/**
* Create a new DeFindex SDK instance
* @param config - SDK configuration options
*/
constructor(config) {
this.config = config;
this.httpClient = new http_client_1.HttpClient(config.baseUrl || 'https://api.defindex.io', config.apiKey || '', // API key or empty string
config.timeout || 30000);
}
//=======================================================================
// System Operations
//=======================================================================
/**
* Check API health status
* @returns Health status information
* @example
* ```typescript
* const health = await sdk.healthCheck();
* if (health.status.reachable) {
* console.log('API is healthy');
* }
* ```
*/
async healthCheck() {
return this.httpClient.get('/health');
}
//=======================================================================
// Factory Operations
//=======================================================================
/**
* Get the factory contract address for a specific network
* @param network - Stellar network (testnet or mainnet)
* @returns Factory contract address
* @example
* ```typescript
* const factory = await sdk.getFactoryAddress(SupportedNetworks.TESTNET);
* console.log('Factory address:', factory.address);
* ```
*/
async getFactoryAddress(network) {
return this.httpClient.get(`/factory/address?network=${network}`);
}
/**
* Create a new vault (requires Vault Manager role)
* @param vaultConfig - Vault configuration including assets, fees, and roles
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for vault creation
* @example
* ```typescript
* const vaultConfig = {
* roles: { "0": "GMANAGER...", "1": "CFEE..." },
* vault_fee_bps: 100, // 1%
* assets: [{ address: "CASSET...", strategies: [...] }],
* name_symbol: { name: "My Vault", symbol: "MVLT" },
* upgradable: true,
* caller: "GCALLER..."
* };
* const response = await sdk.createVault(vaultConfig, SupportedNetworks.TESTNET);
* ```
*/
async createVault(vaultConfig, network) {
return this.httpClient.post(`/factory/create-vault?network=${network}`, vaultConfig);
}
/**
* Create a new vault with initial deposit in a single transaction
* @param vaultConfig - Vault configuration with initial deposit amounts
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for vault creation and deposit
* @example
* ```typescript
* const vaultConfig = {
* // ... vault config
* deposit_amounts: [1000000, 2000000] // Initial deposit amounts
* };
* const response = await sdk.createVaultWithDeposit(vaultConfig, SupportedNetworks.TESTNET);
* ```
*/
async createVaultWithDeposit(vaultConfig, network) {
return this.httpClient.post(`/factory/create-vault-deposit?network=${network}`, vaultConfig);
}
//=======================================================================
// Vault Operations
//=======================================================================
/**
* Get comprehensive vault information
* @param vaultAddress - The vault contract address
* @param network - Stellar network (testnet or mainnet)
* @returns Vault metadata, assets, strategies, and TVL information
* @example
* ```typescript
* const vaultInfo = await sdk.getVaultInfo(
* 'CVAULT...',
* SupportedNetworks.TESTNET
* );
* console.log(`Vault: ${vaultInfo.name} (${vaultInfo.symbol})`);
* console.log(`Total Assets: ${vaultInfo.totalAssets}`);
* ```
*/
async getVaultInfo(vaultAddress, network) {
return this.httpClient.get(`/vault/${vaultAddress}?network=${network}`);
}
/**
* Get user's vault balance and shares
* @param vaultAddress - The vault contract address
* @param userAddress - User's wallet address
* @param network - Stellar network (testnet or mainnet)
* @returns User's vault shares and underlying asset values
* @example
* ```typescript
* const balance = await sdk.getVaultBalance(
* 'CVAULT...',
* 'GUSER...',
* SupportedNetworks.TESTNET
* );
* console.log(`Shares: ${balance.dfTokens}`);
* console.log(`Underlying values: ${balance.underlyingBalance}`);
* ```
*/
async getVaultBalance(vaultAddress, userAddress, network) {
return this.httpClient.get(`/vault/${vaultAddress}/balance?from=${userAddress}&network=${network}`);
}
/**
* Get vault report with transaction details
* @param vaultAddress - The vault contract address
* @param network - Stellar network (testnet or mainnet)
* @returns Vault report with transaction XDR and simulation response
* @example
* ```typescript
* const report = await sdk.getReport(
* 'CVAULT...',
* SupportedNetworks.TESTNET
* );
* console.log(`Report XDR: ${report.xdr}`);
* ```
*/
async getReport(vaultAddress, network) {
return this.httpClient.get(`/vault/${vaultAddress}/report?network=${network}`);
}
/**
* Deposit assets into a vault
* @param vaultAddress - The vault contract address
* @param depositData - Deposit parameters including amounts and caller address
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for signing and simulation response
*/
async depositToVault(vaultAddress, depositData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/deposit?network=${network}`, depositData);
}
/**
* Withdraw specific asset amounts from vault
* @param vaultAddress - The vault contract address
* @param withdrawData - Withdrawal parameters including amounts and caller
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for signing and simulation response
* @example
* ```typescript
* const withdrawData = {
* amounts: [500000, 1000000],
* caller: 'GUSER...',
* slippageBps: 100 // 1% slippage tolerance
* };
* const response = await sdk.withdrawFromVault('CVAULT...', withdrawData, SupportedNetworks.TESTNET);
* ```
*/
async withdrawFromVault(vaultAddress, withdrawData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/withdraw?network=${network}`, withdrawData);
}
/**
* Withdraw vault shares for underlying assets
* @param vaultAddress - The vault contract address
* @param shareData - Share withdrawal parameters including share amount and caller
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for signing and simulation response
*/
async withdrawShares(vaultAddress, shareData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/withdraw-shares?network=${network}`, shareData);
}
/**
* Get vault's Annual Percentage Yield (APY)
* @param vaultAddress - The vault contract address
* @param network - Stellar network (testnet or mainnet)
* @returns APY information including percentage and calculation period
* @example
* ```typescript
* const apy = await sdk.getVaultAPY('CVAULT...', SupportedNetworks.TESTNET);
* console.log(`APY: ${apy.apyPercent}% (calculated over ${apy.period})`);
* ```
*/
async getVaultAPY(vaultAddress, network) {
return this.httpClient.get(`/vault/${vaultAddress}/apy?network=${network}`);
}
//=======================================================================
// Vault Management Operations
//=======================================================================
/**
* Rebalance vault strategies (Rebalance Manager role required)
* @param vaultAddress - The vault contract address
* @param rebalanceData - Rebalance parameters including investment instructions
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Rebalance Manager signing
* @example
* ```typescript
* const rebalanceData = {
* caller: 'GREBALANCE_MANAGER...',
* instructions: [
* { type: 'Unwind', strategy_address: 'CSTRATEGY1...', amount: 500000 },
* { type: 'Invest', strategy_address: 'CSTRATEGY2...', amount: 1000000 },
* {
* type: 'SwapExactIn',
* token_in: 'GTOKEN1...',
* token_out: 'GTOKEN2...',
* amount: 250000,
* slippageToleranceBps: 100
* }
* ]
* };
* const response = await sdk.rebalanceVault('CVAULT...', rebalanceData, SupportedNetworks.TESTNET);
* ```
*/
async rebalanceVault(vaultAddress, rebalanceData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/rebalance?network=${network}`, rebalanceData);
}
/**
* Emergency rescue assets from strategy (Emergency Manager role required)
* @param vaultAddress - The vault contract address
* @param rescueData - Rescue parameters including strategy address and caller
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Emergency Manager signing and rescued assets info
* @example
* ```typescript
* const rescueData = {
* strategy_address: 'CSTRATEGY...',
* caller: 'GEMERGENCY_MANAGER...'
* };
* const response = await sdk.emergencyRescue('CVAULT...', rescueData, SupportedNetworks.TESTNET);
* ```
*/
async emergencyRescue(vaultAddress, rescueData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/rescue?network=${network}`, rescueData);
}
/**
* Pause a specific strategy (Strategy Manager role required)
* @param vaultAddress - The vault contract address
* @param strategyData - Strategy pause parameters
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Strategy Manager signing
* @example
* ```typescript
* const strategyData = {
* strategy_address: 'CSTRATEGY...',
* caller: 'CSTRATEGY_MANAGER...'
* };
* const response = await sdk.pauseStrategy('CVAULT...', strategyData, SupportedNetworks.TESTNET);
* ```
*/
async pauseStrategy(vaultAddress, strategyData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/pause-strategy?network=${network}`, strategyData);
}
/**
* Unpause a specific strategy (Strategy Manager role required)
* @param vaultAddress - The vault contract address
* @param strategyData - Strategy unpause parameters
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Strategy Manager signing
* @example
* ```typescript
* const strategyData = {
* strategy_address: 'CSTRATEGY...',
* caller: 'GSTRATEGY_MANAGER...'
* };
* const response = await sdk.unpauseStrategy('CVAULT...', strategyData, SupportedNetworks.TESTNET);
* ```
*/
async unpauseStrategy(vaultAddress, strategyData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/unpause-strategy?network=${network}`, strategyData);
}
//=======================================================================
// Role Operations
//=======================================================================
/**
* Get a specific vault role address
* @param vaultAddress - The vault contract address
* @param network - Stellar network (testnet or mainnet)
* @param roleToGet - The role to retrieve (manager, emergency_manager, rebalance_manager, fee_receiver)
* @returns Role information with address
* @example
* ```typescript
* const role = await sdk.getVaultRole(
* 'CVAULT...',
* SupportedNetworks.TESTNET,
* VaultGetRoleMethods.GET_MANAGER
* );
* console.log(`Manager address: ${role.address}`);
* ```
*/
async getVaultRole(vaultAddress, network, roleToGet) {
return this.httpClient.get(`/vault/${vaultAddress}/get/${roleToGet}?network=${network}`);
}
/**
* Set a vault role to a new address (Manager role required)
* @param vaultAddress - The vault contract address
* @param roleData - Role assignment parameters including new address and caller
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Manager signing
* @example
* ```typescript
* const roleData = {
* caller: 'GMANAGER...',
* new_address: 'GNEW_MANAGER...'
* };
* const response = await sdk.setVaultRole('CVAULT...', roleData, SupportedNetworks.TESTNET);
* ```
*/
async setVaultRole(vaultAddress, roleToSet, roleData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/set/${roleToSet}?network=${network}`, roleData);
}
//=======================================================================
// Vault Management Operations
//=======================================================================
/**
* Lock vault fees and optionally update fee rate (Manager role required)
* @param vaultAddress - The vault contract address
* @param lockData - Lock fees parameters including optional new fee rate
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Manager signing
* @example
* ```typescript
* const lockData = {
* caller: 'GMANAGER...',
* new_fee_bps: 150 // Optional: new fee rate in basis points (1.5%)
* };
* const response = await sdk.lockVaultFees('CVAULT...', lockData, SupportedNetworks.TESTNET);
* ```
*/
async lockVaultFees(vaultAddress, lockData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/lock-fees?network=${network}`, lockData);
}
/**
* Release fees from a specific strategy (Manager role required)
* @param vaultAddress - The vault contract address
* @param releaseData - Release fees parameters including strategy address and amount
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Manager signing
* @example
* ```typescript
* const releaseData = {
* caller: 'GMANAGER...',
* strategy_address: 'CSTRATEGY...',
* amount: 100000
* };
* const response = await sdk.releaseVaultFees('CVAULT...', releaseData, SupportedNetworks.TESTNET);
* ```
*/
async releaseVaultFees(vaultAddress, releaseData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/release-fees?network=${network}`, releaseData);
}
/**
* Distribute accumulated vault fees to fee receiver (Manager role required)
* @param vaultAddress - The vault contract address
* @param distributeData - Distribution parameters including caller
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Manager signing
* @example
* ```typescript
* const distributeData = {
* caller: 'GMANAGER...'
* };
* const response = await sdk.distributeVaultFees('CVAULT...', distributeData, SupportedNetworks.TESTNET);
* ```
*/
async distributeVaultFees(vaultAddress, distributeData, network) {
return this.httpClient.post(`/vault/${vaultAddress}/distribute-fees?network=${network}`, distributeData);
}
/**
* Upgrade vault WASM contract (Manager role required)
* @param vaultAddress - The vault contract address
* @param newWasmHash - Upgrade parameters including new WASM hash and caller
* @param network - Stellar network (testnet or mainnet)
* @returns Transaction XDR for Manager signing
* @example
* ```typescript
* const upgradeData = {
* caller: 'GMANAGER...',
* new_wasm_hash: 'abcd1234...' // New WASM hash to upgrade to
* };
* const response = await sdk.upgradeVaultWasm('CVAULT...', upgradeData, SupportedNetworks.TESTNET);
* ```
*/
async upgradeVaultWasm(vaultAddress, newWasmHash, network) {
return this.httpClient.post(`/vault/${vaultAddress}/upgrade?network=${network}`, newWasmHash);
}
//=======================================================================
// Transaction Operations
//=======================================================================
/**
* Submit a signed transaction to the Stellar blockchain
* @param xdr - Base64 encoded signed transaction XDR
* @param network - Stellar network (testnet or mainnet)
* @param launchtube - Whether to use LaunchTube service (defaults to false)
* @returns Transaction response with hash and status
*/
async sendTransaction(xdr, network, launchtube) {
const payload = { xdr, launchtube: launchtube ?? false };
return this.httpClient.post(`/send?network=${network}`, payload);
}
}
exports.DefindexSDK = DefindexSDK;
//# sourceMappingURL=defindex-sdk.js.map