API Reference

Factory methods

API (full – transactions + data):

  • SDK.createZLPAPI(network, provider, apiEndpoint, connectionURL)

  • SDK.createSLPAPI(network, provider, apiEndpoint, connectionURL)

  • SDK.createUSDZAPI(network, provider, apiEndpoint, connectionURL)

  • SDK.createAPI(LPToken, network, provider, apiEndpoint, connectionURL)

DataAPI (read-only):

  • SDK.createZLPDataAPI(network, provider, apiEndpoint, connectionURL)

  • SDK.createSLPDataAPI(network, provider, apiEndpoint, connectionURL)

  • SDK.createUSDZDataAPI(network, provider, apiEndpoint, connectionURL)

  • SDK.createDataAPI(LPToken, network, provider, apiEndpoint, connectionURL)

Interfaces

  • Base: IBaseAPI, IBaseDataAPI for common operations

  • LP-specific: IZLPAPI, ISLPAPI, IUSDZAPI for typed usage

  • Data types: IBaseMarketValuationInfo, IBaseVaultInfo, IBaseSymbolInfo, IBasePositionInfo, IBaseOrderInfo, etc.

Source code

  • Interfaces: src/interfaces/ – TypeScript interface definitions

  • Implementations: src/implementations/ – Concrete API implementations

  • Abstract classes: src/abstract/ – Shared base functionality

  • Factory: src/factory/SDKFactory.ts – SDK instance creation

See the type definitions and source for detailed method signatures and parameters.

Last updated