Add on-chain group invites

[waddaboo]

Description

This PR introduces multiple new features to api, dashboard, and api-sdk.

New features included:

• api: query groups by group type (on-chain/off-chain).
• api: query groups by group name.
• api: add unique group name check when creating group.
• dashboard: when creating an on-chain group, auto create an associated off-chain group.
• dashboard: new function to get group by group name.
• dashboard: enabled generate invite link feature to on-chain group, which is made possible by the auto created associated off-chain group.
• dashboard: remove on-chain group member who join via invite link.
• dashboard: auto create associated group when generating invite link if associated group does not exist.
• api-sdk: get groups by group type (on-chain/off-chain).
• api-sdk: get groups by group name.
• api-sdk: get associated groups.
• client: new function to get on-chain group for join group via invite code verification.

Related Issue

Does this introduce a breaking change?

• Yes
• No

Other information

Associated off-chain group flow:

1. Upon create an on-chain group, dashboard will auto create an associated off-chain group with the values below:

const groupId = onchainGroup.id
{
   name: groupId,
   description: `This group is associated to the on-chain group ${groupId}`,
   type: "on-chain"
   treeDepth: 16,
   fingerprintDuration: 3600
}

2. Users can then get the associated group by querying the group with type="on-chain" && name="groupId".
3. In dashboard, users can use getGroupByName(name, type) .
4. In api-sdk, users can use getAssociatedGroups(name).

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
bandada-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 31, 2024 8:57am
bandada-website	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 31, 2024 8:57am

[vplasencia]

Hey @waddaboo great work! Thank you very much. I just left some comments.

What about checking here if there is no other group with the same name when creating a group? This way, future issues can be avoided.

https://github.com/bandada-infra/bandada/blob/main/apps/api/src/app/groups/groups.service.ts#L157

[vplasencia]

Since the associated groups will only be used for the invite codes, we should make sure that people can't add members to those off-chain groups. What do you think?

If you try to use an invite code with the client app, you can see that the new member is added to the associated off-chain group.

[waddaboo]

Right, so the associated group will be used solely to generate invite codes and will not store any other information. I'll update it.

[waddaboo]

What about checking here if there is no other group with the same name when creating a group? This way, future issues can be avoided.

For this unique name check, do you want it to be unique for the whole database or just unique to admin?

[vplasencia]

For this unique name check, do you want it to be unique for the whole database or just unique to admin?

Unique per admin.

[waddaboo]

I have implemented the requested changes and new features. Feel free to continue your review. Thanks!

[vplasencia]

After the invite code is used, users can use it again because it was not marked as used. Something we can do is to create an API SDK function for this: https://github.com/bandada-infra/bandada/blob/main/apps/api/src/app/invites/invites.service.ts#L126

(for that we need to add that function to the controller to create a function in the API SDK)

And call that new api sdk function from the client app.

The idea is to have a similar devex as invite code for off-chain groups when using this new invite code for on-chain groups.

More context about the redeemInvite function: https://github.com/bandada-infra/bandada/blob/main/apps/api/src/app/groups/groups.service.ts#L425

Does it make sense?

As a note to keep in mind for developers when using this functionality is that these actions with invite code for on-chain groups should be done in backend in a real world app because of security issues since users will be able to join a group even if the invite is not correct. But I think it's fine to keep it here in the client app browser for now as a way to showcase the functionality. It should be moved to a serverless function later in the future.

[waddaboo]

Correct me if I get it wrong, the new api-sdk is to bundle redeemInvite together with add member to group.

Depends on whether the invite is for on-chain or off-chain, if off-chain, the api-sdk will add the member into the off-chain group; if on-chain, the api-sdk will run Semaphore addMember.

Did I miss anything?

In cases of users failed to join the group upon clicking the join group button, should we invalidate the invite code or leave it until the invite has been redeemed successfully?

[vplasencia]

I just merged this PR because this could be part of a new PR.

The idea is to add just one function to the API SDK. The function can be called redeemInvite and would go here: https://github.com/bandada-infra/bandada/blob/main/libs/api-sdk/src/invites.ts

Then we would call this function in the client app before adding the member with Semaphore.

The other part related to improving devex when using invites for on-chain groups may be part of a different PR.

[vplasencia]

In cases of users failed to join the group upon clicking the join group button, should we invalidate the invite code or leave it until the invite has been redeemed successfully?

I think wait until the transaction is complete.

[waddaboo]

Oh so the new API SDK is just to redeemInvite? So if developers did not use the redeemInvite API SDK, they could reuse the invite code?

[vplasencia]

Oh so the new API SDK is just to redeemInvite?

Yes, correct.

So if developers did not use the redeemInvite API SDK, they could reuse the invite code?

Yes, if redeemInvite (in the Bandada backend) is never called, the invite is still valid. That redeemInvite function is called in the Bandada infrastructure (backend) when a user joins a group using an invite code, this way the invite code can't be used more than once.

[waddaboo]

Got it, thanks for the clarifications! Will work on it!

[vplasencia]

You're welcome. Thank you very much 🙏