Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inverternetwork/audit-hats
Fork of the Inverter Smart Contracts Repository
https://github.com/inverternetwork/audit-hats
Last synced: about 1 month ago
JSON representation
Fork of the Inverter Smart Contracts Repository
- Host: GitHub
- URL: https://github.com/inverternetwork/audit-hats
- Owner: InverterNetwork
- License: lgpl-3.0
- Created: 2024-05-28T12:39:18.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-05T11:28:27.000Z (7 months ago)
- Last Synced: 2024-06-05T18:07:04.201Z (7 months ago)
- Language: Solidity
- Homepage:
- Size: 2.63 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Inverter Network Smart Contracts
*Inverter is the pioneering web3 protocol for token economies, enabling conditional token issuance, dynamic utility management, and token distribution. Build, customize, and innovate with Inverter's modular logic and extensive web3 interoperability.*
## Installation
The Inverter Network smart contracts are developed using the [foundry toolchain](https://getfoundry.sh)
1. Clone the repository
2. `cd` into the repository
3. Run `make install` to install contract dependencies
4. (_Optional_) Run `source dev.env` to set up environment variables
## Usage
Common tasks are executed through a `Makefile`. The most common commands are:
* `make build` to compile the project.
* `make test` to run the test suite.
* Note: _Some of our tests require a working Sepolia RPC URL, as we test certain contracts via fork testing. We implemented fallbacks for these particular test cases in the code directly, so they will work even without any RPC set in the environment. In the unlikely case that the tests do not work without RPC, please set a working one via `export SEPOLIA_RPC_URL=https://rpc-url-here`._
* `make pre-commit` to ensure all of the development requirements are met, such as
* the Foundry Formatter has been run.
* the scripts are all working.
* the tests all run without any issues.
Additionally, the `Makefile` supports a help command, i.e. `make help`.
```
$ make help
> build Build project
> clean Remove build artifacts
> test Run whole testsuite
> update Update dependencies
> [...]
```
## Documentation
The protocol is based on our [technical specification](https://docs.google.com/document/d/1j6WXBZzyYCOfO36ZYvKkgqrO2UAcy0kW5eJeZousn7E), which outlines its architecture and is the foundation of the implementation. Our documentation can be found [here](https://docs.inverter.network).
## Dependencies
- [OpenZeppelin Contracts](https://github.com/OpenZeppelin/openzeppelin-contracts)
- [OpenZeppelin Upgradeable-Contracts](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable)
- [UMAProtocol](https://github.com/UMAprotocol/protocol) (_for the [KPIRewarder Staking Module](./src/modules/logicModule/LM_PC_KPIRewarder_v1.sol)_)
## Contributing
You are considering to contribute to our protocol? Awesome - please refer to our [Contribution Guidelines](./CONTRIBUTING.md) to find our about the processes we established to ensure highest quality within our codebase.
## Safety
Our [Security Policy](./SECURITY.md) provides details about our Security Guidelines, audits, and more. If you have discovered a potential security vulnerability within the Inverter Protocol, please report it to us by emailing [[email protected]](mailto:[email protected]).
-----
_Disclaimer: This is experimental software and is provided on an "as is" and "as available" basis. We do not give any warranties and will not be liable for any loss incurred through any use of this codebase._