@coinbase/cdp-sdk
Version:
SDK for interacting with the Coinbase Developer Platform Wallet API
46 lines • 1.78 kB
TypeScript
import { CoinbaseApiClient } from "../_vendor/index.js";
/**
* Creates a `fetch`-compatible function that delegates HTTP requests to the
* configured axios instance from the legacy OpenAPI client.
*
* While the SDK is mid-migration to the new generated client, this keeps
* all HTTP requests consistent: auth headers (JWT + wallet auth), retries, and
* error handling all flow through the battle-tested `withAuth` axios interceptor
* wired up by `CdpOpenApiClient.configure()`.
*
* @returns {typeof fetch} A fetch implementation backed by the configured axios instance.
*/
export declare function createAxiosFetch(): typeof fetch;
/**
* Options for constructing a {@link VendoredClient}.
*/
export interface VendoredClientOptions {
/** The API key ID. */
apiKeyId: string;
/** The API key secret. */
apiKeySecret: string;
/** The wallet secret. */
walletSecret?: string;
/** The host URL to connect to. */
basePath?: string;
/** Whether to enable debugging. */
debugging?: boolean;
}
/**
* Middleman client that maps the {@link CdpClient} construction convention onto
* the generated `CoinbaseApiClient` configuration convention.
*
* It disables the generated client's built-in auth provider and instead routes
* all HTTP through the legacy configured axios instance (see {@link createAxiosFetch}),
* so the generated API resources are exposed without modifying any generated
* code in `_vendor` and without breaking changes.
*/
export declare class VendoredClient extends CoinbaseApiClient {
/**
* Constructs a VendoredClient.
*
* @param {VendoredClientOptions} options - The configuration options.
*/
constructor(options: VendoredClientOptions);
}
//# sourceMappingURL=vendored.d.ts.map