coinbase-api 0.3.2 → 1.0.1

package/dist/cjs/types/websockets/client.d.ts

@@ -0,0 +1,73 @@
+/** General configuration for the WebsocketClient */
+export interface WSClientConfigurableOptions {
+    /**
+     * Your API key name.
+     *
+     * - For the Advanced Trade or App APIs, this is your API Key Name.
+     */
+    apiKey?: string;
+    /**
+     * Your API key secret.
+     *
+     * - For the Advanced Trade or App APIs, this is your API private key (including the -----BEGIN EC PRIVATE KEY-----\n etc).
+     */
+    apiSecret?: string;
+    /**
+     * Your API passphrase (NOT your account password). Only used for the API groups that use an API passphrase:
+     * - Coinbase Exchange API
+     * - Coinbase International API
+     * - Coinbase Prime API
+     */
+    apiPassphrase?: string;
+    /**
+     * For JWT auth (adv trade & app API), seconds until jwt expires. Defaults to 120 seconds.
+     */
+    jwtExpiresSeconds?: number;
+    /** How often to check if the connection is alive */
+    pingInterval?: number;
+    /** How long to wait for a pong (heartbeat reply) before assuming the connection is dead */
+    pongTimeout?: number;
+    /** Delay in milliseconds before respawning the connection */
+    reconnectTimeout?: number;
+    wsUrl?: string;
+    /**
+     * Connect to the sandbox for supported products
+     *
+     * - Coinbase Exchange: https://docs.cdp.coinbase.com/exchange/docs/sandbox
+     * - Coinbase International: https://docs.cdp.coinbase.com/intx/docs/sandbox
+     *
+     * - Coinbase App: No sandbox available.
+     * - Coinbase Advanced Trade: No sandbox available.
+     * - Coinbase Prime: No sandbox available.
+     */
+    useSandbox?: boolean;
+    /**
+     * Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
+     *
+     * Look in the examples folder for a demonstration on using node's createHmac instead.
+     */
+    customSignMessageFn?: (message: string, secret: string) => Promise<string>;
+    /**
+     * If you authenticated the WS API before, automatically try to re-authenticate the WS API if you're disconnected/reconnected for any reason.
+     */
+    reauthWSAPIOnReconnect?: boolean;
+}
+/**
+ * WS configuration that's always defined, regardless of user configuration
+ * (usually comes from defaults if there's no user-provided values)
+ */
+export interface WebsocketClientOptions extends WSClientConfigurableOptions {
+    pingInterval: number;
+    pongTimeout: number;
+    reconnectTimeout: number;
+    useSandbox: boolean;
+    recvWindow: number;
+    /**
+     * If true, require a "receipt" that the connection is ready for use (e.g. a specific event type)
+     */
+    requireConnectionReadyConfirmation: boolean;
+    authPrivateConnectionsOnConnect: boolean;
+    authPrivateRequests: boolean;
+    reauthWSAPIOnReconnect: boolean;
+}
+export type WsMarket = 'advancedTrade' | 'exchange' | 'international' | 'prime';

package/dist/cjs/types/websockets/client.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=client.js.map

package/dist/cjs/types/websockets/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../../src/types/websockets/client.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/events.d.ts

@@ -0,0 +1,40 @@
+import { WS_KEY_MAP } from '../../lib/websocket/websocket-util.js';
+export interface WsDataEvent<TData = any, TWSKey = string> {
+    data: TData;
+    table: string;
+    wsKey: TWSKey;
+}
+/**
+ * General event structure for events from the advanced trade websocket
+ */
+export interface CBAdvancedTradeEvent {
+    channel: string;
+    client_id: string;
+    timestamp: string;
+    sequence_num: number;
+    events: Record<'subscriptions', Record<string, string[]>>;
+}
+export interface CBAdvancedTradeErrorEvent {
+    type: 'error';
+    message: string;
+    wsKey: typeof WS_KEY_MAP.advTradeMarketData | typeof WS_KEY_MAP.advTradeUserData;
+}
+/**
+ * General event structure for events from the Coinbase Exchange websocket.
+ * All Coinbase Exchange events extend this schema.
+ */
+export interface CBExchangeBaseEvent {
+    type: 'subscriptions' | string;
+    wsKey: typeof WS_KEY_MAP.exchangeMarketData | typeof WS_KEY_MAP.exchangeDirectMarketData;
+}
+/**
+ * Sent after subscribing to one or more channels
+ */
+export type CBExchangeSubscriptionsEvent = CBExchangeBaseEvent & {
+    type: 'subscriptions';
+    channels?: {
+        name: string;
+        product_ids: string[];
+        account_ids: null;
+    }[];
+};

