Collar Protocol is a lending protocol that enables liquidation-free and high LTV borrowing against crypto assets by combining dex swaps and options-like payoff structures.
This repo primarily uses forge for development. See foundry specific commands here.
Tests are run automatically via GitHub Actions on every push & pr. This configuration can be found in .github/workflows/test.yml. Consider installing the VSCode GitHub Actions extension for a better experience.
Solidity docs can be created from Solidity NatSpec via the forge doc command. You can run this docgen locally via forge doc --build
Developer docs are contained in the devdocs folder, but are currently outdated.
Docs on how to run the local devleopment scripts can be found in script/readme.md.