zklend-v1-core

Core smart contracts of zkLend v1

Getting started

Compiling

To stay as flexible as possible, this repository is not using any smart contract development framework at the moment and invokes starknet-compile directly for compiling contracts. A helper script is available for compiling all the contracts:

$ ./scripts/compile.sh

Note that the script requires the starknet-compile command from starkware-libs/cairo to be installed.

Alternatively, the compilation process can be done inside a Docker container for deterministic output:

$ ./scripts/compile_with_docker.sh

In either case, contract artifacts are generated in the build folder.

Running tests

The cairo-test command from starkware-libs/cairo must be installed to run tests. To run the tests:

$ cairo-test --starknet .

Alternatively, run the tests inside a Docker container:

$ ./scripts/run_tests_with_docker.sh

Documentation

A brief overview of the smart contracts are available here.

License

Licensed under Business Source License 1.1.