Merge pull request #146 from xmtp/st/group-preference-actions

feat: Adds AllowGroup and DenyGroup messages
xmtp · Feb 15, 2024 · 5fb756a · 5fb756a
2 parents 59ab892 + e3fba9c
commit 5fb756a
Show file tree

Hide file tree

Showing 20 changed files with 98 additions and 80 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-This is the authoritative source of information about the XTMP protocol itself. It contains
+This is the authoritative source of information about the XMTP protocol itself. It contains
 
 * an overview of the protocol [PROTOCOL.md](https://github.com/xmtp/proto/blob/main/PROTOCOL.md)
 * the protobuf definitions of all the elements of the protocol [/proto](https://github.com/xmtp/proto/blob/main/proto)

diff --git a/go/keystore_api/v1/keystore.pb.go b/go/keystore_api/v1/keystore.pb.go
diff --git a/go/message_api/v1/authn.pb.go b/go/message_api/v1/authn.pb.go
diff --git a/go/message_api/v1/message_api.pb.go b/go/message_api/v1/message_api.pb.go
diff --git a/go/message_api/v1/message_api_grpc.pb.go b/go/message_api/v1/message_api_grpc.pb.go
diff --git a/go/message_contents/ciphertext.pb.go b/go/message_contents/ciphertext.pb.go
diff --git a/go/message_contents/composite.pb.go b/go/message_contents/composite.pb.go
diff --git a/go/message_contents/contact.pb.go b/go/message_contents/contact.pb.go
diff --git a/go/message_contents/content.pb.go b/go/message_contents/content.pb.go
diff --git a/go/message_contents/conversation_reference.pb.go b/go/message_contents/conversation_reference.pb.go
diff --git a/go/message_contents/invitation.pb.go b/go/message_contents/invitation.pb.go
diff --git a/go/message_contents/message.pb.go b/go/message_contents/message.pb.go
diff --git a/go/message_contents/private_key.pb.go b/go/message_contents/private_key.pb.go
diff --git a/go/message_contents/public_key.pb.go b/go/message_contents/public_key.pb.go
diff --git a/go/message_contents/signature.pb.go b/go/message_contents/signature.pb.go
diff --git a/go/mls/api/v1/mls.pb.go b/go/mls/api/v1/mls.pb.go
diff --git a/go/mls/api/v1/mls_grpc.pb.go b/go/mls/api/v1/mls_grpc.pb.go
diff --git a/go/mls_validation/v1/service.pb.go b/go/mls_validation/v1/service.pb.go
diff --git a/go/mls_validation/v1/service_grpc.pb.go b/go/mls_validation/v1/service_grpc.pb.go
diff --git a/proto/message_contents/private_preferences.proto b/proto/message_contents/private_preferences.proto
@@ -1,7 +1,7 @@
 // Private Key Storage
 //
-// Following definitions are not used in the protocol, instead
-// they provide a way for encoding private keys for storage.
+// Following definitions are not used in the protocol, instead they provide a
+// way for encoding private keys for storage.
 syntax = "proto3";
 
 package xmtp.message_contents;
@@ -11,28 +11,42 @@ import "message_contents/ciphertext.proto";
 option go_package = "github.com/xmtp/proto/v3/go/message_contents";
 option java_package = "org.xmtp.proto.message.contents";
 
-// PrivatePreferencesAction is a message used to update the client's
-// preference store. The only current actions are allow and block.
-// Other actions may be added later
+// PrivatePreferencesAction is a message used to update the client's preference
+// store.
 message PrivatePreferencesAction {
-  // Add the given wallet addresses to the allow list
-  message Allow {
+  // Allow 1:1 direct message (DM) access
+  message AllowDM {
+    // Add the given wallet addresses to the allow list
     repeated string wallet_addresses = 1;
   }
-  // Add the given wallet addresses to the block list
-  message Block {
+
+  // Deny (block) 1:1 direct message (DM) access
+  message DenyDM {
+    // Add the given wallet addresses to the deny list
     repeated string wallet_addresses = 1;
   }
 
+  // Allow Group access
+  message AllowGroup {
+    // Add the given group_ids to the allow list
+    repeated bytes group_ids = 1;
+  }
+
+  // Deny (deny) Group access
+  message DenyGroup {
+    // Add the given group_ids to the deny list
+    repeated bytes group_ids = 1;
+  }
+
   oneof message_type {
-    Allow allow = 1;
-    Block block = 2;
+    AllowDM allow_dm = 1;
+    DenyDM deny_dm = 2;
+    AllowGroup allow_group = 3;
+    DenyGroup deny_group = 4;
   }
 }
 
 // The payload that goes over the wire
 message PrivatePreferencesPayload {
-  oneof version {
-    Ciphertext v1 = 1;
-  }
-}
+  oneof version { Ciphertext v1 = 1; }
+}