Merge pull request #362 from privacy-scaling-explorations/feat/285tre…

…eRoot

feat: returning group/groups fingerprint in APIs/SDK response

apps/api/src/app/groups/docSchemas/group.ts

@@ -12,6 +12,8 @@ export class Group {
     @ApiProperty()
     treeDepth: number
     @ApiProperty()
+    fingerprint: string
+    @ApiProperty()
     fingerprintDuration: number
     @ApiProperty()
     createdAt: Date

apps/api/src/app/groups/groups.controller.ts

@@ -45,18 +45,24 @@ export class GroupsController {
     @ApiCreatedResponse({ type: Group, isArray: true })
     async getGroups(@Query("adminId") adminId: string) {
         const groups = await this.groupsService.getGroups({ adminId })
+        const groupIds = groups.map((group) => group.id)
+        const fingerprints = await this.groupsService.getFingerprints(groupIds)
 
-        return groups.map((g) => mapGroupToResponseDTO(g))
+        return groups.map((group, index) =>
+            mapGroupToResponseDTO(group, fingerprints[index])
+        )
     }
 
     @Get(":group")
     @ApiOperation({ description: "Returns a specific group." })
     @ApiCreatedResponse({ type: Group })
     async getGroup(@Param("group") groupId: string, @Req() req: Request) {
         const group = await this.groupsService.getGroup(groupId)
+        const fingerprint = await this.groupsService.getFingerprint(groupId)
 
         return mapGroupToResponseDTO(
             group,
+            fingerprint,
             req.session.adminId === group.adminId
         )
     }
@@ -69,9 +75,11 @@ export class GroupsController {
             dto,
             req.session.adminId
         )
+        const fingerprint = await this.groupsService.getFingerprint(group.id)
 
         return mapGroupToResponseDTO(
             group,
+            fingerprint,
             req.session.adminId === group.adminId
         )
     }
@@ -97,8 +105,11 @@ export class GroupsController {
             req.session.adminId
         )
 
+        const fingerprint = await this.groupsService.getFingerprint(groupId)
+
         return mapGroupToResponseDTO(
             group,
+            fingerprint,
             req.session.adminId === group.adminId
         )
     }

apps/api/src/app/groups/groups.service.ts

