Build group chat with XMTP

info

At present, the JavaScript SDK lacks support for Group Chat functionalities. Nevertheless, for those looking to integrate backend features, the CLI provides a viable solution, as detailed in this repository. For practical application, an example implementation is available on Replit. To explore group functionalities further, refer to the comprehensive Token Gated Group Chat Tutorial.

Secure group chats are an important part of every messaging app. In this guide, we delve into the essentials of using XMTP for creating secure group chats. From the initial steps of starting a new group chat, listing and caching conversations for quick access, to advanced topics like managing group members and synchronizing message history data across devices.

caution

This project is in Alpha status and ready for you to experiment with. However, we do not recommend using Alpha software in production apps. Software in this status is likely to change based on feedback.

Create a group chat

Initiate a new group chat with a list of specified addresses. To create a group, the recipient must have already started their client at least once on the XMTP network.

const group = await client.conversations.newGroup(
  [walletAddress1, walletAddress2],
  // Set permissions for the group. Options include "creator_is_admin" where only the creator has admin rights, or "everyone_is_admin" where all members are admins.
  { permissions: "creator_is_admin" },
);

val group = client.conversations.newGroup(listOf(walletAddress1, walletAddress2),
  // Set permissions for the group. Options include "creator_is_admin" where only the creator has admin rights, or "everyone_is_admin" where all members are admins.
  permissions = "creator_is_admin"
)

let group = try await client.conversations.newGroup(with: [walletAddress1, walletAddress2],
// Set permissions for the group. Options include "creator_is_admin" where only the creator has admin rights, or "everyone_is_admin" where all members are admins.
permissions: "creator_is_admin")

Send a message in a group chat

Send a message to an existing group chat. Refer to the Messages section for more details.

const group = await client.conversations.newGroup([
  walletAddress1,
  walletAddress2,
]);
// Send a message
await group.send("Hello, group!");

val group = client.conversations.newGroup(listOf(walletAddress1,walletAddress2))
//Send a message
group.send("Hello, group!")

let group = try await client.conversations.newGroup(with: [walletAddress1, walletAddress2])
//Send a message
try await group.send(content: "Hello, group!")

Synchronizing group conversations

XMTP's syncGroups brings the current data from the network and updates local DB, reflecting new groups or membership changes. Use syncGroups to:

After Signing In: Immediately update group conversation data.
Periodically: Keep data current based on your app's requirements.
After Receiving a Notification: Reflect changes in group membership prompted by notifications.

await client.conversations.syncGroups();

client.conversations.syncGroups()

List all conversations for both group and individual conversations.

// List all conversations, including both group and individual
val conversations = client.conversations.list(includeGroups = true)

try await client.conversations.sync()

List group chat conversations

Retrieve all existing group chat conversations associated with the current XMTP client. Refer to the Conversations section for more details.

//First fetch new data from the network
await client.conversations.syncGroups();
//Get the updated group list
const groups = await client.conversations.listGroups();

//First fetch new data from the network
client.conversations.syncGroups()
//Get the updated group list
val groups = client.conversations.listGroups()

List all conversations for both group and individual conversations.

// List all conversations, including both group and individual
val conversations = client.conversations.list(includeGroups = true)

//Get the updated group list
let groups = try await client.conversations.groups()

List all conversations for both group and individual conversations

let groups = try await client.conversations.list(includeGroups: true)

Check if a group chat is active

The isActive property indicates whether the current user is still a participant in the group chat. If the group chat is not active for the user, it typically means the user has been removed from the group. Developers should use this status to adjust the user interface accordingly. If a group chat is not active for a user, the application should hide or disable functionalities such as sending messages, adding, or removing members. This ensures a good user experience and prevents actions that are not permissible due to the user's status in the group chat.

const isActive = await group.isActive();

val isActive = group.isActive()

var isActive = try group.isActive()

Get group chat messages

To ensure your application has the latest group chat details, including member list and the most recent messages, it's crucial to periodically synchronize each group chat. This can be particularly important after joining a group, adding new members, or sending messages.

Group chats are currently per installation

As of now, group chats in XMTP are specific to each installation. This means that while you can access your group chat conversations across different devices, the historical messages within those chats might not automatically appear. Currently, each group chat's message history is tied to the device where it was initiated. As a result, there is no automatic syncing of message history across devices. When you sign in on a new device, you will see existing group chat conversations but will only receive new messages from that point forward. We are actively working on enhancing this feature to improve your experience with group conversations.

// Get group messages
await group.messages();

// Get group messages
group.messages();

// Get group messages
try await group.messages();

Use the sync() method on a group chat object to update its state with the latest information from the XMTP network.

Manage group chat members

