Skip to content

Latest commit

 

History

History
293 lines (190 loc) · 17.3 KB

README.md

File metadata and controls

293 lines (190 loc) · 17.3 KB
Raw

xmtp-android

Test Lint Status

xmtp-android provides a Kotlin implementation of an XMTP message API client for use with Android apps.

Use xmtp-android to build with XMTP to send messages between blockchain accounts, including DMs, notifications, announcements, and more.

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.

x-red-sm

Example app built with xmtp-android

Use the XMTP Android quickstart app as a tool to start building an app with XMTP. This basic messaging app has an intentionally unopinionated UI to help make it easier for you to build with.

To learn about example app push notifications, see Enable the quickstart app to send push notifications.

Reference docs

View the reference Access the Kotlin client SDK reference documentation.

Install from Maven Central

You can find the latest package version on Maven Central.

    implementation 'org.xmtp:android:X.X.X'

Usage overview

The XMTP message API revolves around a message API client (client) that allows retrieving and sending messages to other XMTP network participants. A client must connect to a wallet app on startup. If this is the very first time the client is created, the client will generate a identity with a encrypted local database to store and retrieve messages. Each additional log in will create a new installation if a local database is not present.

// You'll want to replace this with a wallet from your application.
val account = PrivateKeyBuilder()

// A key to encrypt the local database
val encryptionKey = SecureRandom().generateSeed(32)

// Application context for creating the local database
val context = getApplication()

// The required client options
val clientOptions = ClientOptions(
    ClientOptions.Api(XMTPEnvironment.DEV, isSecure = true),
    dbEncryptionKey = encryptionKey,
    appContext = context,
)

// Create the client with your wallet. This will connect to the XMTP `dev` network by default.
// The account is anything that conforms to the `XMTP.SigningKey` protocol.
val client = Client().create(account = account, options = clientOptions)

// Start a dm conversation
val conversation = client.conversations.newConversation("0x3F11b27F323b62B159D2642964fa27C46C841897")
// Or a group conversation
val groupConversation = client.conversations.newGroup(listOf("0x3F11b27F323b62B159D2642964fa27C46C841897"))

// Load all messages in the conversations
val messages = conversation.messages()

// Send a message
conversation.send(text = "gm")

// Listen for new messages in the conversation
conversation.streamMessages().collect {
    print("${it.senderAddress}: ${it.body}")
}

Create a client

A client is created with Client().create(account: SigningKey, options: ClientOptions): Client that requires passing in an object capable of creating signatures on your behalf. The client will request a signature for any new installation.

Note The client connects to the XMTP dev environment by default. Use ClientOptions to change this and other parameters of the network connection.

// Create the client with a `SigningKey` from your app
val options = ClientOptions(api = ClientOptions.Api(env = XMTPEnvironment.PRODUCTION, isSecure = true), dbEncryptionKey = encryptionKey, appContext = context)
val client = Client().create(account = account, options = options)

Create a client from saved encryptionKey

You can save your encryptionKey for the local database and build the client via address:

// Create the client with a `SigningKey` from your app
val options = ClientOptions(api = ClientOptions.Api(env = XMTPEnvironment.PRODUCTION, isSecure = true), dbEncryptionKey = encryptionKey, appContext = context)
val client = Client().build(address = account.address, options = options)

Configure the client

You can configure the client with these parameters of Client.create:

Parameter Default Description
env DEV Connect to the specified XMTP network environment. Valid values include DEV, .PRODUCTION, or LOCAL. For important details about working with these environments, see XMTP production and dev network environments.
appContext REQUIRED The application context used to create and access the local database.
dbEncryptionKey REQUIRED A 32 ByteArray used to encrypt the local database.
historySyncUrl https://message-history.dev.ephemera.network/ The history sync url used to specify where history can be synced from other devices on the network.
appVersion undefined Add a client app version identifier that's included with API requests.
For example, you can use the following format: appVersion: APP_NAME + '/' + APP_VERSION.
Setting this value provides telemetry that shows which apps are using the XMTP client SDK. This information can help XMTP developers provide app support, especially around communicating important SDK updates, including deprecations and required upgrades.

Configure env

Handle conversations

Most of the time, when interacting with the network, you'll want to do it through conversations. Conversations are between two accounts.

List all dm & group conversations

If your app would like to handle groups and dms differently you can check whether a conversation is a dm or group for the type

val conversations = client.conversations.list()

for (conversation in conversations) {
    when (conversation.type) {
        is Group -> // Handle group
        is Dm -> // Handle dm
    }
}

List all groups

val conversations = client.conversations.listGroups()

List all dms

val conversations = client.conversations.listDms()

These conversations include all conversations for a user regardless of which app created the conversation. This functionality provides the concept of an interoperable inbox, which enables a user to access all of their conversations in any app built with XMTP.

Listen for new conversations

You can also listen for new conversations being started in real-time. This will allow apps to display incoming messages from new contacts.

client.conversations.stream().collect {
    print("New conversation started with ${it.peerAddress}")
    // Say hello to your new friend
    it.send(text = "Hi there!")
}

Start a new conversation

You can create a new conversation with any Ethereum address on the XMTP network.

