@coinbase-sample/prime-sdk-ts 0.6.2 → 0.6.4

package/dist/clients/clientWithServices.js

@@ -0,0 +1,323 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoinbasePrimeClientWithServices = void 0;
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const core_ts_1 = require("@coinbase-sample/core-ts");
+const constants_1 = require("../constants");
+const toCamelCase_1 = require("../shared/toCamelCase");
+const envUtils_1 = require("../shared/envUtils");
+/**
+ * Enhanced Coinbase Prime Client with lazy-loaded service getters.
+ * Services are only instantiated when first accessed, improving tree-shaking
+ * and reducing initial bundle size.
+ */
+class CoinbasePrimeClientWithServices extends core_ts_1.CoinbaseClient {
+    constructor(credentials, apiBasePath, options) {
+        const defaultClientOptions = Object.assign({ defaultLimit: constants_1.DEFAULT_PAGINATION_LIMIT, maxPages: constants_1.DEFAULT_MAX_PAGES, maxItems: constants_1.DEFAULT_MAX_ITEMS }, options);
+        let basePath = constants_1.API_BASE_PATH;
+        if (apiBasePath && apiBasePath.length > 0) {
+            basePath = apiBasePath;
+        }
+        super(basePath, credentials, constants_1.USER_AGENT, defaultClientOptions);
+        // transform the response data to camelCase
+        this.addTransformResponse((response) => {
+            return Object.assign(Object.assign({}, response), { data: (0, toCamelCase_1.toCamelCase)(response.data) });
+        });
+    }
+    /**
+     * Create a client from environment variables
+     * Requires PRIME_CREDENTIALS environment variable with JSON containing:
+     * { "AccessKey": "...", "SecretKey": "...", "Passphrase": "..." }
+     */
+    static fromEnv(baseUrl, options) {
+        const credentials = (0, envUtils_1.createCredentialsFromEnv)();
+        return new CoinbasePrimeClientWithServices(credentials, baseUrl, options);
+    }
+    /**
+     * Lazy getter for ActivitiesService
+     * @example
+     * ```typescript
+     * const activities = await client.activities.listPortfolioActivities({ portfolioId });
+     * ```
+     */
+    get activities() {
+        if (!this._activitiesService) {
+            const { ActivitiesService } = require('../activities');
+            this._activitiesService = new ActivitiesService(this);
+        }
+        return this._activitiesService;
+    }
+    /**
+     * Lazy getter for AddressBooksService
+     * @example
+     * ```typescript
+     * const addressBooks = await client.addressBooks.listAddressBooks({ portfolioId });
+     * ```
+     */
+    get addressBooks() {
+        if (!this._addressBooksService) {
+            const { AddressBooksService } = require('../addressBooks');
+            this._addressBooksService = new AddressBooksService(this);
+        }
+        return this._addressBooksService;
+    }
+    /**
+     * Lazy getter for AllocationService
+     * @example
+     * ```typescript
+     * const allocation = await client.allocations.createAllocation({ portfolioId, ... });
+     * ```
+     */
+    get allocations() {
+        if (!this._allocationService) {
+            const { AllocationService } = require('../allocations');
+            this._allocationService = new AllocationService(this);
+        }
+        return this._allocationService;
+    }
+    /**
+     * Lazy getter for AssetsService
+     * @example
+     * ```typescript
+     * const assets = await client.assets.listAssets({ entityId });
+     * ```
+     */
+    get assets() {
+        if (!this._assetsService) {
+            const { AssetsService } = require('../assets');
+            this._assetsService = new AssetsService(this);
+        }
+        return this._assetsService;
+    }
+    /**
+     * Lazy getter for BalancesService
+     * @example
+     * ```typescript
+     * const balance = await client.balances.getWalletBalance({ portfolioId, walletId });
+     * ```
+     */
+    get balances() {
+        if (!this._balancesService) {
+            const { BalancesService } = require('../balances');
+            this._balancesService = new BalancesService(this);
+        }
+        return this._balancesService;
+    }
+    /**
+     * Lazy getter for CommissionService
+     * @example
+     * ```typescript
+     * const commission = await client.commission.getPortfolioCommission({ portfolioId });
+     * ```
+     */
+    get commission() {
+        if (!this._commissionService) {
+            const { CommissionService } = require('../commission');
+            this._commissionService = new CommissionService(this);
+        }
+        return this._commissionService;
+    }
+    /**
+     * Lazy getter for FinancingService
+     * @example
+     * ```typescript
+     * const buyingPower = await client.financing.getPortfolioBuyingPower({ portfolioId });
+     * ```
+     */
+    get financing() {
+        if (!this._financingService) {
+            const { FinancingService } = require('../financing');
+            this._financingService = new FinancingService(this);
+        }
+        return this._financingService;
+    }
+    /**
+     * Lazy getter for FuturesService
+     * @example
+     * ```typescript
+     * const positions = await client.futures.getEntityFuturesPositions({ entityId });
+     * ```
+     */
+    get futures() {
+        if (!this._futuresService) {
+            const { FuturesService } = require('../futures');
+            this._futuresService = new FuturesService(this);
+        }
+        return this._futuresService;
+    }
+    /**
+     * Lazy getter for InvoicesService
+     * @example
+     * ```typescript
+     * const invoices = await client.invoices.listInvoices({ entityId });
+     * ```
+     */
+    get invoices() {
+        if (!this._invoicesService) {
+            const { InvoicesService } = require('../invoices');
+            this._invoicesService = new InvoicesService(this);
+        }
+        return this._invoicesService;
+    }
+    /**
+     * Lazy getter for OnchainAddressBookService
+     * @example
+     * ```typescript
+     * const addressBook = await client.onchainAddressBook.listOnchainAddressBook({ portfolioId });
+     * ```
+     */
+    get onchainAddressBook() {
+        if (!this._onchainAddressBookService) {
+            const { OnchainAddressBookService } = require('../onchainAddressBook');
+            this._onchainAddressBookService = new OnchainAddressBookService(this);
+        }
+        return this._onchainAddressBookService;
+    }
+    /**
+     * Lazy getter for OrdersService
+     * @example
+     * ```typescript
+     * const order = await client.orders.createOrder({
+     *   portfolioId: "123",
+     *   side: "BUY",
+     *   productId: "BTC-USD",
+     *   type: "MARKET",
+     *   baseQuantity: "0.001"
+     * });
+     * ```
+     */
+    get orders() {
+        if (!this._ordersService) {
+            const { OrdersService } = require('../orders');
+            this._ordersService = new OrdersService(this);
+        }
+        return this._ordersService;
+    }
+    /**
+     * Lazy getter for PaymentMethodsService
+     * @example
+     * ```typescript
+     * const paymentMethods = await client.paymentMethods.listEntityPaymentMethods({ entityId });
+     * ```
+     */
+    get paymentMethods() {
+        if (!this._paymentMethodsService) {
+            const { PaymentMethodsService } = require('../paymentMethods');
+            this._paymentMethodsService = new PaymentMethodsService(this);
+        }
+        return this._paymentMethodsService;
+    }
+    /**
+     * Lazy getter for PortfoliosService
+     * @example
+     * ```typescript
+     * const portfolios = await client.portfolios.listPortfolios();
+     * ```
+     */
+    get portfolios() {
+        if (!this._portfoliosService) {
+            const { PortfoliosService } = require('../portfolios');
+            this._portfoliosService = new PortfoliosService(this);
+        }
+        return this._portfoliosService;
+    }
+    /**
+     * Lazy getter for PositionsService
+     * @example
+     * ```typescript
+     * const positions = await client.positions.listAggregateEntityPositions({ entityId });
+     * ```
+     */
+    get positions() {
+        if (!this._positionsService) {
+            const { PositionsService } = require('../positions');
+            this._positionsService = new PositionsService(this);
+        }
+        return this._positionsService;
+    }
+    /**
+     * Lazy getter for ProductsService
+     * @example
+     * ```typescript
+     * const products = await client.products.listProducts({ portfolioId });
+     * ```
+     */
+    get products() {
+        if (!this._productsService) {
+            const { ProductsService } = require('../products');
+            this._productsService = new ProductsService(this);
+        }
+        return this._productsService;
+    }
+    /**
+     * Lazy getter for StakingService
+     * @example
+     * ```typescript
+     * const stake = await client.staking.createStake({ walletId, assetId, amount });
+     * ```
+     */
+    get staking() {
+        if (!this._stakingService) {
+            const { StakingService } = require('../staking');
+            this._stakingService = new StakingService(this);
+        }
+        return this._stakingService;
+    }
+    /**
+     * Lazy getter for TransactionsService
+     * @example
+     * ```typescript
+     * const transaction = await client.transactions.getTransaction({ portfolioId, transactionId });
+     * ```
+     */
+    get transactions() {
+        if (!this._transactionsService) {
+            const { TransactionsService } = require('../transactions');
+            this._transactionsService = new TransactionsService(this);
+        }
+        return this._transactionsService;
+    }
+    /**
+     * Lazy getter for UsersService
+     * @example
+     * ```typescript
+     * const users = await client.users.listUsers({ entityId });
+     * ```
+     */
+    get users() {
+        if (!this._usersService) {
+            const { UsersService } = require('../users');
+            this._usersService = new UsersService(this);
+        }
+        return this._usersService;
+    }
+    /**
+     * Lazy getter for WalletsService
+     * @example
+     * ```typescript
+     * const wallets = await client.wallets.listWallets({ portfolioId });
+     * ```
+     */
+    get wallets() {
+        if (!this._walletsService) {
+            const { WalletsService } = require('../wallets');
+            this._walletsService = new WalletsService(this);
+        }
+        return this._walletsService;
+    }
+}
+exports.CoinbasePrimeClientWithServices = CoinbasePrimeClientWithServices;

