@renegade-fi/node/dist/types/clients/external-match/index.d.ts

Node.js library for Renegade

import type { AssembleExternalQuoteParameters, AssembleExternalQuoteReturnType, AssembleMalleableQuoteParameters, AssembleMalleableQuoteReturnType, AuthConfig, GetExternalMatchBundleParameters, GetExternalMatchBundleReturnType, GetExternalMatchQuoteParameters, GetExternalMatchQuoteReturnType, GetSupportedTokensReturnType, GetTokenPricesReturnType, RenegadeConfig, SDKConfig } from "@renegade-fi/core";
/**
 * A client for interacting with a Renegade relayer.
 *
 * Authentication is handled by providing an API key and secret.
 */
export declare class ExternalMatchClient {
    readonly config: AuthConfig;
    readonly relayerConfig: RenegadeConfig;
    readonly configv2: SDKConfig;
    readonly apiKey: string;
    readonly apiSecret: string;
    /**
     * @internal
     */
    private constructor();
    /**
     * Create a new ExternalMatchClient for a given chain.
     *
     * @param params.apiKey    your API key
     * @param params.apiSecret your API secret
     * @param params.chainId   the chain ID
     * @param params.overrides any SDKConfig field can be passed directly as an override
     */
    static new({ apiKey, apiSecret, chainId, overrides, }: {
        apiKey: string;
        apiSecret: string;
        chainId: number;
        overrides?: Partial<SDKConfig>;
    }): ExternalMatchClient;
    /**
     * Create a new ExternalMatchClient for Arbitrum One.
     *
     * @param params.apiKey    your API key
     * @param params.apiSecret your API secret
     */
    static newArbitrumOneClient({ apiKey, apiSecret, }: {
        apiKey: string;
        apiSecret: string;
    }): ExternalMatchClient;
    /**
     * Create a new ExternalMatchClient for Arbitrum Sepolia.
     *
     * @param params.apiKey    your API key
     * @param params.apiSecret your API secret
     */
    static newArbitrumSepoliaClient({ apiKey, apiSecret, }: {
        apiKey: string;
        apiSecret: string;
    }): ExternalMatchClient;
    /**
     * @deprecated use ExternalMatchClient.getQuote and ExternalMatchClient.assembleQuote instead
     */
    getExternalMatch(params: GetExternalMatchBundleParameters): Promise<GetExternalMatchBundleReturnType>;
    /**
     * Get a quote for an external match
     */
    getQuote(params: GetExternalMatchQuoteParameters): Promise<GetExternalMatchQuoteReturnType>;
    /**
     * Assemble a quote into a match bundle, ready for settlement
     */
    assembleQuote(params: AssembleExternalQuoteParameters): Promise<AssembleExternalQuoteReturnType>;
    /**
     * Assemble a quote into a malleable match bundle, ready for settlement
     */
    assembleMalleableQuote(params: AssembleMalleableQuoteParameters): Promise<AssembleMalleableQuoteReturnType>;
    /**
     * Get the list of supported tokens
     */
    getSupportedTokens(): Promise<GetSupportedTokensReturnType>;
    /**
     * Get the token prices for all supported tokens
     */
    getTokenPrices(): Promise<GetTokenPricesReturnType>;
    /**
     * Get the config for the auth server
     */
    protected getConfig(): AuthConfig;
    /**
     * Get the config for the relayer
     */
    protected getRelayerConfig(): RenegadeConfig;
}
//# sourceMappingURL=index.d.ts.map