Documentation
Comprehensive guides, API references, and examples to help you integrate with Xayerium Protocol
Quick Start
Get up and running with Xayerium in minutes
Categories
Installation
Install via npm
npm install @xayerium/sdkEnvironment Setup
Configure your environment variables to connect to Xayerium Protocol
XAYERIUM_RPC_URL=https://api.xayerium.com
XAYERIUM_PROGRAM_ID=XYR...
SOLANA_NETWORK=mainnet-betaProtocol Architecture
Xayerium is built on three integrated layers that work together to deliver sustainable real yield through network-level utility.
Execution Layer
Handles transaction routing, execution optimization, and cross-program composability. This layer ensures efficient execution of user transactions while maintaining MEV resistance.
await xayerium.execute(transaction, options)Liquidity Layer
Manages shared liquidity pools with adaptive routing and fee capture mechanisms. Protocols can access deep liquidity while liquidity providers earn real yield from usage fees.
await xayerium.addLiquidity(pool, amount)Infrastructure Layer
Provides developer SDKs, on-chain program interfaces, and API endpoints for seamless ecosystem integration. Built with TypeScript for type safety and developer experience.
const client = new XayeriumClient(config)Protocol APIs
Core Methods
initialize()Initialize the Xayerium client with your configuration
execute()Execute transactions through the protocol's execution layer
addLiquidity()Add liquidity to protocol pools and start earning yield
removeLiquidity()Remove liquidity from pools and claim accrued fees
stake()Stake XYR tokens to participate in protocol governance
getMetrics()Fetch real-time protocol metrics and analytics
First Integration
Basic Usage Example
import { XayeriumClient } from '@xayerium/sdk'
// Initialize the client
const client = new XayeriumClient({
network: 'mainnet-beta',
rpcUrl: process.env.XAYERIUM_RPC_URL
})
// Connect wallet
await client.connect(wallet)
// Add liquidity to SOL/USDC pool
const tx = await client.addLiquidity({
pool: 'SOL/USDC',
amountA: 100, // SOL
amountB: 10000 // USDC
})
console.log('Liquidity added:', tx.signature)Security
Security Best Practices
- •Always verify transaction details before signing
- •Use hardware wallets for production environments
- •Implement rate limiting for API calls
- •Never expose private keys or seed phrases
- •Keep your SDK version up to date