forex-engine-sdk-typescript

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

Summary

Fx Oracle Service API: HTTP API for prices, enriched market data, positions, orders, collateral, stats, and websocket streaming used by FxOracleClient.

Table of Contents

• @paxeer-network/forex-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/forex-engine-sdk-typescript

PNPM

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

Bun

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

Yarn

yarn add @paxeer-network/forex-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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

const fxOracleServiceApi = new FxOracleServiceApi();

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

  console.log(result);
}

run();

Available Resources and Operations

FxOracleServiceApi SDK

• getHealth - Service health
• getPrices - All current prices
• getPricesSymbol - Price for a symbol
• getEnriched - Prices with enriched market data
• getEnrichedSymbol - Enriched data for a symbol
• getMarketDataSymbol - Real-time market data for a symbol
• postMarketDataBatch - Batch market data
• getApiPositionsOpen - Open positions
• getApiPositionsAccountAddress - Positions by account
• getApiPositionsMarketMarketId - Positions by market
• getApiOrdersRecent - Recent orders
• getApiOrdersAccountAddress - Orders by account
• getApiCollateralAccountAddress - Collateral events for account
• getApiStatsAccountAddress - Account statistics
• getApiLeaderboard - Trader leaderboard
• getApiStatsMarkets - Market stats
• getApiStatsSystem - System metrics
• getApiStatsSummary - Dashboard summary
• getWs - WebSocket upgrade for real-time price and enriched data

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.

• getApiCollateralAccountAddress - Collateral events for account
• getApiLeaderboard - Trader leaderboard
• getApiOrdersAccountAddress - Orders by account
• getApiOrdersRecent - Recent orders
• getApiPositionsAccountAddress - Positions by account
• getApiPositionsMarketMarketId - Positions by market
• getApiPositionsOpen - Open positions
• getApiStatsAccountAddress - Account statistics
• getApiStatsMarkets - Market stats
• getApiStatsSummary - Dashboard summary
• getApiStatsSystem - System metrics
• getEnriched - Prices with enriched market data
• getEnrichedSymbol - Enriched data for a symbol
• getHealth - Service health
• getMarketDataSymbol - Real-time market data for a symbol
• getPrices - All current prices
• getPricesSymbol - Price for a symbol
• getWs - WebSocket upgrade for real-time price and enriched data
• postMarketDataBatch - Batch market data

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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

const fxOracleServiceApi = new FxOracleServiceApi();

async function run() {
  const result = await fxOracleServiceApi.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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

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

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

  console.log(result);
}

run();

Error Handling

FxOracleServiceAPIError 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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";
import * as errors from "@paxeer-network/forex-engine-sdk-typescript/models/errors";

const fxOracleServiceApi = new FxOracleServiceApi();

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

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

run();

Error Classes

Primary error:

• FxOracleServiceAPIError: 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 FxOracleServiceAPIError:

• 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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

const fxOracleServiceApi = new FxOracleServiceApi({
  serverURL: "https://api.fx-oracle.example",
});

async function run() {
  const result = await fxOracleServiceApi.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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";
import { HTTPClient } from "@paxeer-network/forex-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 FxOracleServiceApi({ 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 { FxOracleServiceApi } from "@paxeer-network/forex-engine-sdk-typescript";

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