Type Safety

The SDK is built with TypeScript and provides comprehensive type definitions.

Interfaces

import type {
  IBaseAPI,
  IBaseDataAPI,
  IZLPAPI,
  ISLPAPI,
  IUSDZAPI,
  IBaseMarketValuationInfo,
  IBaseVaultInfo,
  IBaseSymbolInfo,
  IBasePositionInfo,
  IBaseOrderInfo
} from 'zo-sdk'

// All APIs implement their respective interfaces
const zlpAPI: IZLPAPI = SDK.createZLPAPI(network, provider, apiEndpoint, connectionURL)
const slpAPI: ISLPAPI = SDK.createSLPAPI(network, provider, apiEndpoint, connectionURL)
const usdzAPI: IUSDZAPI = SDK.createUSDZAPI(network, provider, apiEndpoint, connectionURL)

// Type-safe data: call data methods directly on the API or via .dataAPI
const marketInfo: IBaseMarketValuationInfo = await zlpAPI.valuateMarket()
const vaultInfo: IBaseVaultInfo = await zlpAPI.getVaultInfo('usdc')

Last updated