HYSP Vault (Solana)

Learn how to connect HYSP vaults on Solana through Everstake Wallet SDK.

Getting Started

The HYSP Solana SDK provides a simple interface for interacting with yield vaults on Solana. It includes read helpers (APY/holdings/price-per-share, balances) and prepares unsigned transactions for deposits and withdrawals.

Installation

npm install @everstake/wallet-sdk-hysp-solana

Quick Start

import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';
import { address } from '@solana/kit';
import { Decimal } from 'decimal.js';

// Initialize with token symbol
const hysp = new HyspSolana('USDC');

// Or with custom RPC
const hyspCustom = new HyspSolana('USDC', 'https://your-rpc-endpoint.com');

// User address
const userAddress = address('YourWalletAddressHere');

// Get vault information
const holdings = await hysp.getVaultHoldings();
const apys = await hysp.getVaultAPYs();

// Create deposit transaction (unsigned)
const depositTx = await hysp.deposit(userAddress, new Decimal('100'));

// Create withdraw transaction (unsigned)
const withdrawTx = await hysp.withdraw(userAddress, new Decimal('50'));

The SDK returns unsigned transactions; your application is responsible for signing and sending them.

Available Methods

Below are the primary methods exposed by the SDK, with short descriptions to help you choose the right call in your flow

Information Methods

• getVaultHoldings()— Returns vault assets/positions to help with monitoring and display.

• getVaultAPYs() — Fetches current APY data for the vault.

• getExchangeRate() — Returns the tokens-per-share (price-per-share) used to convert shares ↔︎ token amount.

• getUserShares() — Retrieves a user’s raw share balance in the vault.

• getUserBalance() — Convenience helper that multiplies shares × price-per-share for a user-displayable token balance.

Transaction Methods

• deposit() — Builds an unsigned deposit transaction message; sign and broadcast in your app.

• withdraw() — Builds an unsigned withdraw (redemption) transaction message; sign and broadcast in your app.

• Adding Custom Instructions — You can also compose multiple operations by appending additional instructions in your own code to create atomic, single-transaction flows (e.g., withdraw then transfer).

---

Get Exchange Rate

The getExchangeRate() method retrieves the current tokens-per-share (price-per-share) for the vault. Use it to convert between shares and the display token amount.

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Fetch exchange rate
const exchangeRate = await hysp.getExchangeRate();
console.log(exchangeRate); // { result: Decimal }

Calculate Token Value

import { address } from '@solana/kit';

const userAddress = address('YourWalletAddressHere');

// Get shares and exchange rate
const userShares   = await hysp.getUserShares(userAddress);
const exchangeRate = await hysp.getExchangeRate();

// Calculate token value (shares × price-per-share)
const tokenValue = userShares.result.mul(exchangeRate.result);
console.log(tokenValue); // Decimal

Tip: To skip manual math, use getUserBalance(), which returns the display token balance directly.

---

Get User Shares

The getUserShares() method returns the user’s raw vault share balance (receipt token). Use this when you need the underlying share amount; to display token value, either multiply by the exchange rate or call getUserBalance().

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';
import { address } from '@solana/kit';

// User wallet address
const userAddress = address('YourWalletAddressHere');

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Fetch raw share balance
const userShares = await hysp.getUserShares(userAddress);
console.log(userShares); // { result: Decimal }

Note: getUserShares() returns shares, not the token value.

Use getExchangeRate() to convert, or call getUserBalance() to get the display token amount directly.

---

Get User Balance

The getUserBalance() method returns the user’s display token balance (shares × price-per-share).

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';
import { address } from '@solana/kit';

// User wallet address
const userAddress = address('YourWalletAddressHere');

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Fetch USDC balance
const userBalance = await hysp.getUserBalance(userAddress);
console.log(userBalance); // { result: Decimal }

See also: getUserShares() and getExchangeRate() if you need raw shares or the conversion rate.

---

Get Vault APYs

The getVaultAPYs() method retrieves the vault’s yield / APY information as exposed by the underlying venue.

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Fetch APY data
const apyData = await hysp.getVaultAPYs();
console.log(apyData); // { result: APY }

