Awesome

crypts •

Architecture

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

Before installing Cairo on your machine, you need to install gmp:

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.

For VSCode support:

Download cairo-0.6.2.vsix from https://github.com/starkware-libs/cairo-lang/releases/tag/v0.6.2

And run:

code --install-extension cairo-0.6.2.vsix

Install the Nile dev environment and then run install to get the Cairo language, a local network, and a testing framework.

pip3 install cairo-nile
nile install

Setup

git clone git@github.com:a5f9t4/crypts.git # clone the repo
cd crypts # enter the directory
yarn # install dependencies

Compile

nile compile

Run Tests

pytest

Acknowledgements

Big thanks to:

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.