@xmtp/browser-sdk
v0.0.2
Published
XMTP client SDK for browsers written in TypeScript
Downloads
67
Readme
XMTP client SDK for browsers
This package provides the XMTP client SDK for browsers.
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
Response headers
Server response headers must be set to the following values:
Cross-Origin-Embedder-Policy: require-corp
Cross-Origin-Opener-Policy: same-origin
Bundlers
This SDK uses a WebAssembly (WASM) module and bundlers must be configured properly to handle it.
Vite
Add the following to vite.config.ts
:
import { defineConfig } from "vite";
// https://vitejs.dev/config/
export default defineConfig({
optimizeDeps: {
exclude: ["@xmtp/wasm-bindings"],
},
});
Next.js
Add the following to next.config.mjs
:
const nextConfig = {
serverComponentsExternalPackages: ["@xmtp/wasm-bindings"],
};
export default nextConfig;
Install
NPM
npm install @xmtp/browser-sdk
PNPM
pnpm install @xmtp/browser-sdk
Yarn
yarn add @xmtp/browser-sdk
Reference docs
Access the XMTP client browser SDK reference documentation.
Usage
Check out our official documentation to get started developing with XMTP.
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.
Important
When you create a client, it connects to the XMTPdev
environment by default. To learn how to use theenv
parameter to set your client's network environment, see Configure the client.
Breaking revisions
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.
XMTP communicates about breaking revisions in the XMTP Discord community, providing as much advance notice as possible. Additionally, breaking revisions in a release are described on the Releases page.
Deprecation
Older versions of the SDK will eventually be deprecated, which means:
- The network will not support and eventually actively reject connections from clients using deprecated versions.
- Bugs will not be fixed in deprecated versions.
The following table provides the deprecation schedule.
| Announced | Effective | Minimum Version | Rationale | | -------------------------------------------------------------- | --------- | --------------- | --------- | | There are no deprecations scheduled for this SDK at this time. | | | |
Bug reports, feature requests, and PRs are welcome in accordance with these contribution guidelines.
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 dev
: Builds the SDK and watches for changes, which will trigger a rebuildyarn test
: Runs all testsyarn typecheck
: Runstsc