bandada-infra / bandada-sdk-demo

Example of project using the Bandada API SDK.
4 stars 6 forks source link

Bandada SDK Demo

Bandada_SDK_DEMO_ScriptExec.webm

Simple and intuitive demonstration of interaction with Bandada's off-chain groups.

This example script uses the Bandada API SDK to interact with a pre-existing off-chain group.

In one-click you will be able to print group information, add or remove members, and create a merkle inclusion proof. This proof is a zero-knowledge proof that verifies a user's membership in the group without revealing their identity.

To learn more about Bandada, please visit the repository and documentation.

🛠 Installation

Clone this repository:

git clone https://github.com/vplasencia/bandada-sdk-demo.git

and install the dependencies:

cd bandada-sdk-demo && yarn

🔧 Configuration

Copy the .env.example file to a new file named .env:

cp .env.example .env

You just need to activate your API key via the Bandada Dashboard homepage. Then you need to copy & paste the key into the ADMIN_API_KEY environment variable.

📜 Usage

Use the following command to run the script:

yarn bandada

👨‍💻 Contributing

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 automatically format the code:

yarn prettier:write