val newDm = client.conversations.newConversation("0x3F11b27F323b62B159D2642964fa27C46C841897")
val newGroup = client.conversations.newGroup("listOf(0x3F11b27F323b62B159D2642964fa27C46C841897)")

Send messages

To be able to send a message, the recipient must have already created a client at least once. Messages are addressed using account addresses. In this example, the message payload is a plain text string.

val conversation = client.conversations.newConversation("0x3F11b27F323b62B159D2642964fa27C46C841897")
conversation.send(text = "Hello world")

To learn how to send other types of content, see Handle different content types.

List messages in a conversation

You can receive the complete message history in a conversation by calling conversation.messages()

   conversation.messages()

List messages in a conversation with pagination

It may be helpful to retrieve and process the messages in a conversation page by page. You can do this by calling conversation.messages(limit: Int, before: Date) which will return the specified number of messages sent before that time.

val messages = conversation.messages(limit = 25)
val nextPage = conversation.messages(limit = 25, beforeNs = messages[0].sentNs)

Listen for new messages in a conversation

You can listen for any new messages (incoming or outgoing) in a conversation by calling conversation.streamMessages().

A successfully received message (that makes it through the decoding and decryption without throwing) can be trusted to be authentic. Authentic means that it was sent by the owner of the message.senderAddress account and that it wasn't modified in transit. The message.sent timestamp can be trusted to have been set by the sender.

The flow returned by the stream methods is an asynchronous data stream that sequentially emits values and completes normally or with an exception.

conversation.streamMessages().collect {
    if (it.senderAddress == client.address) {
        // This message was sent from me
    }

    print("New message from ${it.senderAddress}: ${it.body}")
}

Request and respect user consent

Feature status

The user consent feature enables your app to request and respect user consent preferences. With this feature, another blockchain account address registered on the XMTP network can have one of three consent preference values:

  • Unknown
  • Allowed
  • Denied

To learn more, see Request and respect user consent.

Handle different types of content

All the send functions support SendOptions as an optional parameter. The contentType option allows specifying different types of content than the default simple string, which is identified with content type identifier ContentTypeText.

To learn more about content types, see Content types with XMTP.

Support for other types of content can be added by registering additional ContentCodecs with the Client. Every codec is associated with a content type identifier, ContentTypeId, which is used to signal to the Client which codec should be used to process the content that is being sent or received.

// Assuming we've loaded a fictional NumberCodec that can be used to encode numbers,
// and is identified with ContentTypeNumber, we can use it as follows.
Client.register(codec = NumberCodec())

val options = ClientOptions(api = ClientOptions.Api(contentType = ContentTypeNumber, contentFallback = "sending you a pie"))
aliceConversation.send(content = 3.14, options = options)

As shown in the example above, you must provide a contentFallback value. Use it to provide an alt text-like description of the original content. Providing a contentFallback value enables clients that don't support the content type to still display something meaningful.

Caution If you don't provide a contentFallback value, clients that don't support the content type will display an empty message. This results in a poor user experience and breaks interoperability.

Handle custom content types

Beyond this, custom codecs and content types may be proposed as interoperable standards through XRCs. To learn more about the custom content type proposal process, see XIP-5.

🏗 Breaking revisions

Because xmtp-android 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 an xmtp-android release are described on the Releases page.

Deprecation

Older versions of the SDK will eventually be deprecated, which means:

  1. The network will not support and eventually actively reject connections from clients using deprecated versions.
  2. Bugs will not be fixed in deprecated versions.

The following table provides the deprecation schedule.

Announced Effective Minimum Version Rationale
No more support for V2 March 1, 2025 3.0.0 In a move towards better security with MLS and the ability to decentralize we will be shutting down V2 and moving entirely to V3 MLS. You can see the legacy branch here: https://github.com/xmtp/xmtp-android/tree/xmtp-legacy

Bug reports, feature requests, and PRs are welcome in accordance with these contribution guidelines.

XMTP production and dev network environments

XMTP provides both production and dev network environments to support the development phases of your project.

The production and dev networks are completely separate and not interchangeable. For example, for a given blockchain account, its XMTP identity on dev network is completely distinct from its XMTP identity on the production network, as are the messages associated with these identities. In addition, XMTP identities and messages created on the dev network can't be accessed from or moved to the production network, and vice versa.

Note When you create a client, it connects to the XMTP dev environment by default. To learn how to use the env parameter to set your client's network environment, see Configure the client.

The env parameter accepts one of three valid values: dev, production, or local. Here are some best practices for when to use each environment:

  • dev: Use to have a client communicate with the dev network. As a best practice, set env to dev while developing and testing your app. Follow this best practice to isolate test messages to dev inboxes.

  • production: Use to have a client communicate with the production network. As a best practice, set env to production when your app is serving real users. Follow this best practice to isolate messages between real-world users to production inboxes.

  • local: Use to have a client communicate with an XMTP node you are running locally. For example, an XMTP node developer can set env to local to generate client traffic to test a node running locally.

The production network is configured to store messages indefinitely. XMTP may occasionally delete messages and keys from the dev network, and will provide advance notice in the XMTP Discord community.