Skip to content

Latest commit

 

History

History
365 lines (282 loc) · 14.1 KB

README.md

File metadata and controls

365 lines (282 loc) · 14.1 KB
Raw

Bandada

Github license GitHub Workflow test GitHub Workflow style Coveralls Linter eslint Code style prettier

Bandada is a public good plug-and-play infrastructure that empowers anyone to create and manage privacy-preserving groups of anonymous individuals, without necessitating prior expertise.

Bandada comprises a versatile back-end, two user-friendly front-ends (the dashboard to manage groups and members and a demo application to allow end-users to join the groups), Ethereum smart contracts for proof verification, and a collection of JavaScript libraries for seamless integration. From the Bandada dashboard, you can effortlessly create two types of groups: manual and credential groups. In manual groups, you can add members directly or generate invite links while, in credential groups, members must demonstrate their credentials for access. Bandada provides developers with JavaScript libraries, including @bandada/api-sdk to make it easier to work with the APIs. Furthermore, it provides preconfigured credential validators and allows for additional functionality through the @bandada/credentials library. This feature allows for manual or automated management of both off-chain and on-chain groups by specifying eligibility criteria. It can be used for a variety of applications, such as organizing private organizational members, grouping contributors of a particular GitHub repository, or uniting holders of a specific NFT, among others.

Please see the latest documentation to learn more about Bandada.

⚙️ Applications

📦 Libraries

Package Version Downloads
@bandada/hardhat NPM version Downloads
@bandada/contracts NPM version Downloads
@bandada/utils NPM version Downloads
@bandada/credentials NPM version Downloads
@bandada/api-sdk NPM version Downloads

Bandada board

All the Bandada board tasks are public. You can view the current tasks, their statuses, and more details here.

🔧 Configuration

Prerequisites

Each package and application brings its own set of environment variables. To get started with Bandada, you can get rid of the configuration and just use the default settings. Copy the environment variables used by the api application by running this command:

cp apps/api/.env.example apps/api/.env

NB. Bandada requires an SQL database (see api application for usage). Currently, PostgreSQL and SQLite (default) has been successfully tested (watch out that others SQL flavors may work but have not been tested). We are assuming you are using SQLite as the database.

The applications will be deployed at the following URLs without any changes to the default configurations:

App Development Production Staging
Bandada API http://localhost:3000 https://api.bandada.pse.dev https://api-staging.bandada.pse.dev
Bandada Dashboard http://localhost:3001 https://app.bandada.pse.dev https://app-staging.bandada.pse.dev
Bandada Client App http://localhost:3002 https://client.bandada.pse.dev https://client-staging.bandada.pse.dev

🛠 Installation

Clone this repository:

git clone https://github.com/bandada-infra/bandada.git

and install the dependencies:

cd bandada && yarn

📜 Usage

To build the applications, libraries and compile the contracts, run the following command:

yarn build

A dist folder will be created in each library/application.

To start the applications in a development environment, run the following command:

yarn dev

Use the following command to start the applications in the production environment:

yarn start

Testing

Run Jest to test the code with coverage:

yarn test

🐳 Running in Docker

Prerequisites

To run Bandada using Docker, execute the following command in the project root:

docker-compose up -d

Local Development

To begin local development, use the following command to start essential dependencies such as a local Ethereum network (with data persistence) and TheGraph node:

docker-compose -f docker-compose.dev.yml up -d

The Ethereum node (Ganache) will run on port 8545 with accounts pre-funded with 100 ETH:

0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
# this is the same first account generated by Hardhat network as well.
Private Key: 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80

To deploy the contracts to the local network, use the command below:

yarn workspace contracts deploy:bandada-semaphore --network local

The contract addresses deployed in a new local network are:

Pairing library has been deployed to:               0x5FbDB2315678afecb367f032d93F642f64180aa3
SemaphoreVerifier contract has been deployed to:    0xe7f1725E7734CE288F8367e1Bb143E90bb3F0512
Bandada contract has been deployed to:             0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0
BandadaSemaphore contract has been deployed to:    0xCf7Ed3AccA5a467e9e704C703E8D87F634fB0Fc9

Default values for contract addresses are set in libs/utils/src/contract-addresses.ts. If you make changes to the contract and redeploy, you will need to update the address here.

To reset the local network or TheGraph node, stop the docker containers and delete the corresponding folders inside ./.data.

📡 Enable API Access for a Group

Bandada offers APIs for retrieving group data and managing group members. As an admin of a manual or invitation group, you can use the API key to add or remove members.

To enable API access for a group, go to the group page in the dashboard and toggle the Enable API Access button. Once enabled, a new API key will be generated for you. You can disable API access at any time using the same toggle button.

Screencast.from.25-01-2024.15.21.32.webm

🔌 API endpoints

To see the complete list of available endpoints, please visit https://api.bandada.pse.dev.

👨‍💻 Contributing

Good First Issues

Check out the list of open Good First Issues to find tasks that are ideal for new contributors.

Alternatively, for a more visual organization, check out the Good First Issues board view.

Code quality and formatting

Run ESLint to analyze the code and catch bugs:

yarn lint

Run Prettier to check formatting rules:

yarn prettier

or to format the code automatically:

yarn prettier:write

Conventional commits

Bandada uses conventional commits, which follow a standardised format for commit messages. To use this format, you can run the command line utility by running:

yarn commit

The command will automatically verify that the modified files adhere to the rules of ESLint and Prettier.

Releases

Steps:

  1. Bump a new version with:
yarn version:bump <version>
# e.g. yarn version:bump 2.0.0

This step creates a commit and a git tag.

  1. Push the changes to main:
git push origin main
  1. Push the new git tag:
git push origin <version>
# e.g. git push origin v2.0.0

After pushing the new git tag, a workflow will be triggered to publish the Bandada packages on npm and release a new version on GitHub with its changelogs automatically.