LibXMTP Client Creation

example/src/main/java/org/xmtp/android/example/account/WalletConnectV2Account.kt

@@ -3,6 +3,7 @@ package org.xmtp.android.example.account
 import android.net.Uri
 import com.walletconnect.wcmodal.client.Modal
 import kotlinx.coroutines.flow.first
+import kotlinx.coroutines.runBlocking
 import org.web3j.crypto.Keys
 import org.xmtp.android.example.connect.getPersonalSignBody
 import org.xmtp.android.example.extension.requestMethod
@@ -14,21 +15,39 @@ import org.xmtp.proto.message.contents.SignatureOuterClass
 data class WalletConnectV2Account(
     val session: Modal.Model.ApprovedSession,
     val chain: String,
-    private val sendSessionRequestDeepLink: (Uri) -> Unit
+    private val sendSessionRequestDeepLink: (Uri) -> Unit,
 ) :
     SigningKey {
-    override val address: String
-        get() = Keys.toChecksumAddress(
-            session.namespaces.getValue(chain).accounts[0].substringAfterLast(
-                ":"
-            )
-        )
 
     override suspend fun sign(data: ByteArray): SignatureOuterClass.Signature? {
-        return sign(String(data))
+        return signLegacy(String(data))
+    }
+
+    override fun sign(text: String): ByteArray {
+        val (parentChain, chainId, account) = session.namespaces.getValue(chain).accounts[0].split(":")
+        val requestParams = session.namespaces.getValue(chain).methods.find { method ->
+            method == "personal_sign"
+        }?.let { method ->
+            Modal.Params.Request(
+                sessionTopic = session.topic,
+                method = method,
+                params = getPersonalSignBody(text, account),
+                chainId = "$parentChain:$chainId"
+            )
+        }
+
+        runCatching {
+            runBlocking {
+                requestMethod(requestParams!!, sendSessionRequestDeepLink).first().getOrThrow()
+            }
+        }.onSuccess {
+            return it
+        }.onFailure {}
+
+        return byteArrayOf()
     }
 
-    override suspend fun sign(message: String): SignatureOuterClass.Signature? {
+    override suspend fun signLegacy(message: String): SignatureOuterClass.Signature? {
         val (parentChain, chainId, account) = session.namespaces.getValue(chain).accounts[0].split(":")
         val requestParams = session.namespaces.getValue(chain).methods.find { method ->
             method == "personal_sign"
@@ -50,4 +69,12 @@ data class WalletConnectV2Account(
 
         return null
     }
+
+    override fun getAddress(): String {
+        return Keys.toChecksumAddress(
+            session.namespaces.getValue(chain).accounts[0].substringAfterLast(
+                ":"
+            )
+        )
+    }
 }

example/src/main/java/org/xmtp/android/example/connect/ConnectWalletViewModel.kt

@@ -86,7 +86,7 @@ class ConnectWalletViewModel : ViewModel() {
                 val wallet = PrivateKeyBuilder()
                 val client = Client().create(wallet, ClientManager.CLIENT_OPTIONS)
                 _uiState.value = ConnectUiState.Success(
-                    wallet.address,
+                    wallet.getAddress(),
                     PrivateKeyBundleV1Builder.encodeData(client.privateKeyBundleV1)
                 )
             } catch (e: XMTPException) {
@@ -110,7 +110,7 @@ class ConnectWalletViewModel : ViewModel() {
                 }
                 val client = Client().create(wallet, ClientManager.CLIENT_OPTIONS)
                 _uiState.value = ConnectUiState.Success(
-                    wallet.address,
+                    wallet.getAddress(),
                     PrivateKeyBundleV1Builder.encodeData(client.privateKeyBundleV1)
                 )
             } catch (e: Exception) {

library/build.gradle

@@ -14,7 +14,7 @@ dokkaGfmPartial {
 
 ktlint {
     filter {
-        exclude { it.file.path.contains("xmtp_dh") }
+        exclude { it.file.path.contains("xmtp") }
     }
 }
 

library/src/androidTest/java/org/xmtp/android/library/ClientTest.kt

@@ -2,6 +2,7 @@ package org.xmtp.android.library
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNull
 import org.junit.Assert.fail
 import org.junit.Ignore
 import org.junit.Test
@@ -39,7 +40,7 @@ class ClientTest {
         val v1Copy = PrivateKeyBundleV1Builder.fromEncodedData(encodedData)
         val client = Client().buildFrom(v1Copy)
         assertEquals(
-            wallet.address,
+            wallet.getAddress(),
             client.address,
         )
     }
@@ -78,12 +79,29 @@ class ClientTest {
         )
     }
 
+    @Test
+    fun testCreatesAV3Client() {
+        val fakeWallet = PrivateKeyBuilder()
+        val client =
+            Client().create(account = fakeWallet, options = ClientOptions(enableLibXmtpV3 = true))
+        val v3Client = client.libXMTPClient
+        assertEquals(client.address.lowercase(), v3Client?.accountAddress()?.lowercase())
+    }
+
+    @Test
+    fun testDoesNotCreateAV3Client() {
+        val fakeWallet = PrivateKeyBuilder()
+        val client = Client().create(account = fakeWallet)
+        val v3Client = client.libXMTPClient
+        assertNull(v3Client)
+    }
+
     @Test
     fun testCanMessage() {
         val fixtures = fixtures()
         val notOnNetwork = PrivateKeyBuilder()
         val canMessage = fixtures.aliceClient.canMessage(fixtures.bobClient.address)
-        val cannotMessage = fixtures.aliceClient.canMessage(notOnNetwork.address)
+        val cannotMessage = fixtures.aliceClient.canMessage(notOnNetwork.getAddress())
         assert(canMessage)
         assert(!cannotMessage)
     }
@@ -97,8 +115,8 @@ class ClientTest {
         val aliceClient = Client().create(aliceWallet, opts)
         aliceClient.ensureUserContactPublished()
 
-        val canMessage = Client.canMessage(aliceWallet.address, opts)
-        val cannotMessage = Client.canMessage(notOnNetwork.address, opts)
+        val canMessage = Client.canMessage(aliceWallet.getAddress(), opts)
+        val cannotMessage = Client.canMessage(notOnNetwork.getAddress(), opts)
 
         assert(canMessage)
         assert(!cannotMessage)

library/src/androidTest/java/org/xmtp/android/library/ConversationTest.kt

@@ -169,39 +169,39 @@ class ConversationTest {
         // Overwrite contact as legacy so we can get v1
         fixtures.publishLegacyContact(client = bobClient)
         fixtures.publishLegacyContact(client = aliceClient)
-        val bobConversation = bobClient.conversations.newConversation(aliceWallet.address)
-        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.address)
+        val bobConversation = bobClient.conversations.newConversation(aliceWallet.getAddress())
+        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.getAddress())
 
         bobConversation.send(content = "hey alice")
         bobConversation.send(content = "hey alice again")
         val messages = aliceConversation.messages()
         assertEquals(2, messages.size)
         assertEquals("hey alice", messages[1].body)
-        assertEquals(bobWallet.address, messages[1].senderAddress)
+        assertEquals(bobWallet.getAddress(), messages[1].senderAddress)
     }
 
     @Test
     fun testCanLoadV2Messages() {
         val bobConversation = bobClient.conversations.newConversation(
-            aliceWallet.address,
+            aliceWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation("hi"),
         )
 
         val aliceConversation = aliceClient.conversations.newConversation(
-            bobWallet.address,
+            bobWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation("hi"),
         )
         bobConversation.send(content = "hey alice")
         val messages = aliceConversation.messages()
         assertEquals(1, messages.size)
         assertEquals("hey alice", messages[0].body)
-        assertEquals(bobWallet.address, messages[0].senderAddress)
+        assertEquals(bobWallet.getAddress(), messages[0].senderAddress)
     }
 
     @Test
     fun testVerifiesV2MessageSignature() {
         val aliceConversation = aliceClient.conversations.newConversation(
-            bobWallet.address,
+            bobWallet.getAddress(),
             context = InvitationV1ContextBuilder.buildFromConversation(conversationId = "hi"),
         )
 
@@ -237,7 +237,7 @@ class ConversationTest {
         )
         aliceClient.publish(envelopes = listOf(tamperedEnvelope))
         val bobConversation = bobClient.conversations.newConversation(
-            aliceWallet.address,
+            aliceWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation("hi"),
         )
         assertThrows("Invalid signature", XMTPException::class.java) {
@@ -251,8 +251,8 @@ class ConversationTest {
     fun testCanSendGzipCompressedV1Messages() {
         fixtures.publishLegacyContact(client = bobClient)
         fixtures.publishLegacyContact(client = aliceClient)
-        val bobConversation = bobClient.conversations.newConversation(aliceWallet.address)
-        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.address)
+        val bobConversation = bobClient.conversations.newConversation(aliceWallet.getAddress())
+        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.getAddress())
         bobConversation.send(
             text = MutableList(1000) { "A" }.toString(),
             sendOptions = SendOptions(compression = EncodedContentCompression.GZIP),
@@ -266,8 +266,8 @@ class ConversationTest {
     fun testCanSendDeflateCompressedV1Messages() {
         fixtures.publishLegacyContact(client = bobClient)
         fixtures.publishLegacyContact(client = aliceClient)
-        val bobConversation = bobClient.conversations.newConversation(aliceWallet.address)
-        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.address)
+        val bobConversation = bobClient.conversations.newConversation(aliceWallet.getAddress())
+        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.getAddress())
         bobConversation.send(
             content = MutableList(1000) { "A" }.toString(),
             options = SendOptions(compression = EncodedContentCompression.DEFLATE),
@@ -280,11 +280,11 @@ class ConversationTest {
     @Test
     fun testCanSendGzipCompressedV2Messages() {
         val bobConversation = bobClient.conversations.newConversation(
-            aliceWallet.address,
+            aliceWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation(conversationId = "hi"),
         )
         val aliceConversation = aliceClient.conversations.newConversation(
-            bobWallet.address,
+            bobWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation(conversationId = "hi"),
         )
         bobConversation.send(
@@ -294,17 +294,17 @@ class ConversationTest {
         val messages = aliceConversation.messages()
         assertEquals(1, messages.size)
         assertEquals(MutableList(1000) { "A" }.toString(), messages[0].body)
-        assertEquals(bobWallet.address, messages[0].senderAddress)
+        assertEquals(bobWallet.getAddress(), messages[0].senderAddress)
     }
 
     @Test
     fun testCanSendDeflateCompressedV2Messages() {
         val bobConversation = bobClient.conversations.newConversation(
-            aliceWallet.address,
+            aliceWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation(conversationId = "hi"),
         )
         val aliceConversation = aliceClient.conversations.newConversation(
-            bobWallet.address,
+            bobWallet.getAddress(),
             InvitationV1ContextBuilder.buildFromConversation(conversationId = "hi"),
         )
         bobConversation.send(
@@ -314,7 +314,7 @@ class ConversationTest {
         val messages = aliceConversation.messages()
         assertEquals(1, messages.size)
         assertEquals(MutableList(1000) { "A" }.toString(), messages[0].body)
-        assertEquals(bobWallet.address, messages[0].senderAddress)
+        assertEquals(bobWallet.getAddress(), messages[0].senderAddress)
     }
 
     @Test
@@ -324,8 +324,8 @@ class ConversationTest {
         fakeContactClient.publishUserContact()
         val fakeWallet = PrivateKeyBuilder()
         val client = Client().create(account = fakeWallet)
-        val contact = client.getUserContact(peerAddress = fakeContactWallet.address)!!
-        assertEquals(contact.walletAddress, fakeContactWallet.address)
+        val contact = client.getUserContact(peerAddress = fakeContactWallet.getAddress())!!
+        assertEquals(contact.walletAddress, fakeContactWallet.getAddress())
         val created = Date()
         val invitationContext = Invitation.InvitationV1.Context.newBuilder().also {
             it.conversationId = "https://example.com/1"
@@ -338,7 +338,7 @@ class ConversationTest {
         val senderBundle = client.privateKeyBundleV1?.toV2()
         assertEquals(
             senderBundle?.identityKey?.publicKey?.recoverWalletSignerPublicKey()?.walletAddress,
-            fakeWallet.address,
+            fakeWallet.getAddress(),
         )
         val invitation = SealedInvitationBuilder.buildFromV1(
             sender = client.privateKeyBundleV1!!.toV2(),
@@ -347,12 +347,12 @@ class ConversationTest {
             invitation = invitationv1,
         )
         val inviteHeader = invitation.v1.header
-        assertEquals(inviteHeader.sender.walletAddress, fakeWallet.address)
-        assertEquals(inviteHeader.recipient.walletAddress, fakeContactWallet.address)
+        assertEquals(inviteHeader.sender.walletAddress, fakeWallet.getAddress())
+        assertEquals(inviteHeader.recipient.walletAddress, fakeContactWallet.getAddress())
         val header = SealedInvitationHeaderV1.parseFrom(invitation.v1.headerBytes)
         val conversation =
             ConversationV2.create(client = client, invitation = invitationv1, header = header)
-        assertEquals(fakeContactWallet.address, conversation.peerAddress)
+        assertEquals(fakeContactWallet.getAddress(), conversation.peerAddress)
 
         conversation.send(content = "hello world")
 
@@ -734,8 +734,8 @@ class ConversationTest {
     fun testCanSendEncodedContentV1Message() {
         fixtures.publishLegacyContact(client = bobClient)
         fixtures.publishLegacyContact(client = aliceClient)
-        val bobConversation = bobClient.conversations.newConversation(aliceWallet.address)
-        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.address)
+        val bobConversation = bobClient.conversations.newConversation(aliceWallet.getAddress())
+        val aliceConversation = aliceClient.conversations.newConversation(bobWallet.getAddress())
         val encodedContent = TextCodec().encode(content = "hi")
         bobConversation.send(encodedContent = encodedContent)
         val messages = aliceConversation.messages()
@@ -745,7 +745,7 @@ class ConversationTest {
 
     @Test
     fun testCanSendEncodedContentV2Message() {
-        val bobConversation = bobClient.conversations.newConversation(aliceWallet.address)
+        val bobConversation = bobClient.conversations.newConversation(aliceWallet.getAddress())
         val encodedContent = TextCodec().encode(content = "hi")
         bobConversation.send(encodedContent = encodedContent)
         val messages = bobConversation.messages()

library/src/androidTest/java/org/xmtp/android/library/ConversationsTest.kt

@@ -45,7 +45,7 @@ class ConversationsTest {
             message = MessageBuilder.buildFromMessageV1(v1 = message).toByteArray()
         )
         val conversation = client.conversations.fromIntro(envelope = envelope)
-        assertEquals(conversation.peerAddress, newWallet.address)
+        assertEquals(conversation.peerAddress, newWallet.getAddress())
         assertEquals(conversation.createdAt.time, created.time)
     }
 
@@ -73,7 +73,7 @@ class ConversationsTest {
             message = sealed.toByteArray()
         )
         val conversation = client.conversations.fromInvite(envelope = envelope)
-        assertEquals(conversation.peerAddress, newWallet.address)
+        assertEquals(conversation.peerAddress, newWallet.getAddress())
         assertEquals(conversation.createdAt.time, created.time)
     }