VELYS SDK

Installation

npm install @velys/sdk
# or
yarn add @velys/sdk
# or
pnpm add @velys/sdk

Install the VELYS SDK package using your preferred package manager.

Quick Start

import { VelysClient } from "@velys/sdk";
import { Connection, PublicKey } from "@solana/web3.js";

// Initialize connection
const connection = new Connection(
  "https://api.mainnet-beta.solana.com",
  "confirmed"
);

// Create VELYS client
const velys = new VelysClient({
  connection,
  wallet: yourWalletAdapter,
  programId: new PublicKey("VELYS_PROGRAM_ID")
});

// Stake SOL and receive vSOL (liquid staking tokens)
const stakeResult = await velys.stake({
  amount: 10, // Amount in SOL
  userPublicKey: wallet.publicKey,
});

console.log("Staked successfully:", stakeResult.signature);
console.log("vSOL received:", stakeResult.vSolAmount);

// Get user's staking position
const stakingInfo = await velys.getStakingInfo(
  wallet.publicKey
);

console.log("Staked amount:", stakingInfo.stakedAmount);
console.log("vSOL balance:", stakingInfo.vSolBalance);
console.log("Current APY:", stakingInfo.apy);
console.log("Claimable rewards:", stakingInfo.rewards);

// vSOL tokens can be used across DeFi protocols
// Example: Provide liquidity on DEX
const liquidity = await velys.integrations.dex.addLiquidity({
  tokenA: velys.vSolMint,
  tokenB: USDC_MINT,
  amountA: 5, // 5 vSOL
  amountB: 500, // 500 USDC
});

// Example: Use as collateral
const collateral = await velys.integrations.lending.deposit({
  mint: velys.vSolMint,
  amount: 10,
});

// Request unstaking (may have cooldown period)
const unstakeResult = await velys.unstake({
  amount: 5, // Amount of vSOL to unstake
  userPublicKey: wallet.publicKey,
});

console.log("Unstake initiated:", unstakeResult.signature);
console.log("Cooldown period:", unstakeResult.cooldownPeriod);

// Claim unstaked SOL after cooldown
const claimResult = await velys.claimUnstaked({
  userPublicKey: wallet.publicKey,
});

// Subscribe to staking events
velys.onStakeEvent((event) => {
  console.log("Stake event:", event);
});

velys.onUnstakeEvent((event) => {
  console.log("Unstake event:", event);
});

velys.onRewardEvent((event) => {
  console.log("Reward distributed:", event);
});

Key Features

Best Practices

• •

  Always handle errors gracefully

  Wrap SDK calls in try-catch blocks and provide user-friendly error messages.

• •

  Verify transaction signatures

  Always confirm transactions on-chain before updating your UI state.

• •

  Use appropriate RPC endpoints

  For production apps, use dedicated RPC providers for better reliability and performance.

• •

  Implement proper wallet handling

  Support multiple wallet adapters and handle connection/disconnection events properly.

• •

  Cache data appropriately

  Use caching strategies to reduce RPC calls while maintaining data freshness.

Resources