coinbase-api 0.3.2 → 1.0.1

package/dist/cjs/CBPrimeClient.js

@@ -0,0 +1,451 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CBPrimeClient = void 0;
+const BaseRestClient_js_1 = require("./lib/BaseRestClient.js");
+const requestUtils_js_1 = require("./lib/requestUtils.js");
+/**
+ * REST client for Coinbase Prime API:
+ * https://docs.cdp.coinbase.com/prime/docs/welcome
+ */
+class CBPrimeClient extends BaseRestClient_js_1.BaseRestClient {
+    constructor(restClientOptions = {}, requestOptions = {}) {
+        super(restClientOptions, requestOptions);
+        return this;
+    }
+    getClientType() {
+        return requestUtils_js_1.REST_CLIENT_TYPE_ENUM.prime;
+    }
+    /**
+     *
+     * Allocation Endpoints
+     *
+     */
+    /**
+     * Create Portfolio Allocations
+     *
+     * Create allocation for a given portfolio.
+     */
+    createPortfolioAllocations(params) {
+        return this.postPrivate('/v1/allocations', { body: params });
+    }
+    /**
+     * Create Portfolio Net Allocations
+     *
+     * Create net allocation for a given portfolio.
+     */
+    createPortfolioNetAllocations(params) {
+        return this.postPrivate('/v1/allocations/net', { body: params });
+    }
+    /**
+     * List Portfolio Allocations
+     *
+     * Retrieve historical allocations for a given portfolio.
+     */
+    getPortfolioAllocations(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/allocations`, query);
+    }
+    /**
+     * Get Allocation By ID
+     *
+     * Retrieve an allocation by allocation ID.
+     */
+    getAllocationById(params) {
+        const { portfolio_id, allocation_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/allocations/${allocation_id}`);
+    }
+    /**
+     * Get Net Allocations By Netting ID
+     *
+     * Retrieve an allocation by netting ID.
+     */
+    getNetAllocationsByNettingId(params) {
+        const { portfolio_id, netting_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/allocations/net/${netting_id}`);
+    }
+    /**
+     *
+     * Invoice Endpoints
+     *
+     */
+    /**
+     * List Invoices
+     *
+     * Retrieve a list of invoices belonging to an entity.
+     */
+    getInvoices(params) {
+        const { entity_id, ...query } = params;
+        return this.getPrivate(`/v1/entities/${entity_id}/invoices`, query);
+    }
+    /**
+     *
+     * Assets Endpoints
+     *
+     */
+    /**
+     * List Assets
+     *
+     * List all assets available for a given entity.
+     */
+    getAssets(params) {
+        return this.getPrivate(`/v1/entities/${params.entity_id}/assets`);
+    }
+    /**
+     *
+     * Payment Methods Endpoints
+     *
+     */
+    /**
+     * List Entity Payment Methods
+     *
+     * Retrieve all payment methods for a given entity.
+     */
+    getEntityPaymentMethods(params) {
+        return this.getPrivate(`/v1/entities/${params.entity_id}/payment-methods`);
+    }
+    /**
+     * Get Entity Payment Method
+     *
+     * Get payment method details by id for a given entity.
+     */
+    getEntityPaymentMethod(params) {
+        const { entity_id, payment_method_id } = params;
+        return this.getPrivate(`/v1/entities/${entity_id}/payment-methods/${payment_method_id}`);
+    }
+    /**
+     *
+     * Users Endpoints
+     *
+     */
+    /**
+     * List Users
+     *
+     * List all users associated with a given entity.
+     */
+    getUsers(params) {
+        const { entity_id, ...query } = params;
+        return this.getPrivate(`/v1/entities/${entity_id}/users`, query);
+    }
+    /**
+     * List Portfolio Users
+     *
+     * List all users associated with a given portfolio.
+     */
+    getPortfolioUsers(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/users`, query);
+    }
+    /**
+     *
+     * Portfolios Endpoints
+     *
+     */
+    /**
+     * List Portfolios
+     *
+     * List all portfolios for which the current API key has read access.
+     */
+    getPortfolios() {
+        return this.getPrivate('/v1/portfolios');
+    }
+    /**
+     * Get Portfolio by Portfolio ID
+     *
+     * Retrieve a given portfolio by its portfolio ID.
+     */
+    getPortfolioById(params) {
+        return this.getPrivate(`/v1/portfolios/${params.portfolio_id}`);
+    }
+    /**
+     * Get Portfolio Credit Information
+     *
+     * Retrieve a portfolio's post-trade credit information.
+     */
+    getPortfolioCreditInformation(params) {
+        return this.getPrivate(`/v1/portfolios/${params.portfolio_id}/credit`);
+    }
+    /**
+     *
+     * Activities Endpoints
+     *
+     */
+    /**
+     * List Activities
+     *
+     * List all activities associated with a given entity.
+     */
+    getActivities(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/activities`, query);
+    }
+    /**
+     * Get Activity by Activity ID
+     *
+     * Retrieve an activity by its activity ID.
+     */
+    getActivityById(params) {
+        const { portfolio_id, activity_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/activities/${activity_id}`);
+    }
+    /**
+     *
+     * Address Book Endpoints
+     *
+     */
+    /**
+     * Get Address Book
+     *
+     * Gets a list of address book addresses.
+     */
+    getAddressBook(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/address_book`, query);
+    }
+    /**
+     * Create Address Book Entry
+     *
+     * Creates an entry for a portfolio's trusted addresses.
+     */
+    createAddressBookEntry(params) {
+        const { portfolio_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/address_book`, {
+            body: body,
+        });
+    }
+    /**
+     *
+     * Balances Endpoints
+     *
+     */
+    /**
+     * List Portfolio Balances
+     *
+     * List all balances for a specific portfolio.
+     */
+    getPortfolioBalances(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/balances`, query);
+    }
+    /**
+     * Get Wallet Balance
+     *
+     * Query balance for a specific wallet.
+     */
+    getWalletBalance(params) {
+        const { portfolio_id, wallet_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/balance`);
+    }
+    /**
+     * List Web3 Wallet Balances
+     *
+     * Query balances for a specific web3 wallet.
+     */
+    getWeb3WalletBalances(params) {
+        const { portfolio_id, wallet_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/web3_balances`, query);
+    }
+    /**
+     *
+     * Commission Endpoints
+     *
+     */
+    /**
+     * Get Portfolio Commission
+     *
+     * Retrieve commission associated with a given portfolio.
+     */
+    getPortfolioCommission(params) {
+        return this.getPrivate(`/v1/portfolios/${params.portfolio_id}/commission`);
+    }
+    /**
+     *
+     * Orders Endpoints
+     *
+     */
+    /**
+     * List Open Orders
+     *
+     * List all open orders for a given portfolio.
+     */
+    getOpenOrders(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/open_orders`, query);
+    }
+    /**
+     * Create Order
+     *
+     * Create an order for a given portfolio.
+     */
+    submitOrder(params) {
+        this.validateOrderId(params, 'client_order_id');
+        const { portfolio_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/order`, {
+            body: body,
+        });
+    }
+    /**
+     * Get Order Preview
+     *
+     * Retrieve an order preview for a given portfolio.
+     */
+    getOrderPreview(params) {
+        const { portfolio_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/order_preview`, {
+            body: body,
+        });
+    }
+    /**
+     * List Portfolio Orders
+     *
+     * List historical orders for a given portfolio.
+     */
+    getPortfolioOrders(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/orders`, query);
+    }
+    /**
+     * Get Order by Order ID
+     *
+     * Retrieve an order by order ID.
+     */
+    getOrderById(params) {
+        const { portfolio_id, order_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/orders/${order_id}`);
+    }
+    /**
+     * Cancel Order
+     *
+     * Cancel an order. (Filled orders cannot be canceled.)
+     */
+    cancelOrder(params) {
+        const { portfolio_id, order_id } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/orders/${order_id}/cancel`);
+    }
+    /**
+     * List Order Fills
+     *
+     * Retrieve fills on a given order.
+     */
+    getOrderFills(params) {
+        const { portfolio_id, order_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/orders/${order_id}/fills`, query);
+    }
+    /**
+     *
+     * Products Endpoints
+     *
+     */
+    /**
+     * List Portfolio Products
+     *
+     * List tradable products for a given portfolio.
+     */
+    getPortfolioProducts(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/products`, query);
+    }
+    /**
+     *
+     * Transactions Endpoints
+     *
+     */
+    /**
+     * List Portfolio Transactions
+     *
+     * List transactions for a given portfolio (only transactions that affect balances are accessible).
+     */
+    getPortfolioTransactions(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/transactions`, query);
+    }
+    /**
+     * Get Transaction by Transaction ID
+     *
+     * Retrieve a specific transaction by its transaction ID (only transactions that affect balances are accessible).
+     */
+    getTransactionById(params) {
+        const { portfolio_id, transaction_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/transactions/${transaction_id}`);
+    }
+    /**
+     * Create Conversion
+     *
+     * Perform a conversion between 2 assets.
+     */
+    createConversion(params) {
+        const { portfolio_id, wallet_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/conversion`, { body: body });
+    }
+    /**
+     * List Wallet Transactions
+     *
+     * Retrieve transactions for a given wallet (only transactions that affect balances are accessible).
+     */
+    getWalletTransactions(params) {
+        const { portfolio_id, wallet_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/transactions`, query);
+    }
+    /**
+     * Create Transfer
+     *
+     * Create a wallet transfer.
+     */
+    createTransfer(params) {
+        const { portfolio_id, wallet_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/transfers`, { body: body });
+    }
+    /**
+     * Create Withdrawal
+     *
+     * Create a withdrawal.
+     */
+    createWithdrawal(params) {
+        const { portfolio_id, wallet_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/withdrawals`, { body: body });
+    }
+    /**
+     *
+     * Wallets Endpoints
+     *
+     */
+    /**
+     * List Portfolio Wallets
+     *
+     * List all wallets associated with a given portfolio.
+     */
+    getPortfolioWallets(params) {
+        const { portfolio_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/wallets`, query);
+    }
+    /**
+     * Create Wallet
+     *
+     * Create a wallet.
+     */
+    createWallet(params) {
+        const { portfolio_id, ...body } = params;
+        return this.postPrivate(`/v1/portfolios/${portfolio_id}/wallets`, {
+            body: body,
+        });
+    }
+    /**
+     * Get Wallet by Wallet ID
+     *
+     * Retrieve a specific wallet by Wallet ID.
+     */
+    getWalletById(params) {
+        const { portfolio_id, wallet_id } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}`);
+    }
+    /**
+     * Get Wallet Deposit Instructions
+     *
+     * Retrieve a specific wallet's deposit instructions.
+     */
+    getWalletDepositInstructions(params) {
+        const { portfolio_id, wallet_id, ...query } = params;
+        return this.getPrivate(`/v1/portfolios/${portfolio_id}/wallets/${wallet_id}/deposit_instructions`, query);
+    }
+}
+exports.CBPrimeClient = CBPrimeClient;
+//# sourceMappingURL=CBPrimeClient.js.map

package/dist/cjs/CBPrimeClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CBPrimeClient.js","sourceRoot":"","sources":["../../src/CBPrimeClient.ts"],"names":[],"mappings":";;;AAEA,+DAAyD;AACzD,2DAI+B;AA4B/B;;;GAGG;AACH,MAAa,aAAc,SAAQ,kCAAc;IAC/C,YACE,oBAAuC,EAAE,EACzC,iBAAqC,EAAE;QAEvC,KAAK,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,aAAa;QACX,OAAO,uCAAqB,CAAC,KAAK,CAAC;IACrC,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,0BAA0B,CACxB,MAA8C;QAE9C,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,6BAA6B,CAC3B,MAAiD;QAEjD,OAAO,IAAI,CAAC,WAAW,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CACrB,MAA2C;QAE3C,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,MAGjB;QACC,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,MAAM,CAAC;QAC/C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,gBAAgB,aAAa,EAAE,CAC9D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,MAG5B;QACC,MAAM,EAAE,YAAY,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAC5C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,oBAAoB,UAAU,EAAE,CAC/D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,WAAW,CAAC,MAA+B;QACzC,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,SAAS,WAAW,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,SAAS,CAAC,MAA6B;QACrC,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,MAAM,CAAC,SAAS,SAAS,CAAC,CAAC;IACpE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,uBAAuB,CAAC,MAA6B;QACnD,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,MAAM,CAAC,SAAS,kBAAkB,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CAAC,MAGtB;QACC,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,UAAU,CACpB,gBAAgB,SAAS,oBAAoB,iBAAiB,EAAE,CACjE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,QAAQ,CAAC,MAA4B;QACnC,MAAM,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,SAAS,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,MAAqC;QACrD,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,QAAQ,EAAE,KAAK,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAgC;QAC/C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;OAIG;IACH,6BAA6B,CAAC,MAE7B;QACC,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,MAAM,CAAC,YAAY,SAAS,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa,CAAC,MAAiC;QAC7C,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,aAAa,EAAE,KAAK,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAGf;QACC,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,GAAG,MAAM,CAAC;QAC7C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,eAAe,WAAW,EAAE,CAC3D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,cAAc,CAAC,MAAkC;QAC/C,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,eAAe,EAC7C,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,sBAAsB,CACpB,MAA0C;QAE1C,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,YAAY,eAAe,EAAE;YACrE,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,oBAAoB,CAAC,MAIpB;QACC,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAGhB;QACC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,YAAY,SAAS,UAAU,CAC9D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CACnB,MAAyC;QAEzC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrD,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,YAAY,SAAS,gBAAgB,EACnE,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,sBAAsB,CAAC,MAAgC;QACrD,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,MAAM,CAAC,YAAY,aAAa,CAAC,CAAC;IAC7E,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,aAAa,CAAC,MAAiC;QAC7C,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAA+B;QACzC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;QAChD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,YAAY,QAAQ,EAAE;YAC9D,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,MAAmC;QACjD,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,YAAY,gBAAgB,EAAE;YACtE,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAAsC;QACvD,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,SAAS,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAGZ;QACC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,WAAW,QAAQ,EAAE,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,MAGX;QACC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,WAAW,CACrB,kBAAkB,YAAY,WAAW,QAAQ,SAAS,CAC3D,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAAiC;QAC7C,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,WAAW,QAAQ,QAAQ,EACzD,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,oBAAoB,CAAC,MAAwC;QAC3D,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,WAAW,EAAE,KAAK,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,wBAAwB,CACtB,MAA4C;QAE5C,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,eAAe,EAC7C,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,MAGlB;QACC,MAAM,EAAE,YAAY,EAAE,cAAc,EAAE,GAAG,MAAM,CAAC;QAChD,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,iBAAiB,cAAc,EAAE,CAChE,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAoC;QACnD,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CACrB,kBAAkB,YAAY,YAAY,SAAS,aAAa,EAChE,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CACnB,MAAyC;QAEzC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrD,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,YAAY,SAAS,eAAe,EAClE,KAAK,CACN,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAkC;QAC/C,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CACrB,kBAAkB,YAAY,YAAY,SAAS,YAAY,EAC/D,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAC,MAAoC;QACnD,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACpD,OAAO,IAAI,CAAC,WAAW,CACrB,kBAAkB,YAAY,YAAY,SAAS,cAAc,EACjE,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;IACJ,CAAC;IAED;;;;OAIG;IAEH;;;;OAIG;IACH,mBAAmB,CAAC,MAAuC;QACzD,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,YAAY,UAAU,EAAE,KAAK,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAgC;QAC3C,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACzC,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,YAAY,UAAU,EAAE;YAChE,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,MAGb;QACC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,YAAY,SAAS,EAAE,CACtD,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAC1B,MAAgD;QAEhD,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,KAAK,EAAE,GAAG,MAAM,CAAC;QACrD,OAAO,IAAI,CAAC,UAAU,CACpB,kBAAkB,YAAY,YAAY,SAAS,uBAAuB,EAC1E,KAAK,CACN,CAAC;IACJ,CAAC;CACF;AA7kBD,sCA6kBC"}

package/dist/cjs/WebsocketClient.d.ts

@@ -0,0 +1,78 @@
+import { BaseWebsocketClient, EmittableEvent } from './lib/BaseWSClient.js';
+import { MessageEventLike, WsKey, WsTopicRequest } from './lib/websocket/websocket-util.js';
+import { WSConnectedResult } from './lib/websocket/WsStore.types.js';
+import { WsMarket } from './types/websockets/client.js';
+import { WsOperation } from './types/websockets/requests.js';
+import { WsAPITopicRequestParamMap, WsAPITopicResponseMap, WsAPIWsKeyTopicMap } from './types/websockets/wsAPI.js';
+export declare const WS_LOGGER_CATEGORY: {
+    category: string;
+};
+/**
+ * Any WS keys in this list will ALWAYS skip the authentication process, even if credentials are available
+ */
+export declare const PUBLIC_WS_KEYS: WsKey[];
+/**
+ * WS topics are always a string for this exchange. Some exchanges use complex objects.
+ */
+type WsTopic = string;
+export declare class WebsocketClient extends BaseWebsocketClient<WsKey> {
+    /**
+     * Request connection of all dependent (public & private) websockets, instead of waiting for automatic connection by library
+     */
+    connectAll(): Promise<(WSConnectedResult | undefined)[]>;
+    /**
+     * Request subscription to one or more topics. Pass topics as either an array of strings, or array of objects (if the topic has parameters).
+     * Objects should be formatted as {topic: string, params: object}.
+     *
+     * - Subscriptions are automatically routed to the correct websocket connection.
+     * - Authentication/connection is automatic.
+     * - Resubscribe after network issues is automatic.
+     *
+     * Call `unsubscribe(topics)` to remove topics
+     */
+    subscribe(requests: (WsTopicRequest<WsTopic> | WsTopic) | (WsTopicRequest<WsTopic> | WsTopic)[], wsKey: WsKey): void;
+    /**
+     * Unsubscribe from one or more topics. Similar to subscribe() but in reverse.
+     *
+     * - Requests are automatically routed to the correct websocket connection.
+     * - These topics will be removed from the topic cache, so they won't be subscribed to again.
+     */
+    unsubscribe(requests: (WsTopicRequest<WsTopic> | WsTopic) | (WsTopicRequest<WsTopic> | WsTopic)[], wsKey: WsKey): void;
+    /**
+     * Not supported by this exchange, do not use
+     */
+    sendWSAPIRequest<TWSKey extends keyof WsAPIWsKeyTopicMap, TWSChannel extends WsAPIWsKeyTopicMap[TWSKey] = WsAPIWsKeyTopicMap[TWSKey], TWSParams extends WsAPITopicRequestParamMap[TWSChannel] = WsAPITopicRequestParamMap[TWSChannel], TWSAPIResponse extends WsAPITopicResponseMap[TWSChannel] | object = WsAPITopicResponseMap[TWSChannel]>(wsKey: TWSKey, channel: TWSChannel, ...params: TWSParams extends undefined ? [] : [TWSParams]): Promise<TWSAPIResponse>;
+    /**
+     *
+     * Internal methods
+     *
+     */
+    /**
+     * Return a websocket URL, which is connected to as-is.
+     * If a token or anything else is needed in the URL, this is a good place to add it.
+     */
+    protected getWsUrl(wsKey: WsKey): Promise<string>;
+    protected sendPingEvent(wsKey: WsKey): void;
+    protected sendPongEvent(wsKey: WsKey): void;
+    protected isWsPing(msg: any): boolean;
+    protected isWsPong(msg: any): boolean;
+    protected resolveEmittableEvents(wsKey: WsKey, event: MessageEventLike): EmittableEvent[];
+    /**
+     * Determines if a topic is for a private channel, using a hardcoded list of strings
+     */
+    protected isPrivateTopicRequest(request: WsTopicRequest<string>, wsKey: WsKey): boolean;
+    protected getWsKeyForMarket(market: WsMarket, isPrivate: boolean): WsKey;
+    protected getWsMarketForWsKey(wsKey: WsKey): WsMarket;
+    protected getPrivateWSKeys(): WsKey[];
+    /** Force subscription requests to be sent in smaller batches, if a number is returned */
+    protected getMaxTopicsPerSubscribeEvent(wsKey: WsKey): number | null;
+    /**
+     * Map one or more topics into fully prepared "subscribe request" events (already stringified and ready to send)
+     */
+    protected getWsOperationEventsForTopics(topicRequests: WsTopicRequest<string>[], wsKey: WsKey, operation: WsOperation): Promise<string[]>;
+    /**
+     * Events are signed per-request, so this function isn't needed for Coinbase.
+     */
+    protected getWsAuthRequestEvent(wsKey: WsKey): Promise<object>;
+}
+export {};