SDK Reference

SDK Usage Guide

Installation

npm install spree-evm-sdk

Available Contract Wrappers

Wrapper	Description
SpreeVault4626	ERC-4626 compliant yield vault with harvest/rebalance
BonusRewardsVault	Epoch-based bonus reward distribution
Factory	Vault creation, mint/redeem operations
Points	ERC-20 points token with TWAB tracking
PythPriceOracle	Pyth Network price oracle integration

Initialization

import { Factory, Points } from 'spree-evm-sdk';

const factory = new Factory({
  rpcUrl: process.env.RPC_URL,           // Your chain's RPC endpoint
  chainId: BigInt(process.env.CHAIN_ID), // Your deployment chain ID
  contractAddress: process.env.FACTORY_ADDRESS as `0x${string}`,
  from: '0x...',  // Your wallet address
  defaultGasPriceWei: 1_000_000_000n,  // 1 gwei
  defaultGasLimit: 500_000n
});

Note: Contract addresses and chain configuration are provided during partner onboarding.

Common Operations

Mint SP Tokens

const unsignedTx = await factory.mint(
  process.env.ASSET_ADDRESS,  // Asset address (e.g., USDC)
  1_000_000n,                  // Amount
  receiverAddress,             // Receiver wallet
  false                        // expectedBasketMode
);

// Sign with wallet and broadcast
const signedTx = await wallet.signTransaction(unsignedTx);
const txHash = await provider.sendTransaction(signedTx);

Request Redemption

const unsignedTx = await factory.requestToRedeem(
  process.env.ASSET_ADDRESS,              // Asset address
  1_000_000_000_000_000_000_000n,         // SP amount (18 decimals)
  receiverAddress,                         // Receiver wallet
  false                                    // expectedBasketMode
);

Finalize Redemption

const unsignedTx = await factory.finalizeRedeem(userAddress);

Check Balance

const points = new Points({
  rpcUrl: process.env.RPC_URL,
  chainId: BigInt(process.env.CHAIN_ID),
  contractAddress: process.env.POINTS_ADDRESS as `0x${string}`,
  from: '0x...',
  defaultGasPriceWei: 1_000_000_000n,
  defaultGasLimit: 100_000n
});

const balance = await points.readBalanceOf(userAddress);

Gas Overrides

const tx = await factory.mint(asset, amount, receiver, false, {
  gasLimit: 300_000n,
  gasPriceWei: 2_000_000_000n,
  valueWei: 0n
});

Nonce Management

For batch transaction building:

factory.enableNonceCache();

const tx1 = await factory.mint(...);
const tx2 = await factory.requestToRedeem(...);
const tx3 = await factory.finalizeRedeem(...);

// All transactions have sequential nonces without extra RPC calls
factory.disableNonceCache();

Error Handling

import { RpcError, NetworkError } from 'spree-evm-sdk';

try {
  const tx = await factory.mint(...);
} catch (error) {
  if (error instanceof NetworkError) {
    console.error('Network issue:', error.message);
  } else if (error instanceof RpcError) {
    console.error('RPC error:', error.code, error.message);
  }
}