@coinbase/cdp-sdk 1.1.2 → 1.3.0

package/_cjs/client/cdp.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CdpClient = void 0;
+const analytics_js_1 = require("../analytics.js");
+const index_js_1 = require("../openapi-client/index.js");
+const version_js_1 = require("../version.js");
+const evm_js_1 = require("./evm/evm.js");
+const solana_js_1 = require("./solana/solana.js");
+/**
+ * The main client for interacting with the CDP API.
+ */
+class CdpClient {
+    /** Namespace containing all EVM methods. */
+    evm;
+    /** Namespace containing all Solana methods. */
+    solana;
+    /**
+     * The CdpClient is the main class for interacting with the CDP API.
+     *
+     * There are a few required parameters that are configured in the [CDP Portal](https://portal.cdp.coinbase.com/projects/api-keys):
+     * - **CDP Secret API Key** (`apiKeyId` & `apiKeySecret`): These are used to authenticate requests to the entire suite of
+     *   APIs offered on Coinbase Developer Platform.
+     *   [Read more about CDP API keys](https://docs.cdp.coinbase.com/get-started/docs/cdp-api-keys).
+     * - **Wallet Secret** (`walletSecret`): This secret is used specifically to authenticate requests to `POST`, and `DELETE`
+     *   endpoints in the EVM and Solana Account APIs.
+     *
+     * These parameters can be set as environment variables:
+     * ```
+     * CDP_API_KEY_ID=your-api-key-id
+     * CDP_API_KEY_SECRET=your-api-key-secret
+     * CDP_WALLET_SECRET=your-wallet-secret
+     * ```
+     *
+     * Or passed as options to the constructor:
+     *
+     * ```typescript
+     * const cdp = new CdpClient({
+     *   apiKeyId: "your-api-key-id",
+     *   apiKeySecret: "your-api-key-secret",
+     *   walletSecret: "your-wallet-secret",
+     * });
+     * ```
+     *
+     * The CdpClient is namespaced by chain type: `evm` or `solana`.
+     *
+     * As an example, to create a new EVM account, use `cdp.evm.createAccount()`.
+     *
+     * To create a new Solana account, use `cdp.solana.createAccount()`.
+     *
+     * @param {CdpClientOptions} [options] - Configuration options for the CdpClient.
+     */
+    constructor(options = {}) {
+        const apiKeyId = options.apiKeyId ?? process.env.CDP_API_KEY_ID ?? process.env.CDP_API_KEY_NAME;
+        const apiKeySecret = options.apiKeySecret ?? process.env.CDP_API_KEY_SECRET;
+        const walletSecret = options.walletSecret ?? process.env.CDP_WALLET_SECRET;
+        if (!apiKeyId || !apiKeySecret) {
+            throw new Error(`
+\nMissing required CDP Secret API Key configuration parameters.
+
+You can set them as environment variables:
+
+CDP_API_KEY_ID=your-api-key-id
+CDP_API_KEY_SECRET=your-api-key-secret
+
+You can also pass them as options to the constructor:
+
+const cdp = new CdpClient({
+  apiKeyId: "your-api-key-id",
+  apiKeySecret: "your-api-key-secret",
+});
+
+If you're performing write operations, make sure to also set your wallet secret:
+
+CDP_WALLET_SECRET=your-wallet-secret
+
+This is also available as an option to the constructor:
+
+const cdp = new CdpClient({
+  apiKeyId: "your-api-key-id",
+  apiKeySecret: "your-api-key-secret",
+  walletSecret: "your-wallet-secret",
+});
+
+For more information, see: https://github.com/coinbase/cdp-sdk/blob/main/typescript/README.md#api-keys.
+`);
+        }
+        index_js_1.CdpOpenApiClient.configure({
+            ...options,
+            apiKeyId,
+            apiKeySecret,
+            walletSecret,
+            source: "sdk",
+            sourceVersion: version_js_1.version,
+        });
+        analytics_js_1.AnalyticsConfig.set(apiKeyId);
+        this.evm = new evm_js_1.EvmClient();
+        this.solana = new solana_js_1.SolanaClient();
+    }
+}
+exports.CdpClient = CdpClient;
+//# sourceMappingURL=cdp.js.map

package/_cjs/client/cdp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cdp.js","sourceRoot":"","sources":["../../client/cdp.ts"],"names":[],"mappings":";;;AAAA,kDAAkD;AAClD,yDAA8D;AAC9D,8CAAwC;AACxC,yCAAyC;AACzC,kDAAkD;AAelD;;GAEG;AACH,MAAa,SAAS;IACpB,4CAA4C;IACrC,GAAG,CAAY;IAEtB,+CAA+C;IACxC,MAAM,CAAe;IAE5B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,YAAY,UAA4B,EAAE;QACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAChG,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QAC5E,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;QAE3E,IAAI,CAAC,QAAQ,IAAI,CAAC,YAAY,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BrB,CAAC,CAAC;QACC,CAAC;QAED,2BAAgB,CAAC,SAAS,CAAC;YACzB,GAAG,OAAO;YACV,QAAQ;YACR,YAAY;YACZ,YAAY;YACZ,MAAM,EAAE,KAAK;YACb,aAAa,EAAE,oBAAO;SACvB,CAAC,CAAC;QAEH,8BAAe,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE9B,IAAI,CAAC,GAAG,GAAG,IAAI,kBAAS,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAY,EAAE,CAAC;IACnC,CAAC;CACF;AA7FD,8BA6FC"}