ordinalsbot/src/launchpad/client.ts

Node.js library for OrdinalsBot API

import axios, { AxiosInstance } from "axios";
import { ClientOptions, EnvNetworkExplorer, InscriptionEnv, InscriptionEnvNetwork } from "../types";
import {
  ConfirmPaddingOutputsRequest,
  ConfirmPaddingOutputsResponse,
  CreateLaunchpadOfferRequest,
  CreateLaunchpadOfferResponse,
  CreateLaunchpadRequest,
  CreateLaunchpadResponse,
  GetAllocationRequest,
  GetAllocationResponse,
  GetListingRequest,
  GetListingResponse,
  LaunchpadMarketplaceCreateRequest,
  LaunchpadMarketplaceCreateResponse,
  SetupPaddingOutputsRequest,
  SetupPaddingOutputsResponse,
  SubmitLaunchpadOfferRequest,
  SubmitLaunchpadOfferResponse,
  GetLaunchpadStatusRequest,
  GetLaunchpadStatusResponse,
  SaveLaunchpadRequest,
  SaveLaunchpadResponse,
} from "../types/launchpad_types";
import { InscriptionError } from "../inscription/error";
import { setupL402Interceptor } from "l402";

/**
 * A client for interacting with the Launchpad marketplace API.
 */
export class LaunchpadClient {
  /**
   * The environment for the API (e.g., "testnet" , "mainnet", "signet").
   */
  public env: InscriptionEnv;

  /**
   * The API key used for authentication.
   */
  private api_key: string;

  /**
   * The Axios instance for making API requests.
   */
  private instanceV1: AxiosInstance;

  /**
   * Creates a new Launchpad instance.
   * @param {string} [key=''] - The API key for authentication.
   * @param {InscriptionEnv} [environment='mainnet'] - The environment (e.g., "testnet" , "mainnet", "signet") (optional, defaults to mainnet).
   * @param {ClientOptions} [options] - Options for enabling L402 support.
   */
  constructor(key: string = "", environment: InscriptionEnv = InscriptionEnvNetwork.mainnet, options?: ClientOptions) {
    this.api_key = key;
    environment = InscriptionEnvNetwork[environment]??InscriptionEnvNetwork.mainnet;
    this.env = environment;

    /**
     * Creates a new Axios instance with appropriate headers.
     * @returns {AxiosInstance} The new Axios instance.
     */
    const createInstance = (): AxiosInstance => {
      const headers: Record<string, string> = {
        "Content-Type": "application/json",
      };

      // Add the API key header only if this.api_key has a value
      if (this.api_key) {
        headers["x-api-key"] = this.api_key;
      }

      // Choose the base URL based on whether L402 is used or not
      const baseURL = options?.useL402
        ? "https://ordinalsbot.ln.sulu.sh/launchpad/"
        : `${EnvNetworkExplorer[this.env] || EnvNetworkExplorer.mainnet}/launchpad/`;

      // Create the Axios client with the appropriate base URL
      const client = axios.create({
        baseURL,
        headers: headers,
      });

      client.interceptors.response.use(
        ({ data }) => ("data" in data ? data.data : data),
        (err) => {
          if (axios.isAxiosError(err) && err.response?.status !== 402) { // avoid modifying L402 errors.
            throw new InscriptionError(
              err.message,
              err.response?.statusText,
              err.response?.status
            );
          }

          if (err instanceof Error) throw err;

          return err;
        }
      );

      // If L402 is enabled and configuration is provided, set up the L402 interceptor
      if (options?.useL402 && options.l402Config) {
        setupL402Interceptor(client as any, options.l402Config.wallet, options.l402Config.tokenStore);
      };

      return client;
    };

    // Create the Axios instance
    this.instanceV1 = createInstance();
  }

  /**
   * Creates a new launchpad marketplace.
   * @param {LaunchpadMarketplaceCreateRequest} createMarketplaceRequest The request body for creating a new marketplace.
   * @returns {Promise<LaunchpadMarketplaceCreateResponse>} A promise that resolves to the response from the API.
   */
  async createMarketPlace(
    createMarketplaceRequest: LaunchpadMarketplaceCreateRequest
  ): Promise<LaunchpadMarketplaceCreateResponse> {
    return this.instanceV1.post(`/create-marketplace`, {
      ...createMarketplaceRequest,
    });
  }

  /**
   * Creates a new launchpad.
   * @param {CreateLaunchpadRequest} createLaunchpadRequest The request body for creating a new launchpad.
   * @returns {Promise<CreateLaunchpadResponse>} A promise that resolves to the response from the API.
   */
  async createLaunchpad(
    createLaunchpadRequest: CreateLaunchpadRequest
  ): Promise<CreateLaunchpadResponse> {
    return this.instanceV1.post(`/create-launch`, {
      ...createLaunchpadRequest,
    });
  }

