Consent V3

Package.swift

@@ -25,7 +25,7 @@ let package = Package(
 		.package(url: "https://github.com/1024jp/GzipSwift", from: "5.2.0"),
 		.package(url: "https://github.com/bufbuild/connect-swift", exact: "0.12.0"),
 		.package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.0.0"),
-		.package(url: "https://github.com/xmtp/libxmtp-swift.git", exact: "0.5.8-beta5"),
+		.package(url: "https://github.com/xmtp/libxmtp-swift.git", exact: "0.5.8-beta6"),
 	],
 	targets: [
 		// Targets are the basic building blocks of a package. A target can define a module or a test suite.

Sources/XMTPiOS/Contacts.swift

@@ -13,12 +13,11 @@ public typealias PrivatePreferencesAction = Xmtp_MessageContents_PrivatePreferen
 public enum ConsentState: String, Codable {
 	case allowed, denied, unknown
 }
+public enum EntryType: String, Codable {
+	case address, group_id, inbox_id
+}
 
 public struct ConsentListEntry: Codable, Hashable {
-	public enum EntryType: String, Codable {
-		case address, group_id, inbox_id
-	}
-
 	static func address(_ address: String, type: ConsentState = .unknown) -> ConsentListEntry {
 		ConsentListEntry(value: address, entryType: .address, consentType: type)
 	}
@@ -125,6 +124,9 @@ public class ConsentList {
 	}
 
     func publish(entries: [ConsentListEntry]) async throws {
+		if (client.v3Client != nil) {
+			try await setV3ConsentState(entries: entries)
+		}
 		if (client.hasV2Client) {
 			let privateKey = try client.v1keys.identityKey.secp256K1.bytes
 			let publicKey = try client.v1keys.identityKey.publicKey.secp256K1Uncompressed.bytes
@@ -180,7 +182,11 @@ public class ConsentList {
 
 			try await client.publish(envelopes: [envelope])
 		}
-  }
+	}
+
+	func setV3ConsentState(entries: [ConsentListEntry]) async throws {
+		try await client.v3Client?.setConsentStates(records: entries.map(\.toFFI))
+	}
 
 	func allow(address: String) async -> ConsentListEntry {
 		let entry = ConsentListEntry.address(address, type: ConsentState.allowed)
@@ -224,23 +230,44 @@ public class ConsentList {
 		return entry
 	}
 
-	func state(address: String) async -> ConsentState {
+	func state(address: String) async throws -> ConsentState {
+		if let client = client.v3Client {
+			return try await client.getConsentState(
+				entityType: .address,
+				entity: address
+			).fromFFI
+		}
+
 		guard let entry = await entriesManager.get(ConsentListEntry.address(address).key) else {
 			return .unknown
 		}
 
 		return entry.consentType
 	}
 
-	func groupState(groupId: String) async -> ConsentState {
+	func groupState(groupId: String) async throws -> ConsentState {
+		if let client = client.v3Client {
+			return try await client.getConsentState(
+				entityType: .groupId,
+				entity: groupId
+			).fromFFI
+		}
+
 		guard let entry =  await entriesManager.get(ConsentListEntry.groupId(groupId: groupId).key) else {
 			return .unknown
 		}
 
 		return entry.consentType
 	}
 
-	func inboxIdState(inboxId: String) async -> ConsentState {
+	func inboxIdState(inboxId: String) async throws-> ConsentState {
+		if let client = client.v3Client {
+			return try await client.getConsentState(
+				entityType: .inboxId,
+				entity: inboxId
+			).fromFFI
+		}
+
 		guard let entry = await entriesManager.get(ConsentListEntry.inboxId(inboxId).key) else {
 			return .unknown
 		}
@@ -266,33 +293,34 @@ public actor Contacts {
 		consentList = ConsentList(client: client)
 	}
 
-  public func refreshConsentList() async throws -> ConsentList {
-		_ = try await consentList.load()
+	public func refreshConsentList() async throws -> ConsentList {
+		let entries = try await consentList.load()
+		try await consentList.setV3ConsentState(entries: entries)
 		return consentList
 	}
 
-	public func isAllowed(_ address: String) async -> Bool {
-		return await consentList.state(address: address) == .allowed
+	public func isAllowed(_ address: String) async throws -> Bool {
+		return try await consentList.state(address: address) == .allowed
 	}
 
-	public func isDenied(_ address: String) async -> Bool {
-		return await consentList.state(address: address) == .denied
+	public func isDenied(_ address: String) async throws -> Bool {
+		return try await consentList.state(address: address) == .denied
 	}
 
-	public func isGroupAllowed(groupId: String) async -> Bool {
-		return await consentList.groupState(groupId: groupId) == .allowed
+	public func isGroupAllowed(groupId: String) async throws -> Bool {
+		return try await consentList.groupState(groupId: groupId) == .allowed
 	}
 
-	public func isGroupDenied(groupId: String) async -> Bool {
-		return await consentList.groupState(groupId: groupId) == .denied
+	public func isGroupDenied(groupId: String) async throws -> Bool {
+		return try await consentList.groupState(groupId: groupId) == .denied
 	}
 
-	public func isInboxAllowed(inboxId: String) async -> Bool {
-		return await consentList.inboxIdState(inboxId: inboxId) == .allowed
+	public func isInboxAllowed(inboxId: String) async throws -> Bool {
+		return try await consentList.inboxIdState(inboxId: inboxId) == .allowed
 	}
 
-	public func isInboxDenied(inboxId: String) async -> Bool {
-		return await consentList.inboxIdState(inboxId: inboxId) == .denied
+	public func isInboxDenied(inboxId: String) async throws -> Bool {
+		return try await consentList.inboxIdState(inboxId: inboxId) == .denied
 	}
 
 	public func allow(addresses: [String]) async throws {

Sources/XMTPiOS/Conversation.swift

@@ -37,7 +37,7 @@ public enum Conversation: Sendable {
 		case .v2(let conversationV2):
 			return try await conversationV2.client.contacts.consentList.state(address: peerAddress)
 		case let .group(group):
-			return await group.client.contacts.consentList.groupState(groupId: group.id)
+			return try group.consentState()
 		}
 	}
 

Sources/XMTPiOS/ConversationV1.swift

@@ -140,7 +140,7 @@ public struct ConversationV1 {
 
     @discardableResult func send(prepared: PreparedMessage) async throws -> String {
         try await client.publish(envelopes: prepared.envelopes)
-        if((await client.contacts.consentList.state(address: peerAddress)) == .unknown) {
+        if((try await client.contacts.consentList.state(address: peerAddress)) == .unknown) {
             try await client.contacts.allow(addresses: [peerAddress])
         }
         return prepared.messageID

Sources/XMTPiOS/ConversationV2.swift

@@ -256,7 +256,7 @@ public struct ConversationV2 {
 
     @discardableResult func send(prepared: PreparedMessage) async throws -> String {
         try await client.publish(envelopes: prepared.envelopes)
-        if((await client.contacts.consentList.state(address: peerAddress)) == .unknown) {
+        if((try await client.contacts.consentList.state(address: peerAddress)) == .unknown) {
             try await client.contacts.allow(addresses: [peerAddress])
         }
         return prepared.messageID

Sources/XMTPiOS/Conversations.swift

@@ -751,7 +751,7 @@ public actor Conversations {
 		}
 		let contacts = client.contacts
 		_ = try await contacts.refreshConsentList()
-		if await (contacts.consentList.state(address: peerAddress) == .unknown) {
+		if try await (contacts.consentList.state(address: peerAddress) == .unknown) {
 			try await contacts.allow(addresses: [peerAddress])
 		}
 	}

Sources/XMTPiOS/Extensions/Ffi.swift

@@ -206,3 +206,39 @@ extension FfiGroupMember {
 		Member(ffiGroupMember: self)
 	}
 }
+
+extension ConsentState {
+	var toFFI: FfiConsentState{
+		switch (self) {
+		case .allowed: return FfiConsentState.allowed
+		case .denied: return FfiConsentState.denied
+		default: return FfiConsentState.unknown
+		}
+	}
+}
+
+extension FfiConsentState {
+	var fromFFI: ConsentState{
+		switch (self) {
+		case .allowed: return ConsentState.allowed
+		case .denied: return ConsentState.denied
+		default: return ConsentState.unknown
+		}
+	}
+}
+
+extension EntryType {
+	var toFFI: FfiConsentEntityType{
+		switch (self) {
+		case .group_id: return FfiConsentEntityType.groupId
+		case .inbox_id: return FfiConsentEntityType.inboxId
+		case .address: return FfiConsentEntityType.address
+		}
+	}
+}
+
+extension ConsentListEntry {
+	var toFFI: FfiConsent {
+		FfiConsent(entityType: entryType.toFFI, state: consentType.toFFI, entity: value)
+	}
+}

Sources/XMTPiOS/Group.swift

@@ -213,6 +213,21 @@ public struct Group: Identifiable, Equatable, Hashable {
         try await ffiGroup.updatePermissionPolicy(permissionUpdateType: FfiPermissionUpdateType.updateMetadata, permissionPolicyOption: PermissionOption.toFfiPermissionPolicy(option: newPermissionOption), metadataField: FfiMetadataField.pinnedFrameUrl)
 	}
 
+	public func updateConsentState(state: ConsentState) async throws {
+		if (client.hasV2Client) {
+			switch (state) {
+			case .allowed: try await client.contacts.allowGroups(groupIds: [id])
+			case .denied: try await client.contacts.denyGroups(groupIds: [id])
+			case .unknown: ()
+			}
+		}
+
+		try ffiGroup.updateConsentState(state: state.toFFI)
+	}
+
+	public func consentState() throws -> ConsentState{
+		return try ffiGroup.consentState().fromFFI
+	}
 
 	public func processMessage(envelopeBytes: Data) async throws -> DecodedMessage {
 		let message = try await ffiGroup.processStreamedGroupMessage(envelopeBytes: envelopeBytes)
@@ -230,10 +245,8 @@ public struct Group: Identifiable, Equatable, Hashable {
 	}
 
 	public func send(encodedContent: EncodedContent) async throws -> String {
-		let groupState = await client.contacts.consentList.groupState(groupId: id)
-
-		if groupState == ConsentState.unknown {
-			try await client.contacts.allowGroups(groupIds: [id])
+		if (try consentState() == .unknown) {
+			try await updateConsentState(state: .allowed)
 		}
 
 		let messageId = try await ffiGroup.send(contentBytes: encodedContent.serializedData())
@@ -273,10 +286,8 @@ public struct Group: Identifiable, Equatable, Hashable {
 	}
 
 	public func prepareMessage<T>(content: T, options: SendOptions? = nil) async throws -> String {
-		let groupState = await client.contacts.consentList.groupState(groupId: id)
-
-		if groupState == ConsentState.unknown {
-			try await client.contacts.allowGroups(groupIds: [id])
+		if (try consentState() == .unknown) {
+			try await updateConsentState(state: .allowed)
 		}
 
 		let encodeContent = try await encodeContent(content: content, options: options)

Sources/XMTPiOS/Mls/Member.swift

@@ -37,5 +37,9 @@ public struct Member {
             return PermissionLevel.SuperAdmin
         }
 	}
+
+	public var consentState: ConsentState {
+		ffiGroupMember.consentState.fromFFI
+	}
 }
 

Tests/XMTPTests/ContactsTests.swift

@@ -37,27 +37,27 @@ class ContactsTests: XCTestCase {
 		let fixtures = await fixtures()
 
 		let contacts = fixtures.bobClient.contacts
-		var result = await contacts.isAllowed(fixtures.alice.address)
+		var result = try await contacts.isAllowed(fixtures.alice.address)
 
 		XCTAssertFalse(result)
 
 		try await contacts.allow(addresses: [fixtures.alice.address])
 
-		result = await contacts.isAllowed(fixtures.alice.address)
+		result = try await contacts.isAllowed(fixtures.alice.address)
 		XCTAssertTrue(result)
 	}
 
 	func testDenyAddress() async throws {
 		let fixtures = await fixtures()
 
 		let contacts = fixtures.bobClient.contacts
-		var result = await contacts.isAllowed(fixtures.alice.address)
+		var result = try await contacts.isAllowed(fixtures.alice.address)
 
 		XCTAssertFalse(result)
 
 		try await contacts.deny(addresses: [fixtures.alice.address])
 
-		result = await contacts.isDenied(fixtures.alice.address)
+		result = try await contacts.isDenied(fixtures.alice.address)
 		XCTAssertTrue(result)
 	}
 
@@ -67,21 +67,21 @@ class ContactsTests: XCTestCase {
 		let caroClient = try await Client.create(account: caro, options: fixtures.clientOptions)
 
         let contacts = fixtures.bobClient.contacts
-        var result = await contacts.isAllowed(fixtures.alice.address)
+        var result = try await contacts.isAllowed(fixtures.alice.address)
         XCTAssertFalse(result)
-        result = await contacts.isAllowed(caroClient.address)
+        result = try await contacts.isAllowed(caroClient.address)
         XCTAssertFalse(result)
 
         try await contacts.deny(addresses: [fixtures.alice.address, caroClient.address])
 
-        var aliceResult = await contacts.isDenied(fixtures.alice.address)
+        var aliceResult = try await contacts.isDenied(fixtures.alice.address)
         XCTAssertTrue(aliceResult)
-        var caroResult = await contacts.isDenied(fixtures.alice.address)
+        var caroResult = try await contacts.isDenied(fixtures.alice.address)
         XCTAssertTrue(caroResult)
         try await contacts.allow(addresses: [fixtures.alice.address, caroClient.address])
-        aliceResult = await contacts.isAllowed(fixtures.alice.address)
+        aliceResult = try await contacts.isAllowed(fixtures.alice.address)
         XCTAssertTrue(aliceResult)
-        caroResult = await contacts.isAllowed(fixtures.alice.address)
+        caroResult = try await contacts.isAllowed(fixtures.alice.address)
         XCTAssertTrue(caroResult)
     }
 }

Tests/XMTPTests/ConversationsTest.swift

@@ -206,7 +206,7 @@ class ConversationsTests: XCTestCase {
 		fixtures.aliceClient.conversations.list()
         let alixConversation = alixConversations.first(where: { $0.topic == boConversation.topic })
         XCTAssertNotNil(alixConversation)
-        let consentStatus = await fixtures.aliceClient.contacts.isAllowed(fixtures.bobClient.address)
+        let consentStatus = try await fixtures.aliceClient.contacts.isAllowed(fixtures.bobClient.address)
         XCTAssertTrue(consentStatus)
     }
 
@@ -228,7 +228,7 @@ class ConversationsTests: XCTestCase {
 			fixtures.aliceClient.conversations.list()
         let alixConversation = alixConversations.first(where: { $0.topic == boConversation.topic })
         XCTAssertNotNil(alixConversation)
-        let isDenied = await fixtures.aliceClient.contacts.isDenied(fixtures.bobClient.address)
+        let isDenied = try await fixtures.aliceClient.contacts.isDenied(fixtures.bobClient.address)
         XCTAssertTrue(isDenied)
     }
 
@@ -250,7 +250,7 @@ class ConversationsTests: XCTestCase {
 			fixtures.aliceClient.conversations.list()
         let alixConversation = alixConversations.first(where: { $0.topic == boConversation.topic })
         XCTAssertNotNil(alixConversation)
-        let isAllowed = await fixtures.aliceClient.contacts.isAllowed(fixtures.bobClient.address)
+        let isAllowed = try await fixtures.aliceClient.contacts.isAllowed(fixtures.bobClient.address)
         XCTAssertFalse(isAllowed)
     }
 }