package/dist/cjs/types/websockets/events.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=events.js.map

package/dist/cjs/types/websockets/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../../../src/types/websockets/events.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/requests.d.ts

@@ -0,0 +1,76 @@
+export type WsOperation = 'subscribe' | 'unsubscribe';
+/**
+ * This is the format used for commands sent upstream for this websocket connection.
+ *
+ * Docs:
+ * - Adv Trade: https://docs.cdp.coinbase.com/advanced-trade/docs/ws-auth#subscribing
+ */
+export interface WsAdvTradeRequestOperation<TWSTopic extends string = string> {
+    type: WsOperation;
+    channel: TWSTopic;
+    product_ids?: string[];
+    jwt?: string;
+}
+export interface WsExchangeChannelWithParams<TWSTopic extends string = string> {
+    name: TWSTopic;
+    product_ids: string[];
+}
+/**
+ * Public subscribe/unsubscribe requests for the Coinbase Exchange product group
+ */
+export interface WsExchangeRequestOperation<TWSTopic extends string = string> {
+    type: WsOperation;
+    channels: (TWSTopic | WsExchangeChannelWithParams)[];
+    product_ids?: string[];
+}
+/**
+ * Private (authenticated) subscribe/unsubscribe requests for the Coinbase Exchange product group
+ * https://docs.cdp.coinbase.com/exchange/docs/websocket-auth
+ */
+export type WsExchangeAuthenticatedRequestOperation<TWSTopic extends string = string> = WsExchangeRequestOperation<TWSTopic> & {
+    signature: string;
+    key: string;
+    passphrase: string;
+    timestamp: string;
+};
+/**
+ * Public subscribe/unsubscribe requests for the Coinbase International product group
+ */
+export interface WsInternationalRequestOperation<TWSTopic extends string = string> {
+    type: Uppercase<WsOperation>;
+    channels: TWSTopic[];
+    product_ids?: string[];
+}
+/**
+ * Private (authenticated) subscribe/unsubscribe requests for the Coinbase International product group
+ * https://docs.cdp.coinbase.com/intx/docs/websocket-auth
+ */
+export type WsInternationalAuthenticatedRequestOperation<TWSTopic extends string = string> = WsInternationalRequestOperation<TWSTopic> & {
+    time: string;
+    key: string;
+    passphrase: string;
+    signature: string;
+};
+/**
+ * Public subscribe/unsubscribe requests for the Coinbase Prime product group
+ */
+export interface WsPrimeRequestOperation<TWSTopic extends string = string> {
+    type: WsOperation;
+    channel: TWSTopic;
+    svcAccountId: string;
+    portfolio_id: string;
+    product_ids: string[];
+}
+/**
+ * Private (authenticated) subscribe/unsubscribe requests for the Coinbase Prime product group
+ *
+ * - https://docs.cdp.coinbase.com/prime/docs/websocket-feed#signing-messages
+ * - https://docs.cdp.coinbase.com/prime/docs/websocket-channels
+ */
+export type WsPrimeAuthenticatedRequestOperation<TWSTopic extends string = string> = WsPrimeRequestOperation<TWSTopic> & {
+    access_key: string;
+    api_key_id: string;
+    passphrase: string;
+    signature: string;
+    timestamp: string;
+};

package/dist/cjs/types/websockets/requests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=requests.js.map

package/dist/cjs/types/websockets/requests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"requests.js","sourceRoot":"","sources":["../../../../src/types/websockets/requests.ts"],"names":[],"mappings":""}

package/dist/cjs/types/websockets/wsAPI.d.ts

@@ -0,0 +1,9 @@
+export interface WsAPIWsKeyTopicMap {
+    [k: string]: never;
+}
+export interface WsAPITopicRequestParamMap {
+    [k: string]: never;
+}
+export interface WsAPITopicResponseMap {
+    [k: string]: never;
+}

package/dist/cjs/types/websockets/wsAPI.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=wsAPI.js.map

package/dist/cjs/types/websockets/wsAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wsAPI.js","sourceRoot":"","sources":["../../../../src/types/websockets/wsAPI.ts"],"names":[],"mappings":""}