Skip to content

Latest commit

 

History

History
157 lines (132 loc) · 3.69 KB

svm.md

File metadata and controls

157 lines (132 loc) · 3.69 KB

SVM Pricing API

The SVM Pricing API provides functionality to interact with price data for Solana Virtual Machine (SVM) based blockchains.

Table of Contents

Getting Started

import { Pricing, PriceType } from "@noves/noves-sdk";

// Initialize the SVM pricing client
const svmPricing = Pricing.svm("YOUR_API_KEY");

API Reference

getChains()

Returns a list of supported SVM chains.

const chains = await svmPricing.getChains();
// Returns: SVMPricingChainsResponse

Response Type: SVMPricingChainsResponse

interface SVMPricingChain {
  name: string;
  ecosystem: string;
  nativeCoin: {
    name: string;
    symbol: string;
    address: string;
    decimals: number;
  };
}

type SVMPricingChainsResponse = SVMPricingChain[];

Example response:

[
  {
    "name": "solana",
    "ecosystem": "svm",
    "nativeCoin": {
      "name": "SOL",
      "symbol": "SOL",
      "address": "SOL",
      "decimals": 9
    }
  }
]

getPrice(chain: string, tokenAddress: string, options?: {priceType?: PriceType | string, timestamp?: number})

Get the price for a token on a specified chain. Optionally include parameters for price type or timestamp.

For a full list of supported pricing strategies, see the Pricing Strategies documentation.

// Get current price for a token
const currentPrice = await svmPricing.getPrice(
  "solana",
  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v" // USDC
);

// Get historical price by timestamp
const historicalPriceByTime = await svmPricing.getPrice(
  "solana",
  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  { timestamp: 1625097600 } // July 1, 2021
);

// Get price with specific price type
const priceWithType = await svmPricing.getPrice(
  "solana",
  "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  { priceType: PriceType.DEX_HIGHEST_LIQUIDITY }
);

// Get price using weighted volume average strategy
const weightedAvgPrice = await svmPricing.getPrice(
  "solana",
  "So11111111111111111111111111111111111111112", // Wrapped SOL
  { priceType: PriceType.WEIGHTED_VOLUME_AVERAGE }
);

Parameters

  • chain (string): The chain name (e.g., "solana")
  • tokenAddress (string): The address of the token to get the price for
  • options (object): Optional parameters
    • priceType (PriceType | string): The type of price to retrieve (defaults to PriceType.DEX_HIGHEST_LIQUIDITY if not specified)
    • timestamp (number): The timestamp for which to retrieve the price

Response Format

interface SVMPricingPrice {
  chain: string;
  token: {
    address: string;
    symbol: string;
    name: string;
  };
  price: {
    amount: string;
    currency: string;
    status: string;
  };
  priceType: string;
  priceStatus: string;
}

Example response:

{
  "chain": "solana",
  "token": {
    "address": "So11111111111111111111111111111111111111112",
    "symbol": "WSOL",
    "name": "Wrapped SOL"
  },
  "price": {
    "amount": "171.3118684318626",
    "currency": "USD",
    "status": "resolved"
  },
  "priceType": "weightedVolumeAverage",
  "priceStatus": "resolved"
}

Examples

For complete examples, see the SVM Pricing Examples.

Error Handling

The SVM Pricing API can throw various errors:

  • Network-related errors when API requests fail
  • Invalid parameters or authentication errors
try {
  const price = await svmPricing.getPrice("solana", "invalid-token-address");
} catch (error) {
  console.error("API error:", error.message);
}