ordinalsbot/src/satextractor/index.ts

Node.js library for OrdinalsBot API

import { SatextractorClient } from "./client";
import { ClientOptions, InscriptionEnv, InscriptionEnvNetwork } from "../types";
import {
  SatextractorExtractRequest,
  SatextractorExtractResponse,
} from "../types/satextractor_types";

/**
 * A interface for interacting with the Satextractor API.
 */
export class Satextractor {
  /**
   * The underlying SatextractorClient instance.
   */
  private satextractorInstance!: SatextractorClient;

  /**
   * Creates a new Satextractor 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) {
    if (this.satextractorInstance !== undefined) {
      console.error("satextractor.setCredentials was called multiple times");
      return;
    }
    environment = InscriptionEnvNetwork[environment]??InscriptionEnvNetwork.mainnet;
    this.satextractorInstance = new SatextractorClient(key, environment, options);
  }

  /**
   * Extracts data using the Satextractor API.
   * @param {SatextractorExtractRequest} extractRequest - The request object for data extraction.
   * @returns {Promise<SatextractorExtractResponse>} A promise that resolves to the extraction response.
   */
  extract(
    extractRequest: SatextractorExtractRequest
  ): Promise<SatextractorExtractResponse> {
    return this.satextractorInstance.extract(extractRequest);
  }
}