market-launchpad-sdk-typescript

Developer-friendly, idiomatic Typescript SDK for the market-launchpad-sdk-typescript API.

Summary

Launchpad Backend API: REST + TradingView UDF + WebSocket endpoints for Launchpad virtual markets (pricing, discovery, users, metadata). Based on /root/launchpad_backend docs.

Table of Contents

• @paxeer-network/market-launchpad-sdk-typescript
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • File uploads
  • 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/market-launchpad-sdk-typescript

PNPM

pnpm add @paxeer-network/market-launchpad-sdk-typescript

Bun

bun add @paxeer-network/market-launchpad-sdk-typescript

Yarn

yarn add @paxeer-network/market-launchpad-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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";

const launchpadApi = new LaunchpadApi();

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

  console.log(result);
}

run();

Available Resources and Operations

LaunchpadApi SDK

• getHealth - Health check
• getApiV1Markets - List markets
• getApiV1MarketsAddress - Get market with metadata and stats
• getApiV1MarketsAddressStats - Market statistics
• getApiV1MarketsAddressTrades - Market trade history
• getApiV1MarketsAddressCandles - Market OHLCV candles
• getApiV1MarketsAddressLiquidations - Liquidation history
• getApiV1Search - Search markets
• getApiV1MarketsNew - Newest markets
• getApiV1MarketsHot - Hot markets
• getApiV1MarketsGainers - Top gainers
• getApiV1MarketsLosers - Top losers
• getApiV1UsersAddressPositions - User positions
• getApiV1UsersAddressTrades - User trades
• getApiV1UsersAddressBalances - User balances
• getApiV1CreatorsAddressMarkets - Markets created by address
• postApiV1MarketsMetadata - Submit market metadata (multipart)
• getApiV1MarketsAddressMetadata - Get market metadata
• putApiV1MarketsAddressMetadata - Update market metadata (multipart, creator)
• getTvConfig - TradingView config
• getTvTime - Server time (unix seconds)
• getTvSymbols - TradingView symbol info
• getTvSearch - TradingView search
• getTvHistory - TradingView history
• getWs - WebSocket upgrade

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.

• getApiV1CreatorsAddressMarkets - Markets created by address
• getApiV1Markets - List markets
• getApiV1MarketsAddress - Get market with metadata and stats
• getApiV1MarketsAddressCandles - Market OHLCV candles
• getApiV1MarketsAddressLiquidations - Liquidation history
• getApiV1MarketsAddressMetadata - Get market metadata
• getApiV1MarketsAddressStats - Market statistics
• getApiV1MarketsAddressTrades - Market trade history
• getApiV1MarketsGainers - Top gainers
• getApiV1MarketsHot - Hot markets
• getApiV1MarketsLosers - Top losers
• getApiV1MarketsNew - Newest markets
• getApiV1Search - Search markets
• getApiV1UsersAddressBalances - User balances
• getApiV1UsersAddressPositions - User positions
• getApiV1UsersAddressTrades - User trades
• getHealth - Health check
• getTvConfig - TradingView config
• getTvHistory - TradingView history
• getTvSearch - TradingView search
• getTvSymbols - TradingView symbol info
• getTvTime - Server time (unix seconds)
• getWs - WebSocket upgrade
• postApiV1MarketsMetadata - Submit market metadata (multipart)
• putApiV1MarketsAddressMetadata - Update market metadata (multipart, creator)

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";

const launchpadApi = new LaunchpadApi();

async function run() {
  const result = await launchpadApi.postApiV1MarketsMetadata({
    marketAddress: "<value>",
    creatorAddress: "<value>",
    signature: "<value>",
  });

  console.log(result);
}

run();

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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";

const launchpadApi = new LaunchpadApi();

async function run() {
  const result = await launchpadApi.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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";

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

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

  console.log(result);
}

run();

Error Handling

LaunchpadAPIError 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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";
import * as errors from "@paxeer-network/market-launchpad-sdk-typescript/models/errors";

const launchpadApi = new LaunchpadApi();

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

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

run();

Error Classes

Primary error:

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

• 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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";

const launchpadApi = new LaunchpadApi({
  serverURL: "https://v1api.paxlaunch.paxswap.org",
});

async function run() {
  const result = await launchpadApi.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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";
import { HTTPClient } from "@paxeer-network/market-launchpad-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 LaunchpadApi({ 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 { LaunchpadApi } from "@paxeer-network/market-launchpad-sdk-typescript";

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