Skip to content

The fastest way to add ✨ to your React app, powered ⚡️ by XMTP, built with ❤️ by Relay.

License

Notifications You must be signed in to change notification settings

relay-network/receiver

Repository files navigation

Receiver is React hooks for XMTP

It's the fastest way to add xmtp-js to your React app.

Features

  • 🦾 Ergonomic hooks for working with the XMTP API.
  • 🔥 Utilizes web workers, so crypto operations don't nuke your UI.
  • 💼 Built-in multi-client support, switch between accounts seamlessly.
  • 🌀 Auto-refresh data and message streaming
  • 🦄 TypeScript native!

Coming Soon

  • 🙈 component library -- headless, fully customizable UI components for painless integration
  • 🚀 useRpc -- makes requests to an XMTP-powered RPC server
  • 🤝 useGroupChat -- group chat for XMTP!
  • 🤖 useBot -- think #ChatGXMTP (streaming, cancellable, etc.)
  • 🔒 useVault -- an e2ee encrypted self-custodial kv store
  • and more!

Documentation

Check out the live walkthrough!

Additional documentation, complete with a full API reference, coming soon!

Installation

npm install @relay-network/receiver

Developer Quick Start

./scripts.dev.sh

Examples

We've "inlined" working use cases along with their corresponding hooks (e.g., see the useClient example). To see them in action, check out the demo.

Support

The best place to get real-time support is the #developers channel in Discord. You'll get extra special attention and tons of kudos 🎉 if you also open an issue.

Community

  • Join us on Discord 💬
  • Follow Relay on Twitter for project updates 🤝

Contributing

If you're interested in contributing, please read the contributing docs before submitting a pull request.

Sponsors

Authors

License

MIT License

About

The fastest way to add ✨ to your React app, powered ⚡️ by XMTP, built with ❤️ by Relay.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages