@barfinex/types/dist/provider.interface.d.ts

Shared TypeScript interfaces for Barfinex — an open-source standard for digital asset trading by Barfin Network.

import { Account } from "./account.interface";
import { Connector } from "./connector.interface";
import { Detector } from "./detector.interface";
/**
 * Interface representing the configuration options for a provider.
 * This defines the necessary settings to establish and manage connections
 * to external services or APIs.
 */
export interface Provider {
    /**
     * A unique key
     */
    key: string;
    /**
     * API token used for authentication with the provider's services.
     * This ensures secure access to the provider's API endpoints.
     */
    restApiToken: string;
    /**
 * Base URL of the provider's API.
 * This is the endpoint where all API requests will be sent.
 */
    restApiUrl: string;
    /**
     * Array of connector configurations.
     * Each connector defines how to interact with a specific external service or data source.
     */
    connectors?: Connector[];
    detectors?: Detector[];
    accounts: Account[];
    isAvailable?: boolean;
    studioGuid?: string;
    studioName?: string;
    studioDescription?: string;
    studioSocketApiUrl?: string;
}