Notes: The returned APY shape is defined by the venue SDK and includes the current APY the vault reports.

---

Get Vault Holdings

The getVaultHoldings() method returns a snapshot of the vault’s current assets/performance metrics and related fields as defined by the venue’s VaultHoldings type.

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Fetch holdings snapshot
const holdings = await hysp.getVaultHoldings();
console.log(holdings); // { result: VaultHoldings }

---

Get Vault Liquidity Amount

The getVaultLiquidityAmount() method retrieves the current available liquidity in the vault.

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';

// Create SDK instance
const hysp = new HyspSolana('USDC');

const liquidity = await hysp.getVaultLiquidityAmount();
console.log(liquidity); // { result: Decimal }

---

Get Vault Liquidity Amount

The getVaultLiquidityAmount() method retrieves the current available liquidity in reserves.

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';

// Create SDK instance
const hysp = new HyspSolana('USDC');

const liquidity = await hysp.getVaultLiquidityAmount();
console.log(liquidity); // { result: Decimal }

---

Deposit

The deposit() method builds an unsigned transaction to deposit tokens into a vault. Your app is responsible for signing and sending the returned transaction message.

Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';
import { address } from '@solana/kit';
import { Decimal } from 'decimal.js';

// User wallet address
const userAddress = address('YourWalletAddressHere');

// The amount to deposit (100 USDC)
const amount = new Decimal('100');

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Build unsigned deposit transaction
const depositTx = await hysp.deposit(userAddress, amount);
console.log(depositTx); // { result: TransactionMessage }

---

Withdraw

The withdraw() method creates a transaction to withdraw tokens from a vault by burning shares.

Withdraw Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';
import { address } from '@solana/kit';
import { Decimal } from 'decimal.js';

// User wallet address
const userAddress = address('YourWalletAddressHere');

// The amount of shares to withdraw
const sharesAmount = new Decimal('50');

// Create SDK instance
const hysp = new HyspSolana('USDC');

const withdrawTx = await hysp.withdraw(userAddress, sharesAmount);
console.log(withdrawTx); // { result: TransactionMessage }

Withdraw All Shares Code Example

// Get user's current shares
const userShares = await hysp.getUserShares(userAddress);

// Withdraw all shares
const withdrawTx = await hysp.withdraw(userAddress, userShares.result);

---

Add Custom Instructions

The deposit() and withdraw() methods support adding custom Solana instructions via the afterInstructions parameter. This lets you compose atomic flows (e.g., withdraw then transfer USDC) in a single transaction.

Withdraw and Transfer Code Example

// Import SDK
import { HyspSolana } from '@everstake/wallet-sdk-hysp-solana';
import { address } from '@solana/kit';
import {
  findAssociatedTokenPda,
  getTransferInstruction,
  TOKEN_PROGRAM_ADDRESS,
} from '@solana-program/token';

// User and recipient addresses
const userAddress = address('YourWalletAddressHere');
const recipientAddress = address('RecipientAddressHere');

// Token mint (USDC)
const USDC_MINT = address('EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v');

// Create SDK instance
const hysp = new HyspSolana('USDC');

// Find token accounts
const [fromTokenAccount] = await findAssociatedTokenPda({
  owner: userAddress,
  mint: USDC_MINT,
  tokenProgram: TOKEN_PROGRAM_ADDRESS,
});

const [toTokenAccount] = await findAssociatedTokenPda({
  owner: recipientAddress,
  mint: USDC_MINT,
  tokenProgram: TOKEN_PROGRAM_ADDRESS,
});

// Create transfer instruction
const transferInstruction = getTransferInstruction({
  source: fromTokenAccount,
  destination: toTokenAccount,
  authority: userAddress,
  amount: 1_000000n, // 1 USDC (6 decimals)
});

// Withdraw with transfer
const withdrawTx = await hysp.withdraw(
  userAddress,
  1, // shares amount
  {
    afterInstructions: [transferInstruction],
  },
);

console.log(withdrawTx); // { result: TransactionMessage }

Multiple Instructions

const depositTx = await hysp.deposit(
  userAddress,
  '100',
  {
    afterInstructions: [
      instruction1,
      instruction2,
      instruction3,
    ],
  },
);