@coinbase/cdp-sdk/_types/actions/Quote.d.ts

SDK for interacting with the Coinbase Developer Platform Wallet API

import { FundOperationResult } from "./types.js";
import { CdpOpenApiClientType } from "../openapi-client/index.js";
/**
 * Base class representing a funding quote that can be executed.
 */
declare abstract class BaseQuote {
    /** Quote for the transfer. */
    quoteId: string;
    /** The amount in fiat currency. */
    fiatAmount: string;
    /** The fiat currency. */
    fiatCurrency: string;
    /** The amount in the token to transfer. */
    tokenAmount: string;
    /** The token to transfer. */
    token: string;
    /** Fees in the token to transfer. */
    fees: {
        /** The type of fee. */
        type: "exchange_fee" | "network_fee";
        amount: string;
        currency: string;
    }[];
    protected apiClient: CdpOpenApiClientType;
    /**
     * Creates a new BaseQuote instance.
     *
     * @param apiClient - The API client.
     * @param quoteId - The quote ID.
     * @param fiatAmount - The amount in fiat currency.
     * @param fiatCurrency - The fiat currency.
     * @param tokenAmount - The amount in the token to transfer.
     * @param token - The token to transfer.
     * @param fees - Fees for the transfer.
     */
    constructor(apiClient: CdpOpenApiClientType, quoteId: string, fiatAmount: string, fiatCurrency: string, tokenAmount: string, token: string, fees: {
        type: "exchange_fee" | "network_fee";
        amount: string;
        currency: string;
    }[]);
    /**
     * Executes the quote to perform the actual fund transfer.
     *
     * @returns A promise that resolves to the result of the executed quote.
     */
    execute(): Promise<FundOperationResult>;
}
/**
 * A class representing an EVM funding quote that can be executed.
 */
export declare class EvmQuote extends BaseQuote {
    /** Network to transfer the funds to (EVM networks). */
    network: "base" | "ethereum";
    /**
     * Creates a new EvmQuote instance.
     *
     * @param apiClient - The API client.
     * @param quoteId - The quote ID.
     * @param network - The EVM network to transfer funds to.
     * @param fiatAmount - The amount in fiat currency.
     * @param fiatCurrency - The fiat currency.
     * @param tokenAmount - The amount in the token to transfer.
     * @param token - The token to transfer.
     * @param fees - Fees for the transfer.
     */
    constructor(apiClient: CdpOpenApiClientType, quoteId: string, network: "base" | "ethereum", fiatAmount: string, fiatCurrency: string, tokenAmount: string, token: string, fees: {
        type: "exchange_fee" | "network_fee";
        amount: string;
        currency: string;
    }[]);
}
/**
 * A class representing a Solana funding quote that can be executed.
 */
export declare class SolanaQuote extends BaseQuote {
    /** Network to transfer the funds to (Solana). */
    network: "solana";
    /**
     * Creates a new SolanaQuote instance.
     *
     * @param apiClient - The API client.
     * @param quoteId - The quote ID.
     * @param network - The Solana network to transfer funds to.
     * @param fiatAmount - The amount in fiat currency.
     * @param fiatCurrency - The fiat currency.
     * @param tokenAmount - The amount in the token to transfer.
     * @param token - The token to transfer.
     * @param fees - Fees for the transfer.
     */
    constructor(apiClient: CdpOpenApiClientType, quoteId: string, network: "solana", fiatAmount: string, fiatCurrency: string, tokenAmount: string, token: string, fees: {
        type: "exchange_fee" | "network_fee";
        amount: string;
        currency: string;
    }[]);
}
export {};
//# sourceMappingURL=Quote.d.ts.map