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
- Clone the repository
cdinto the repository- Run
make installto install contract dependencies - (_Optional_) Run
source dev.envto set up environment variables
Usage
Common tasks are executed through a Makefile. The most common commands are:
make buildto compile the project.make testto run the test suite.
export SEPOLIA_RPC_URL=https://rpc-url-here._
make pre-committo ensure all of the development requirements are met, such as
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, which outlines its architecture and is the foundation of the implementation. Our documentation can be found here.Dependencies
- OpenZeppelin Contracts
- OpenZeppelin Upgradeable-Contracts
- UMAProtocol (_for the KPIRewarder Staking Module_)
Contributing
You are considering to contribute to our protocol? Awesome - please refer to our Contribution Guidelines to find our about the processes we established to ensure highest quality within our codebase.Security
Our Security Policy 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].----- _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._