81 lines
1.8 KiB
Protocol Buffer
81 lines
1.8 KiB
Protocol Buffer
|
syntax = "proto3";
|
||
|
|
|
||
|
|
package communities.v1;
|
||
|
|
|
||
|
|
import "communities/v1/chat_identity.proto";
|
||
|
|
|
||
|
|
message Grant {
|
||
|
|
bytes community_id = 1;
|
||
|
|
bytes member_id = 2;
|
||
|
|
string chat_id = 3;
|
||
|
|
uint64 clock = 4;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityMember {
|
||
|
|
enum Roles {
|
||
|
|
UNKNOWN_ROLE = 0;
|
||
|
|
ROLE_ALL = 1;
|
||
|
|
ROLE_MANAGE_USERS = 2;
|
||
|
|
}
|
||
|
|
repeated Roles roles = 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityPermissions {
|
||
|
|
enum Access {
|
||
|
|
UNKNOWN_ACCESS = 0;
|
||
|
|
NO_MEMBERSHIP = 1;
|
||
|
|
INVITATION_ONLY = 2;
|
||
|
|
ON_REQUEST = 3;
|
||
|
|
}
|
||
|
|
|
||
|
|
bool ens_only = 1;
|
||
|
|
// https://gitlab.matrix.org/matrix-org/olm/blob/master/docs/megolm.md is a candidate for the algorithm to be used in case we want to have private communityal chats, lighter than pairwise encryption using the DR, less secure, but more efficient for large number of participants
|
||
|
|
bool private = 2;
|
||
|
|
Access access = 3;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityDescription {
|
||
|
|
uint64 clock = 1;
|
||
|
|
map<string,CommunityMember> members = 2;
|
||
|
|
CommunityPermissions permissions = 3;
|
||
|
|
ChatIdentity identity = 5;
|
||
|
|
map<string,CommunityChat> chats = 6;
|
||
|
|
repeated string ban_list = 7;
|
||
|
|
map<string,CommunityCategory> categories = 8;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityChat {
|
||
|
|
map<string,CommunityMember> members = 1;
|
||
|
|
CommunityPermissions permissions = 2;
|
||
|
|
ChatIdentity identity = 3;
|
||
|
|
string category_id = 4;
|
||
|
|
int32 position = 5;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityCategory {
|
||
|
|
string category_id = 1;
|
||
|
|
string name = 2;
|
||
|
|
int32 position = 3;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityInvitation {
|
||
|
|
bytes community_description = 1;
|
||
|
|
bytes grant = 2;
|
||
|
|
string chat_id = 3;
|
||
|
|
bytes public_key = 4;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityRequestToJoin {
|
||
|
|
uint64 clock = 1;
|
||
|
|
string ens_name = 2;
|
||
|
|
string chat_id = 3;
|
||
|
|
bytes community_id = 4;
|
||
|
|
}
|
||
|
|
|
||
|
|
message CommunityRequestToJoinResponse {
|
||
|
|
uint64 clock = 1;
|
||
|
|
CommunityDescription community = 2;
|
||
|
|
bool accepted = 3;
|
||
|
|
bytes grant = 4;
|
||
|
|
}
|