options-engine-sdk-typescript

Developer-friendly, idiomatic Typescript SDK for the options-engine-sdk-typescript API.

Summary

Options Oracle API: REST endpoints for prices, assets, options, chains, positions, orders, trades, collateral, and stats used by OptionsApiClient. Base URL: https://options.api.market.paxportwallet.com

Table of Contents

• @paxeer-network/options-engine-sdk-typescript
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @paxeer-network/options-engine-sdk-typescript

PNPM

pnpm add @paxeer-network/options-engine-sdk-typescript

Bun

bun add @paxeer-network/options-engine-sdk-typescript

Yarn

yarn add @paxeer-network/options-engine-sdk-typescript zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";

const optionsOracleApi = new OptionsOracleApi();

async function run() {
  const result = await optionsOracleApi.getHealth();

  console.log(result);
}

run();

Available Resources and Operations

OptionsOracleApi SDK

• getHealth - Health check
• getApiStatus - Indexer sync status
• getApiPrices - All latest prices
• getApiPricesAssetId - Latest price for asset
• getApiPricesAssetIdHistory - Price history for asset
• getApiAssets - Registered assets
• getApiTokens - Token listings
• getApiOptions - Options list
• getApiOptionsOptionId - Option by ID
• getApiChain - Options chain for assets
• getApiChainAssetId - Options chain for asset
• getApiPositions - Positions
• getApiOrders - Orders
• getApiTrades - Trades
• getApiCollateralAccount - Collateral events for account
• getApiStats - Trading statistics
• getApiStatsVolume - 24h volume by asset

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• getApiAssets - Registered assets
• getApiChain - Options chain for assets
• getApiChainAssetId - Options chain for asset
• getApiCollateralAccount - Collateral events for account
• getApiOptions - Options list
• getApiOptionsOptionId - Option by ID
• getApiOrders - Orders
• getApiPositions - Positions
• getApiPrices - All latest prices
• getApiPricesAssetId - Latest price for asset
• getApiPricesAssetIdHistory - Price history for asset
• getApiStats - Trading statistics
• getApiStatsVolume - 24h volume by asset
• getApiStatus - Indexer sync status
• getApiTokens - Token listings
• getApiTrades - Trades
• getHealth - Health check

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";

const optionsOracleApi = new OptionsOracleApi();

async function run() {
  const result = await optionsOracleApi.getHealth({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";

const optionsOracleApi = new OptionsOracleApi({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await optionsOracleApi.getHealth();

  console.log(result);
}

run();

Error Handling

OptionsOracleAPIError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | ------------------------------------------------------ | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response |

Example

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";
import * as errors from "@paxeer-network/options-engine-sdk-typescript/models/errors";

const optionsOracleApi = new OptionsOracleApi();

async function run() {
  try {
    const result = await optionsOracleApi.getHealth();

    console.log(result);
  } catch (error) {
    if (error instanceof errors.OptionsOracleAPIError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• OptionsOracleAPIError: The base class for HTTP error responses.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from OptionsOracleAPIError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";

const optionsOracleApi = new OptionsOracleApi({
  serverURL: "https://options.api.market.paxportwallet.com",
});

async function run() {
  const result = await optionsOracleApi.getHealth();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";
import { HTTPClient } from "@paxeer-network/options-engine-sdk-typescript/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new OptionsOracleApi({ httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { OptionsOracleApi } from "@paxeer-network/options-engine-sdk-typescript";

const sdk = new OptionsOracleApi({ debugLogger: console });