You can list, add and remove members from a group chat. Only the creator of the group chat has the permissions to add or remove members. This restriction ensures that only authorized individuals can modify the participant list. Developers should design their application's user interface and functionality with this consideration in mind, ensuring that options to add or remove members are only available to the group's creator.

List group members

Retrieve a list of wallet addresses for all members in the group chat

const members = await group.memberAddresses();

val members = group.memberAddresses()

let members = group.memberAddresses()

Add group members

Add new members to an existing group chat using their wallet addresses.

await group.addMembers([walletAddress]);

group.addMembers(listOf(walletAddress))

try await group.addMembers(addresses: [walletAddress])

Remove group members

Remove members from an existing group chat using their wallet addresses.

await group.removeMembers([walletAddress]);

group.removeMembers(listOf(walletAddress))

try await group.removeMembers(addresses: [walletAddress])

Listen for new messages and updates

Streams enable real-time monitoring of new messages in a group chat as well as member management activities like adding and removing members. Here's how you can set up a stream for message updates. Refer to this section for more details on streams.

List for messages specific to a group chat

// Assuming `group` is an existing group chat object
const streamGroupMessages = async (group) => {
  const cancelGroupMessageStream = await group.streamGroupMessages(
    async (message) => {
      console.log(`New message: ${message.content}`);
      // Membership updates
      if (message.contentTypeId === ContentTypes.GroupMembershipChange) {
        const addresses = await group.memberAddresses();
        // Get new members
        console.log(addresses); // Example usage of addresses
      }
    },
  );

  // Use cancelGroupMessageStream() to stop listening to group updates
  return cancelGroupMessageStream;
};

And for streaming all conversations, including individual and groups:

const streamAllGroupMessages = async (client) => {
  const allConvos = [];
  const cancelStreamAllGroupMessages =
    await client.conversations.streamAllGroupMessages(async (message) => {
      console.log(`New message: ${message.content}`);
    });
  // Use cancelStreamAllGroupMessages() to stop listening to all conversation updates
};

// Stream new messages in a group chat
val group = client.conversations.newGroup(listOf(walletAddress1, walletAddress2))
val messageStream = group.streamMessages()

// Collect from the Flow to receive messages
messageStream.collect { message ->
    print("New message from ${message.senderAddress}: ${message.body}")
}

// Assuming `group` is an existing group chat object
for try await message in group.streamMessages() {
    print("New message: \(message.content)")
}

Listen for new group chats

Monitor the creation of new group chats.

// Listen for group chat updates
const streamGroups = async (client) => {
  const groups = [];
  const cancelStreamGroups = await client.conversations.streamGroups(
    (group) => {
      groups.push(group);
    },
  );

  // Use cancelStreamGroups() to stop listening to group updates
};

And for streaming all conversations, including individual and groups:

const streamAllConversations = async (client) => {
  const allConvos = [];
  const cancelStreamAll = await client.conversations.streamAll(
    (conversation) => {
      allConvos.push(conversation);
    },
  );

  // Use cancelStreamAll() to stop listening to all conversation updates
};

// Stream updates for all group conversations
val groupsStream = client.conversations.streamGroups()

groupsStream.collect { group ->
    println("New or updated group: ${group.id}")
}

Keep your conversation list current by streaming updates for both group and individual conversations.

// Stream updates for all conversations, including individual and groups
val conversationsAndGroupsStream = client.conversations.streamAll()

allConversationsStream.collect { grouporconv ->
    println("New or updated group or conversation: ${grouporconv.id}")
}

// Stream updates for all group conversations
for try await group in client.conversations.streamGroups() {
    print("New or updated group: \(group.id)")
}

And for streaming all conversations, including individual and groups:

// Stream updates for all conversations, including individual and groups
for try await conversation in client.conversations.streamAll() {
    print("New or updated conversation: \(conversation.id)")
}

Note on conversations and messages in group chats

It's important to note that all the features and methods described in the Conversations and Messages documentation are fully applicable to group chats as well. This includes starting new conversations, checking if an address is on the network, sending messages, and listing existing conversations. XMTP's API design ensures that you can manage group chats with the same ease and flexibility as one-on-one conversations.

This means that whether you're working with individual conversations or group chats, the process for managing them remains consistent, allowing for a unified and streamlined development experience across different types of communication within XMTP.

Build group chat with XMTP

Create a group chat​

Send a message in a group chat​

Synchronizing group conversations​

List group chat conversations​

Check if a group chat is active​

Get group chat messages​

Manage group chat members​

List group members​

Add group members​

Remove group members​

Listen for new messages and updates​

Listen for new group chats​

Note on conversations and messages in group chats​

Create a group chat

Send a message in a group chat

Synchronizing group conversations

List group chat conversations

Check if a group chat is active

Get group chat messages

Manage group chat members

List group members

Add group members

Remove group members

Listen for new messages and updates

Listen for new group chats

Note on conversations and messages in group chats