  /**
   * gets launchpad status to sign traction.
   * @param {GetLaunchpadStatusRequest} getLaunchpadStatusRequest The request body for get launchpad status.
   * @returns {Promise<GetLaunchpadStatusResponse>} A promise that resolves to the response from the API.
   */
  async getLaunchpadStatus(
    getLaunchpadStatusRequest: GetLaunchpadStatusRequest
  ): Promise<GetLaunchpadStatusResponse> {
    return this.instanceV1.get(
      `/get-launch-psbt/${getLaunchpadStatusRequest.launchpadId}`
    );
  }

  /**
   * Updated the signed psbt by the seller on the launchpad
   * @param {SaveLaunchpadRequest} saveLaunchpadRequest - The request body to update the launchpad data.
   * @returns {Promise<SaveLaunchpadResponse>} A promise that resolves to the response from the API.
   */
  async saveLaunchpad(
    saveLaunchpadRequest: SaveLaunchpadRequest
  ): Promise<SaveLaunchpadResponse> {
    return this.instanceV1.post(`/save-launch`, {
      ...saveLaunchpadRequest,
    });
  }

  /**
   * Get all the launchpad listing
   * @param {GetListingRequest} getListingRequest - The request object for get all launchpad.
   * @returns {Promise<GetListingResponse>} A promise that resolves to the response from the API.
   */
  getLaunchpadListing(
    getListingRequest: GetListingRequest
  ): Promise<GetListingResponse> {
    return this.instanceV1.post(`/get-listings`, {
      ...getListingRequest,
    });
  }

  /**
   * Get buyer launhcpad allocation
   * @param {GetAllocationRequest} getAllocationRequest - The request object for buyer launhcpad allocations.
   * @returns {Promise<GetListingResponse>} A promise that resolves to the response from the API.
   */
  getAllocation(
    getAllocationRequest: GetAllocationRequest
  ): Promise<GetAllocationResponse> {
    return new Promise(async (resolve) => {
      try {
        resolve(
          await this.instanceV1.post(`/get-allocation`, {
            ...getAllocationRequest,
          })
        );
      } catch (error) {
        resolve({ phases: [] });
      }
    });
  }

  /**
   * Confirms Padding Outputs
   * @param {ConfirmPaddingOutputsRequest} confirmPaddingOutputsRequest - The request object for confirms padding outputs
   * @returns {Promise<ConfirmPaddingOutputsResponse>} A promise that resolves to the response from the API.
   */
  async confirmPaddingOutputs(
    confirmPaddingOutputsRequest: ConfirmPaddingOutputsRequest
  ): Promise<ConfirmPaddingOutputsResponse> {
    return this.instanceV1.post(`/confirm-padding-outputs`, {
      ...confirmPaddingOutputsRequest,
    });
  }

  /**
   * Setup the padding output
   * @param {SetupPaddingOutputsRequest} setupPaddingOutputsRequest - The request object for buyer setup padding outputs.
   * @returns {Promise<SetupPaddingOutputsResponse>} A promise that resolves to the response from the API.
   */
  async setupPaddingOutputs(
    setupPaddingOutputsRequest: SetupPaddingOutputsRequest
  ): Promise<SetupPaddingOutputsResponse> {
    return this.instanceV1.post(`/setup-padding-outputs`, {
      ...setupPaddingOutputsRequest,
    });
  }

  /**
   * Creates the launchpad offer
   * @param {CreateLaunchpadOfferRequest} createLaunchpadOfferRequest - The request object for create Launchpad Offer.
   * @returns {Promise<CreateLaunchpadOfferResponse>} A promise that resolves to the response from the API.
   */
  async createLaunchpadOffer(
    createLaunchpadOfferRequest: CreateLaunchpadOfferRequest
  ): Promise<CreateLaunchpadOfferResponse> {
    return this.instanceV1.post(`/create-launch-offer`, {
      ...createLaunchpadOfferRequest,
    });
  }

  /**
   * submits the launchpad offer and gets the tansaction id
   * @param {SubmitLaunchpadOfferRequest} submitLaunchpadOfferRequest - The request object for create Launchpad Offer.
   * @returns {Promise<SubmitLaunchpadOfferResponse>} A promise that resolves to the response from the API.
   */
  async submitLaunchpadOffer(
    submitLaunchpadOfferRequest: SubmitLaunchpadOfferRequest
  ): Promise<SubmitLaunchpadOfferResponse> {
    return this.instanceV1.post(`/submit-launch-offer`, {
      ...submitLaunchpadOfferRequest,
    });
  }
}