@coinbase/cdp-sdk 1.3.0 → 1.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # CDP SDK Changelog
2
2
 
3
+ ## 1.3.1
4
+
5
+ ### Patch Changes
6
+
7
+ - This patch contains a README update to accomodate the new home for CDP SDK examples.
8
+
3
9
  ## 1.3.0
4
10
 
5
11
  ### Minor Changes
package/README.md CHANGED
@@ -3,6 +3,7 @@
3
3
  ## Table of Contents
4
4
 
5
5
  - [CDP SDK](#cdp-sdk)
6
+ - [Documentation](#documentation)
6
7
  - [Installation](#installation)
7
8
  - [API Keys](#api-keys)
8
9
  - [Usage](#usage)
@@ -11,14 +12,25 @@
11
12
  - [License](#license)
12
13
  - [Support](#support)
13
14
  - [Security](#security)
15
+ - [FAQ](#faq)
14
16
 
15
17
  > [!TIP]
18
+ >
16
19
  > If you're looking to contribute to the SDK, please see the [Contributing Guide](https://github.com/coinbase/cdp-sdk/blob/main/typescript/CONTRIBUTING.md).
17
20
 
18
21
  ## CDP SDK
19
22
 
20
23
  This module contains the TypeScript CDP SDK, which is a library that provides a client for interacting with the [Coinbase Developer Platform (CDP)](https://docs.cdp.coinbase.com/). It includes a CDP Client for interacting with EVM and Solana APIs to create accounts and send transactions, as well as authentication tools for interacting directly with the CDP APIs.
21
24
 
25
+ ## Documentation
26
+
27
+ CDP SDK has [auto-generated docs for the Typescript SDK](https://coinbase.github.io/cdp-sdk/typescript).
28
+
29
+ Further documentation is also available on the CDP docs website:
30
+
31
+ - [Wallet API v2](https://docs.cdp.coinbase.com/wallet-api-v2/docs/welcome)
32
+ - [API Reference](https://docs.cdp.coinbase.com/api-v2/docs/welcome)
33
+
22
34
  ## Installation
23
35
 
24
36
  ```bash
@@ -211,7 +223,7 @@ console.log(`Transaction confirmed! Explorer link: https://sepolia.basescan.org/
211
223
 
212
224
  #### Solana
213
225
 
214
- For Solana, we recommend using the `@solana/web3.js` library to send transactions. See the [examples](https://github.com/coinbase/cdp-sdk/tree/main/typescript/src/examples/solana/signAndSendTransaction.ts).
226
+ For Solana, we recommend using the `@solana/web3.js` library to send transactions. See the [examples](https://github.com/coinbase/cdp-sdk/tree/main/examples/typescript/solana/signAndSendTransaction.ts).
215
227
 
216
228
  ### EVM Smart Accounts
217
229
 
@@ -286,3 +298,19 @@ For feature requests, feedback, or questions, please reach out to us in the **#c
286
298
  ## Security
287
299
 
288
300
  If you discover a security vulnerability within this SDK, please see our [Security Policy](https://github.com/coinbase/cdp-sdk/tree/main/SECURITY.md) for disclosure information.
301
+
302
+ ## FAQ
303
+
304
+ Common errors and their solutions.
305
+
306
+ ### AggregateError [ETIMEDOUT]
307
+
308
+ This is an issue in Node.js itself: https://github.com/nodejs/node/issues/54359. While [the fix](https://github.com/nodejs/node/pull/56738) is implemented, the workaround is to set the environment variable:
309
+
310
+ ```bash
311
+ export NODE_OPTIONS="--network-family-autoselection-attempt-timeout=500"
312
+ ```
313
+
314
+ ### Error [ERR_REQUIRE_ESM]: require() of ES modules is not supported.
315
+
316
+ Use Node v20.19.0 or higher. CDP SDK depends on [jose](https://github.com/panva/jose) v6, which ships only ESM. Jose supports CJS style imports in Node.js versions where the require(esm) feature is enabled by default (^20.19.0 || ^22.12.0 || >= 23.0.0). [See here for more info](https://github.com/panva/jose?tab=readme-ov-file#user-content-fn-cjs-705c79d785ca9bc0f9ec1e8ce0825c74).
package/_cjs/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = void 0;
4
- exports.version = "1.3.0";
4
+ exports.version = "1.3.1";
5
5
  //# sourceMappingURL=version.js.map
package/_esm/version.js CHANGED
@@ -1,2 +1,2 @@
1
- export const version = "1.3.0";
1
+ export const version = "1.3.1";
2
2
  //# sourceMappingURL=version.js.map
@@ -1,2 +1,2 @@
1
- export declare const version = "1.3.0";
1
+ export declare const version = "1.3.1";
2
2
  //# sourceMappingURL=version.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coinbase/cdp-sdk",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "description": "SDK for interacting with the Coinbase Developer Platform Wallet API",
5
5
  "main": "./_cjs/index.js",
6
6
  "module": "./_esm/index.js",
@@ -30,8 +30,7 @@
30
30
  "license": "MIT",
31
31
  "files": [
32
32
  "*",
33
- "!**/*.test.ts",
34
- "!examples"
33
+ "!**/*.test.ts"
35
34
  ],
36
35
  "keywords": [
37
36
  "coinbase",
package/version.ts CHANGED
@@ -1 +1 @@
1
- export const version = "1.3.0";
1
+ export const version = "1.3.1";