@xmtp/node-sdk 2.0.0 → 2.0.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.
Files changed (5) hide show
  1. package/README.md +29 -6
  2. package/dist/index.d.ts +730 -23
  3. package/dist/index.js +727 -19
  4. package/dist/index.js.map +1 -1
  5. package/package.json +4 -4
package/README.md CHANGED
@@ -4,11 +4,17 @@ This package provides the XMTP client SDK for Node.
4
4
 
5
5
  To keep up with the latest SDK developments, see the [Issues tab](https://github.com/xmtp/xmtp-js/issues) in this repo.
6
6
 
7
- To learn more about XMTP and get answers to frequently asked questions, see the [XMTP documentation](https://xmtp.org/docs).
8
-
9
7
  > [!CAUTION]
10
8
  > This SDK is in beta status and ready for you to build with in production. Software in this status may change based on feedback.
11
9
 
10
+ ## Documentation
11
+
12
+ To learn how to use the XMTP client SDK for Node and get answers to frequently asked questions, see the [XMTP documentation](https://docs.xmtp.org/).
13
+
14
+ ## SDK reference
15
+
16
+ Coming soon
17
+
12
18
  ## Requirements
13
19
 
14
20
  - Node.js 20+
@@ -34,10 +40,6 @@ pnpm install @xmtp/node-sdk
34
40
  yarn add @xmtp/node-sdk
35
41
  ```
36
42
 
37
- ## XMTP network environments
38
-
39
- XMTP provides `production`, `dev`, and `local` network environments to support the development phases of your project. To learn more about these environments, see our [official documentation](https://xmtp.org/docs/build/authentication#environments).
40
-
41
43
  ## Developing
42
44
 
43
45
  Run `yarn dev` to build the SDK and watch for changes, which will trigger a rebuild.
@@ -48,3 +50,24 @@ Run `yarn dev` to build the SDK and watch for changes, which will trigger a re
48
50
  - `yarn clean`: Removes `node_modules`, `dist`, and `.turbo` folders
49
51
  - `yarn test`: Runs all tests
50
52
  - `yarn typecheck`: Runs `tsc`
53
+
54
+ ## Breaking revisions
55
+
56
+ Because this SDK is in active development, you should expect breaking revisions that might require you to adopt the latest SDK release to enable your app to continue working as expected.
57
+
58
+ Breaking revisions in a Node SDK release are described on the [Releases page](https://github.com/xmtp/xmtp-js/releases).
59
+
60
+ ## Deprecation
61
+
62
+ Older versions of the SDK will eventually be deprecated, which means:
63
+
64
+ 1. The network will not support and eventually actively reject connections from clients using deprecated versions.
65
+ 2. Bugs will not be fixed in deprecated versions.
66
+
67
+ The following table provides the deprecation schedule.
68
+
69
+ | Announced | Effective | Minimum Version | Rationale |
70
+ | --------------------------- | ----------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
71
+ | No more support for XMTP V2 | May 1, 2025 | >=1.0.5 | In a move toward better security with MLS and the ability to decentralize, we will be shutting down XMTP V2 and moving entirely to XMTP V3. To learn more about V2 deprecation, see [XIP-53: XMTP V2 deprecation plan](https://community.xmtp.org/t/xip-53-xmtp-v2-deprecation-plan/867). To learn how to upgrade, see [@xmtp/node-sdk v1.0.5](https://github.com/xmtp/xmtp-js/releases/tag/%40xmtp%2Fnode-sdk%401.0.5). |
72
+
73
+ Bug reports, feature requests, and PRs are welcome in accordance with these [contribution guidelines](https://github.com/xmtp/xmtp-js/blob/main/CONTRIBUTING.md).