sideshift-node-sdk/dist/api/public/coins.d.ts

TypeScript Client for SideShift.ai API

import { SideShiftHttpHandler } from '../sideShiftHttpClient';
import { ApiResponse, Coin } from '../../types';
export declare class CoinsAPI {
    private sideShiftHttpHandler;
    constructor(sideShiftHttpHandler: SideShiftHttpHandler);
    /**
     * Returns the list of coins and their respective networks available on SideShift.ai.
     *
     * Note: The fields fixedOnly, variableOnly, depositOffline, settleOffline will
     * return false if false for every network. true for single network assets
     * and an array of networks for mixed.
     *
     * @see https://docs.sideshift.ai/endpoints/v2/coins
     * @returns Promise<ApiResponse<Coin[]>>
     */
    getCoins(): Promise<ApiResponse<Coin[]>>;
    /**
     * Returns the icon of the coin in svg or png format.
     * @see https://docs.sideshift.ai/endpoints/v2/coinicon
     *
     * @param coinNetwork - The coin-network. Network can be ommitted (e.g., 'btc-mainnet' or 'btc')
     * @returns Promise<ApiResponse<string>>
     */
    getCoinIcon(coinNetwork: string): Promise<ApiResponse<string>>;
}