Blockchain Manager

This branch proposes a client-server architecture for integrating the Blockchain Manager component to other modules, with the aim of supporting crypto-asset rewards for human reviewers.

Table of Contents

• Installation
  • Prerequisites
  • Setup
• Usage
• Contributing
• License
• Contact

Installation

Requirements

Before starting, ensure you have Docker and Git installed on your system.

Setup

1. Clone this repository.

   git clone --branch integration https://github.com/ngi-indi/module-blockchain.git

2. Create the server/secrets.json file.

   {
   	"bscscanApiKey": "yourKey",
   	"bscPrivateKey": "yourKey key goes here"
   }

3. Create the .env file similar to the following one.

   # Passphrases:
   PRIVATE_KEY_1="a million miles away your signal in the distance to whom it"
   PRIVATE_KEY_2="may concern I think I lost my way getting good at starting"
   PRIVATE_KEY_3="over every time that I return learning to walk again I believe"
   PRIVATE_KEY_4="I ve waited long enough where do I begin learning to talk"
   PRIVATE_KEY_5="again cant you see I ve waited long enough where do I"
   
   # hevm (forge's git configuration)
   GIT_EMAIL="[email protected]"
   GIT_USERNAME="your-username"
   

   For development details please refer to the comments on this README.

Usage

Run the server and client Docker containers.

docker-compose up --build

Contributing

Reporting bugs and requesting features

• If you find a bug, please open an issue.
• To request a feature, feel free to open an issue as well.

Developing a new feature

1. Fork the repository by clicking the "Fork" button at the top right of this page.
2. Clone your fork locally:

   git clone https://github.com/ngi-indi/module-bias-manager.git

3. Create a new branch for your feature or bug fix:

   git checkout -b feature-branch

4. Make your changes. Please follow the existing code style and conventions.
5. Commit your changes with a descriptive commit message:

   git commit -m "Add new feature: explanation of bias model predictions"

6. Push to your fork:

   git push origin feature-branch

7. Open a pull request from your fork’s branch to the main branch of this repository.

• Describe the changes you’ve made in the PR description.
• Ensure that your PR references any relevant issues.

License

This project is licensed under the GNU General Public License v3.0 License - see the LICENSE file for details.

Contact

For any questions or support, please reach out to:

• University of Cagliari: [email protected], [email protected], [email protected], [email protected]
• R2M Solution: [email protected]
• Website: Coming soon!