-
Notifications
You must be signed in to change notification settings - Fork 0
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
1 changed file
with
116 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,2 +1,116 @@ | ||
| # sybil-shield-front | ||
| Front end of the sybil shield project | ||
| <div align="center"> | ||
| <h1 align="center">SybilShield</h1> | ||
| <h2 align="center">A solution for detecting and preventing sybil attacks on Starknet blockchain</h2> | ||
| <br /> | ||
| <a href="/~https://github.com/carbonable-labs/sybil-shield/issues/new?assignees=&labels=bug&template=01_BUG_REPORT.md&title=bug%3A+">Report a Bug</a> | ||
| - | ||
| <a href="/~https://github.com/carbonable-labs/sybil-shield/issues/new?assignees=&labels=enhancement&template=02_FEATURE_REQUEST.md&title=feat%3A+">Request a Feature</a> | ||
| - | ||
| <a href="/~https://github.com/carbonable-labs/sybil-shield/discussions">Ask a Question</a> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
| <br /> | ||
|
|
||
| [](/~https://github.com/keep-starknet-strange/garaga/actions/workflows/test.yml) | ||
| [](LICENSE) | ||
| [](/~https://github.com/keep-starknet-strange/garaga/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
| ## About | ||
|
|
||
| SybilShield is an open-source project built for the StarkNet ecosystem that utilizes blockchain data to detect Sybil attack behaviors. | ||
|
|
||
| A Sybil attack is a type of attack where an attacker creates multiple fake identities (also known as Sybil nodes) in a network in order to gain control or disrupt the network's operation. | ||
|
|
||
| SybilShield is implemented using Apibara technology to explore on-chain data, allowing it to detect and mitigate Sybil attacks by identifying and isolating fake identities. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| #### Typescript | ||
|
|
||
|
|
||
|
|
||
| ## Roadmap | ||
|
|
||
| See the [open issues](/~https://github.com/carbonable-labs/sybil-shield/issues/issues) for | ||
| a list of proposed features (and known issues). | ||
|
|
||
|
|
||
|
|
||
| ## Support | ||
|
|
||
| Reach out to the maintainer at one of the following places: | ||
|
|
||
| - [GitHub Discussions](/~https://github.com/carbonable-labs/sybil-shield/issues/discussions) | ||
|
|
||
|
|
||
| ## Project assistance | ||
|
|
||
| If you want to say **thank you** or/and support active development: | ||
|
|
||
| - Add a [GitHub Star](/~https://github.com/carbonable-labs/sybil-shield/issues/) to the | ||
| project. | ||
| - Write interesting articles about the project on [Dev.to](https://dev.to/), | ||
| [Medium](https://medium.com/) or your personal blog. | ||
|
|
||
| Together, we can make SybilShield **better**! | ||
|
|
||
| ## Contributing | ||
|
|
||
| First off, thanks for taking the time to contribute! Contributions are what make | ||
| the open-source community such an amazing place to learn, inspire, and create. | ||
| Any contributions you make will benefit everybody else and are **greatly | ||
| appreciated**. | ||
|
|
||
| Please read [our contribution guidelines](docs/CONTRIBUTING.md), and thank you | ||
| for being involved! | ||
|
|
||
| ## Authors & contributors | ||
|
|
||
| For a full list of all authors and contributors, see | ||
| [the contributors page](/~https://github.com/carbonable-labs/sybil-shield/issues/contributors). | ||
|
|
||
| ## Security | ||
|
|
||
| SybilShield follows good practices of security, but 100% security cannot be assured. | ||
| SybilShield is provided **"as is"** without any **warranty**. Use at your own risk. | ||
|
|
||
| _For more information and to report security issues, please refer to our | ||
| [security documentation](docs/SECURITY.md)._ | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the **MIT license**. | ||
|
|
||
| See [LICENSE](LICENSE) for more information. | ||
|
|
||
| ## Resources | ||
|
|
||
| Here are some interesting resources about detection and mitigation of Sybil attacks: | ||
|
|
||
| - [Review on Detection and Mitigation of Sybil Attack in the Network](https://www.sciencedirect.com/science/article/pii/S187705091600082X) | ||
|
|
||
| > **Note:** This list is not exhaustive, and is not intended to be. | ||
|
|
||
| ## Contributors ✨ | ||
|
|
||
| Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| This project follows the [all-contributors](/~https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! |