package/dist/{types/client.d.ts → clients/clientWithServicesTypes.js}

@@ -1,5 +1,6 @@
+"use strict";
 /**
- * Copyright 2024-present Coinbase Global, Inc.
+ * Copyright 2025-present Coinbase Global, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,8 +14,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { CoinbaseClient, CoinbaseHttpClientRetryOptions } from '@coinbase-sample/core-ts';
-import { CoinbasePrimeCredentials } from './credentials';
-export declare class CoinbasePrimeClient extends CoinbaseClient {
-    constructor(credentials?: CoinbasePrimeCredentials, apiBasePath?: string, options?: CoinbaseHttpClientRetryOptions);
-}
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/clients/index.js

@@ -0,0 +1,28 @@
+"use strict";
+/**
+ * Copyright 2025-present Coinbase Global, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CoinbaseError = exports.CoinbaseClientException = exports.Method = exports.CoinbaseClient = exports.CoinbasePrimeClientWithServices = exports.CoinbasePrimeClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "CoinbasePrimeClient", { enumerable: true, get: function () { return client_1.CoinbasePrimeClient; } });
+var clientWithServices_1 = require("./clientWithServices");
+Object.defineProperty(exports, "CoinbasePrimeClientWithServices", { enumerable: true, get: function () { return clientWithServices_1.CoinbasePrimeClientWithServices; } });
+// Re-export core-ts objects for central control of service's usage of core-ts
+var core_ts_1 = require("@coinbase-sample/core-ts");
+Object.defineProperty(exports, "CoinbaseClient", { enumerable: true, get: function () { return core_ts_1.CoinbaseClient; } });
+Object.defineProperty(exports, "Method", { enumerable: true, get: function () { return core_ts_1.Method; } });
+Object.defineProperty(exports, "CoinbaseClientException", { enumerable: true, get: function () { return core_ts_1.CoinbaseClientException; } });
+Object.defineProperty(exports, "CoinbaseError", { enumerable: true, get: function () { return core_ts_1.CoinbaseError; } });

package/dist/clients/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/constants.js

@@ -16,7 +16,7 @@ exports.DEFAULT_MAX_ITEMS = exports.DEFAULT_MAX_PAGES = exports.DEFAULT_PAGINATI
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-exports.VERSION = '0.6.2';
+exports.VERSION = '0.6.4';
 exports.API_BASE_PATH = 'https://api.prime.coinbase.com/v1/';
 exports.USER_AGENT = 'coinbase-prime-ts/' + exports.VERSION;
 exports.CB_ACCESS_KEY_HEADER = 'X-CB-ACCESS-KEY';

package/dist/futures/index.js

@@ -25,7 +25,7 @@ exports.FuturesService = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const core_ts_1 = require("@coinbase-sample/core-ts");
+const clients_1 = require("../clients");
 class FuturesService {
     constructor(client) {
         this.client = client;
@@ -63,7 +63,7 @@ class FuturesService {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.client.request({
                 url: `entities/${request.entityId}/futures/sweeps`,
-                method: core_ts_1.Method.POST,
+                method: clients_1.Method.POST,
                 bodyParams: Object.assign(Object.assign({}, request), { entityId: undefined }),
                 callOptions: options,
             });
@@ -74,7 +74,7 @@ class FuturesService {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.client.request({
                 url: `entities/${request.entityId}/futures/auto_sweep`,
-                method: core_ts_1.Method.POST,
+                method: clients_1.Method.POST,
                 bodyParams: Object.assign(Object.assign({}, request), { entityId: undefined }),
                 callOptions: options,
             });
@@ -85,7 +85,7 @@ class FuturesService {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.client.request({
                 url: `entities/${request.entityId}/futures/sweeps`,
-                method: core_ts_1.Method.DELETE,
+                method: clients_1.Method.DELETE,
                 callOptions: options,
             });
             return response.data;

package/dist/index.js

@@ -1,20 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WalletsService = exports.UsersService = exports.TransactionsService = exports.StakingService = exports.ProductsService = exports.PositionsService = exports.PortfoliosService = exports.PaymentMethodsService = exports.OrdersService = exports.OnchainAddressBookService = exports.InvoicesService = exports.FuturesService = exports.FinancingService = exports.CommissionService = exports.BalancesService = exports.AssetsService = exports.AllocationService = exports.AddressBooksService = exports.ActivitiesService = exports.CoinbasePrimeCredentials = exports.CoinbasePrimeClient = void 0;
 /**
  * Copyright 2024-present Coinbase Global, Inc.
  *
@@ -30,10 +14,35 @@ exports.WalletsService = exports.UsersService = exports.TransactionsService = ex
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var client_1 = require("./client");
-Object.defineProperty(exports, "CoinbasePrimeClient", { enumerable: true, get: function () { return client_1.CoinbasePrimeClient; } });
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletsService = exports.UsersService = exports.TransactionsService = exports.StakingService = exports.ProductsService = exports.PositionsService = exports.PortfoliosService = exports.PaymentMethodsService = exports.OrdersService = exports.OnchainAddressBookService = exports.InvoicesService = exports.FuturesService = exports.FinancingService = exports.CommissionService = exports.BalancesService = exports.AssetsService = exports.AllocationService = exports.AddressBooksService = exports.ActivitiesService = exports.createCredentialsFromEnv = exports.CoinbasePrimeCredentials = exports.CoinbasePrimeClient = exports.CoinbasePrimeClientWithServices = exports.CoinbaseError = exports.CoinbaseClientException = exports.Method = exports.CoinbaseClient = void 0;
+// Re-export commonly used core-ts objects for convenience
+// This allows users to import everything from a single package
+var clients_1 = require("./clients");
+Object.defineProperty(exports, "CoinbaseClient", { enumerable: true, get: function () { return clients_1.CoinbaseClient; } });
+Object.defineProperty(exports, "Method", { enumerable: true, get: function () { return clients_1.Method; } });
+Object.defineProperty(exports, "CoinbaseClientException", { enumerable: true, get: function () { return clients_1.CoinbaseClientException; } });
+Object.defineProperty(exports, "CoinbaseError", { enumerable: true, get: function () { return clients_1.CoinbaseError; } });
+Object.defineProperty(exports, "CoinbasePrimeClientWithServices", { enumerable: true, get: function () { return clients_1.CoinbasePrimeClientWithServices; } });
+Object.defineProperty(exports, "CoinbasePrimeClient", { enumerable: true, get: function () { return clients_1.CoinbasePrimeClient; } });
 var credentials_1 = require("./credentials");
 Object.defineProperty(exports, "CoinbasePrimeCredentials", { enumerable: true, get: function () { return credentials_1.CoinbasePrimeCredentials; } });
+var envUtils_1 = require("./shared/envUtils");
+Object.defineProperty(exports, "createCredentialsFromEnv", { enumerable: true, get: function () { return envUtils_1.createCredentialsFromEnv; } });
 var activities_1 = require("./activities");
 Object.defineProperty(exports, "ActivitiesService", { enumerable: true, get: function () { return activities_1.ActivitiesService; } });
 var addressBooks_1 = require("./addressBooks");