@xmtp/node-sdk
v0.0.35
Published
XMTP Node client SDK for interacting with XMTP networks
Downloads
2,981
Readme
XMTP client SDK for Node
This package provides the XMTP client SDK for Node.
To keep up with the latest SDK developments, see the Issues tab in this repo.
To learn more about XMTP and get answers to frequently asked questions, see the XMTP documentation.
[!CAUTION] This SDK is currently in alpha. The API is subject to change and it is not yet recommended for production use.
Requirements
- Node.js 20+
glibc
3.28+ (i.e. Ubuntu 24.04 or later)
Install
NPM
npm install @xmtp/node-sdk
PNPM
pnpm install @xmtp/node-sdk
Yarn
yarn add @xmtp/node-sdk
XMTP network environments
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.
Developing
Run yarn dev
to build the SDK and watch for changes, which will trigger a rebuild.
Useful commands
yarn build
: Builds the SDKyarn clean
: Removesnode_modules
,dist
, and.turbo
foldersyarn test
: Runs all testsyarn typecheck
: Runstsc