@@ -225,7 +225,7 @@ export class GroupsService {
 
     /**
      * Join the group by redeeming invite code.
-     * @param groupId Group name.
+     * @param groupId Group id.
      * @param memberId Member's identity commitment.
      * @param dto Parameters used to add a group member.
      * @returns Group data with added member.
@@ -248,7 +248,7 @@ export class GroupsService {
 
     /**
      * Add a member to the group manually as an admin.
-     * @param groupId ID of the group
+     * @param groupId Group id.
      * @param memberIds Member's identity to be added
      * @param adminId id of the admin making the request
      * @returns Group
@@ -263,7 +263,7 @@ export class GroupsService {
 
     /**
      * Add members to the group manually as an admin.
-     * @param groupId ID of the group
+     * @param groupId Group id.
      * @param memberIds Array of member IDs to be added
      * @param adminId id of the admin making the request
      * @returns Group
@@ -294,7 +294,7 @@ export class GroupsService {
 
     /**
      * Add a member to the group using API Key.
-     * @param groupId ID of the group
+     * @param groupId Group id.
      * @param memberIds  Member's identity to be added
      * @param apiKey API key for the group
      * @returns Group
@@ -309,7 +309,7 @@ export class GroupsService {
 
     /**
      * Add members to the group using API Key.
-     * @param groupId ID of the group
+     * @param groupId Group id.
      * @param memberIds Array of member IDs to be added
      * @param apiKey API key for the group
      * @returns Group
@@ -340,7 +340,7 @@ export class GroupsService {
 
     /**
      * Add a member to the group.
-     * @param groupId ID of the group
+     * @param groupId Group id.
      * @param memberId ID of the member to be added
      * @returns Group
      */
@@ -387,7 +387,7 @@ export class GroupsService {
 
     /**
      * Add multiple members to the group.
-     * @param groupId ID of the group
+     * @param groupId Group id.
      * @param memberIds Array of member IDs to be added
      * @returns Group
      */
@@ -439,7 +439,7 @@ export class GroupsService {
 
     /**
      * Delete a member from a group.
-     * @param groupId Group name.
+     * @param groupId Group id.
      * @param memberId Member's identity commitment.
      * @param adminId Group admin id.
      * @returns Group data with removed member.
@@ -454,7 +454,7 @@ export class GroupsService {
 
     /**
      * Delete members from a group.
-     * @param groupId Group name.
+     * @param groupId Group id.
      * @param memberIds Array of member's identity commitments.
      * @param adminId Group admin id.
      * @returns Group data with removed member.
@@ -517,7 +517,7 @@ export class GroupsService {
 
     /**
      * Delete a member from group using API Key
-     * @param groupId Group name.
+     * @param groupId Group id.
      * @param memberId Member's identity commitment.
      * @returns Group data with removed member.
      */
@@ -531,7 +531,7 @@ export class GroupsService {
 
     /**
      * Delete a member from group using API Key
-     * @param groupId Group name.
+     * @param groupId Group id.
      * @param memberIds Array of members' identity commitment.
      * @returns Group data with removed member.
      */
@@ -612,7 +612,7 @@ export class GroupsService {
 
     /**
      * Returns a specific group.
-     * @param groupId Group name.
+     * @param groupId Group id.
      * @returns Specific group.
      */
     async getGroup(groupId: string): Promise<Group> {
@@ -661,6 +661,33 @@ export class GroupsService {
         return cachedGroup.generateMerkleProof(memberIndex)
     }
 
+    /**
+     * Returns a group fingerprint.
+     * @param groupId Group id.
+     * @returns Group fingerprint.
+     */
+    async getFingerprint(groupId: string): Promise<string> {
+        return (await this.getFingerprints([groupId]))[0]
+    }
+
+    /**
+     * Returns a list of fingerprints from a list of groups.
+     * @param groupIds Array of group ids.
+     * @returns Fingerprints from groups.
+     */
+    async getFingerprints(groupIds: string[]): Promise<string[]> {
+        const fingerprints: string[] = []
+
+        for (const groupId of groupIds) {
+            const cachedGroup = this.cachedGroups.get(groupId)
+            if (cachedGroup) {
+                fingerprints.push(cachedGroup.root.toString())
+            }
+        }
+
+        return fingerprints
+    }
+
     private async _updateFingerprintDuration(
         groupId: string,
         duration: number

apps/api/src/app/groups/groups.utils.test.ts

@@ -26,11 +26,18 @@ describe("Groups utils", () => {
         it("Should map the group data with api keys if specified", async () => {
             const { apiKey, apiEnabled } = mapGroupToResponseDTO(
                 { apiEnabled: true, apiKey: "123" } as any,
+                "12345",
                 true
             )
 
             expect(apiEnabled).toBeTruthy()
             expect(apiKey).toBe("123")
         })
+
+        it("Should map the fingerprint correctly", async () => {
+            const { fingerprint } = mapGroupToResponseDTO({} as any, "12345")
+
+            expect(fingerprint).toBe("12345")
+        })
     })
 })

apps/api/src/app/groups/groups.utils.ts

@@ -2,6 +2,7 @@ import { Group } from "./entities/group.entity"
 
 export function mapGroupToResponseDTO(
     group: Group,
+    fingerprint: string = "",
     includeAPIKey: boolean = false
 ) {
     const dto = {
@@ -10,6 +11,7 @@ export function mapGroupToResponseDTO(
         description: group.description,
         admin: group.adminId,
         treeDepth: group.treeDepth,
+        fingerprint,
         fingerprintDuration: group.fingerprintDuration,
         createdAt: group.createdAt,
         members: (group.members || []).map((m) => m.id),

libs/api-sdk/src/types/index.ts

@@ -4,6 +4,7 @@ export type GroupResponse = {
     description: string
     admin: string
     treeDepth: number
+    fingerprint: string
     fingerprintDuration: number
     createdAt: Date
     members: string[]