https://github.com/refcell/crypts
A cairo port for Rari Capital Vaults
https://github.com/refcell/crypts
Last synced: 9 months ago
JSON representation
A cairo port for Rari Capital Vaults
- Host: GitHub
- URL: https://github.com/refcell/crypts
- Owner: refcell
- License: agpl-3.0
- Created: 2021-12-24T03:12:59.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-12-24T17:40:44.000Z (about 4 years ago)
- Last Synced: 2025-05-05T15:54:37.885Z (9 months ago)
- Language: Python
- Size: 314 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# crypts • [](https://github.com/a5f9t4/crypts/actions/workflows/tests.yml) [](https://github.com/a5f9t4/crypts/actions/workflows/lints.yml)  
## Architecture
```ml
contracts
├─ CryptFactory — "Factory for deploying Crypt contracts for any ERC20 token."
├─ Crypt — "Flexible, minimalist, and gas-optimized yield aggregator for earning interest on ERC20 tokens."
tests
├─ test_cryptFactory — "Test the CryptFactory contract."
└─ test_crypt - "Test the Crypt contract."
```
## Contributing
### First time?
Further installation instructions provided in the [cairo-lang docs](https://www.cairo-lang.org/docs/quickstart.html)
Before installing Cairo on your machine, you need to install `gmp`:
```bash
sudo apt install -y libgmp3-dev # linux
brew install gmp # mac
```
> If you have any troubles installing gmp on your Apple M1 computer, [here’s a list of potential solutions](https://github.com/OpenZeppelin/nile/issues/22).
For VSCode support:
Download `cairo-0.6.2.vsix` from https://github.com/starkware-libs/cairo-lang/releases/tag/v0.6.2
And run:
```bash
code --install-extension cairo-0.6.2.vsix
```
Install the [Nile](https://github.com/OpenZeppelin/nile) dev environment and then run `install` to get [the Cairo language](https://www.cairo-lang.org/docs/quickstart.html), a [local network](https://github.com/Shard-Labs/starknet-devnet/), and a [testing framework](https://docs.pytest.org/en/6.2.x/).
```bash
pip3 install cairo-nile
nile install
```
### Setup
```bash
git clone git@github.com:a5f9t4/crypts.git # clone the repo
cd crypts # enter the directory
yarn # install dependencies
```
### Compile
```bash
nile compile
```
### Run Tests
```bash
pytest
```
## Acknowledgements
Big thanks to:
- [StarkWare](https://starkware.co/)
- [OpenZeppelin](https://github.com/OpenZeppelin/cairo-contracts)
- [Rari-Capital](https://github.com/Rari-Capital/vaults)
## Security
This project is still in a very early and experimental phase. It has never been audited nor thoroughly reviewed for security vulnerabilities. Do not use in production.
Please report any security issues you find by opening up an issue in this reposisitory.
## License
Crypts Contracts are released under the [AGPL-3.0-only](LICENSE).