-
Notifications
You must be signed in to change notification settings - Fork 65
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
21 changed files
with
155 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 5 | ||
--- | ||
|
||
# FAQ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
sidebar_position: 5 | ||
sidebar_position: 6 | ||
--- | ||
|
||
import RenderArticles from "../src/components/RenderArticles" | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,153 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Tutorial | ||
|
||
This tutorial will guide you through the process of creating a group and managing group members using the Bandada Dashboard | ||
|
||
## Step 1: Log in to the Bandada Dashboard | ||
|
||
1. Open your web browser and navigate to the [Bandada Dashboard](https://app.bandada.pse.dev). | ||
2. Log in by clicking `Sign in with Ethereum` and select the wallet of your choice (MetaMask, Coinbase Wallet, WalletConnect). | ||
|
||
![Homepage](../static/img/tutorial/homepage.png) | ||
|
||
![Login](../static/img/tutorial/login.png) | ||
|
||
## Step 2: Navigating the Groups page | ||
|
||
1. Once logged in, you will be greeted by the `Groups` page where you can see a list of your existing groups and other credential groups. | ||
2. On this page, you can: | ||
- View the details of a group by clicking the group card. | ||
- Add a new group by clicking the `Add group` button. | ||
- Search for a specific group by name or description. | ||
- View, copy, and refresh your API key by clicking the API key button. | ||
|
||
![Groups](../static/img/tutorial/groups.png) | ||
|
||
## Step 3: Create a new group | ||
|
||
1. Click on the `Add group` button. | ||
2. You will be redirected to the `New Group` page. | ||
3. Select the type of group you want to create. | ||
|
||
![Create group](../static/img/tutorial/create.png) | ||
|
||
### Create an off-chain group | ||
|
||
1. Create an off-chain group by filling in the details: | ||
- **Name**: Enter the group name. | ||
- **Description**: Enter the description for the group with at least 10 characters. | ||
- **Fingerprint Duration**: Select the validity duration of old fingerprints in milliseconds. | ||
2. Click on `Continue` to proceed. | ||
|
||
![Create off-chain group step 1](../static/img/tutorial/offchain-1.png) | ||
|
||
3. Select the size of the off-chain group from the following options: | ||
- **Small**: Store up to 65K members. | ||
- **Medium**: Store up to 1M members. | ||
- **Large**: Store up to 33M members. | ||
- **XL**: Store up to 1B members. | ||
4. Click on `Continue` to proceed. | ||
|
||
![Create off-chain group step 2](../static/img/tutorial/offchain-2.png) | ||
|
||
5. Select the access mode of the off-chain group from the following options: | ||
- **Manual**: Add members to the group by pasting their identity or sending them a generated invite link. | ||
|
||
![Create off-chain group step 3 manual](../static/img/tutorial/offchain-manual.png) | ||
|
||
- **Credentials**: Members can join the group if they fit the criteria you set up. | ||
- Select credential and provider. Current supported credentials and providers: | ||
- **Provider**: GitHub. | ||
- **Credential**: Followers. | ||
**Input**: Minimum followers. | ||
- **Credential**: Personal stars. | ||
**Input**: Minimum stars. | ||
- **Credential**: Repository commits. | ||
**Input**: Minimum commits, repository details. | ||
- **Provider**: Twitter (X). | ||
- **Credential**: Followers. | ||
**Input**: Minimum followers. | ||
- **Credential**: Following user. | ||
**Input**: Username. | ||
- **Provider**: Blockchain. | ||
- **Credential**: Transactions. | ||
**Input**: Minimum transactions, network, block number. | ||
- **Credential**: Balance. | ||
**Input**: Minimum balance, network, block number. | ||
- **Provider**: EAS. | ||
- **Credential**: Attestations. | ||
**Input**: Minimum attestations, network, attestation details. | ||
|
||
![Create off-chain group step 3 credentials](../static/img/tutorial/offchain-credentials.png) | ||
|
||
- **Multiple Credentials**: Members can join the group if they fit the criteria you set up. | ||
- Multiple credentials share the same credentials and providers options as single credential, with the additional option of using logical operators like `AND`, `OR`, `NOT`, `XOR`, `(`, and `)` to chain multiple credentials together. | ||
|
||
![Create off-chain group step 3 multiple credentials](../static/img/tutorial/offchain-mult-credentials.png) | ||
|
||
6. Click on `Continue` to proceed. | ||
7. You will be redirected to the `Group Preview` page to review the group details. | ||
8. Click on `Create Group` to finalize the group creation. | ||
|
||
![Create off-chain group step 4](../static/img/tutorial/offchain-preview.png) | ||
|
||
### Create an on-chain group | ||
|
||
1. You will be redirected to the `Group Preview` page upon selecting the `On-chain` type in the group type selection. | ||
2. Unlike an off-chain group, you do not have to input any group details to create an on-chain group. | ||
3. Click on `Create Group` to finalize the group creation. | ||
|
||
![Create on-chain group](../static/img/tutorial/onchain-preview.png) | ||
|
||
## Step 4: Group management | ||
|
||
1. You will be redirected to the `Group Details` page upon successful group creation, or you can access this page by clicking on the group card on the `Groups` page. | ||
2. On this page, you can: | ||
- View the group details. | ||
- Copy the group ID. | ||
- Download the group's data in JSON format. | ||
- Manage group members. | ||
- Remove group. | ||
|
||
![Group details](../static/img/tutorial/group.png) | ||
|
||
### Add members | ||
|
||
1. Click on `Add member` to add member. | ||
2. Depending on the group type, you will be presented with different methods to add members. | ||
- `Off-chain` groups with `Manual` credential and `On-chain` groups: | ||
- Add members by pasting one or more member IDs, separated by commas, spaces, and newlines, into the `Add member IDs` field. | ||
- Click on the `Generate new link` button to generate an invite link. Then, copy the invite link and send it to the person you want to invite. | ||
- Upon visiting the invite link generated by `Generate new link`, click on `Join group` to join the group. | ||
- The invite link will be invalidated once the user successfully joins the group. | ||
|
||
![Add members manually step 1](../static/img/tutorial/addmember-manual-1.png) | ||
|
||
![Add members manually step 2](../static/img/tutorial/addmember-manual-2.png) | ||
|
||
- `Off-chain` groups with `Credentials` and `Multiple credentials`: | ||
- Copy and share the invite link to the person you want to invite. | ||
- Upon visiting the invite link, click on `Join group` to join the group. | ||
- The invite link can be reused even after the user successfully joins the group. | ||
|
||
![Add members by credentials step 1](../static/img/tutorial/addmember-credentials-1.png) | ||
|
||
![Add members by credentials step 2](../static/img/tutorial/addmember-credentials-2.png) | ||
|
||
### Remove members | ||
|
||
Group administrators can remove group members by: | ||
- Check the check box to the left of the member ID, then click on `Remove Selected Members`. | ||
- Click on the option button to the right of the member ID, then click on `Remove`. | ||
|
||
![Remove members using checkbox](../static/img/tutorial/deletemember-checkbox.png) | ||
|
||
![Remove members using option](../static/img/tutorial/deletemember-option.png) | ||
|
||
|
||
## Conclusion | ||
|
||
You have successfully created a group and managed its members! For more information on how to use Bandada, refer to the [API](https://docs.bandada.pse.dev/api) and [API SDK](https://docs.bandada.pse.dev/api-sdk) documentation. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.