hats-finance / Circles-0x6ca9ca24d78af44582951825bef9eadcb210e5cf

Circles Protocol contracts
https://aboutcircles.com
GNU Affero General Public License v3.0
0 stars 0 forks source link

Audit Competition for Circles

This repository is for the audit competition for the Circles. To participate, submit your findings only by using the on-chain submission process on https://app.hats.finance/vulnerability .

How to participate

Circles is a decentralized protocol for creating and distributing fair and social money through personal currencies. Built on the Gnosis Chain, it utilizes smart contracts to manage the creation, distribution, and transfer of personal currencies using the ERC1155 multi-token standard.

Key Concepts

Features

Documentation

For more details on Circles and details of the implementation please refer to https://aboutcircles.github.io/circles-contracts-v2/

Getting Started

🐲 Beta Status: This repository is in beta and actively developed in the open. While initial reviews are on-going, we welcome community engagement for wider testing and integration. As AGPL-licensed software, it's provided as-is. We encourage thorough review and testing before any production use.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/aboutcircles/circles-contracts-v2
    cd circles-contracts-v2
  2. Install dependencies:

    forge install

    Building

  3. Compile the contracts:

    forge build

Testing

  1. Run the test suite:
    forge test
  2. For a gas report:
    forge test --gas-report

    Deployment

To deploy to the Chiado testnet:

  1. Copy .env.example to .env and set your private key and API keys.
  2. Run the deployment script:
    ./script/deployments/chiadoDeploy.sh

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the AGPL-3.0 License.

Disclaimer

This project is under active development. The code has not completed externally reviews and should not be used in production environments without proper review and testing.

Contact

For questions or support regarding this project, please contact:

We appreciate your interest and feedback!