Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zkLend/zklend-v1-core
Core smart contracts of zkLend v1
https://github.com/zkLend/zklend-v1-core
cairo ethereum lending starknet zk-rollup zklend
Last synced: 24 days ago
JSON representation
Core smart contracts of zkLend v1
- Host: GitHub
- URL: https://github.com/zkLend/zklend-v1-core
- Owner: zkLend
- License: other
- Created: 2022-02-16T02:37:14.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T04:45:38.000Z (4 months ago)
- Last Synced: 2024-08-26T05:59:41.447Z (4 months ago)
- Topics: cairo, ethereum, lending, starknet, zk-rollup, zklend
- Language: Cairo
- Homepage: https://zklend.com
- Size: 402 KB
- Stars: 15
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starknet - ZkLend v1 - ZkLend v1 core contracts. (Open-source projects)
README
zklend-v1-core
**Core smart contracts of zkLend v1**
[![lint-badge](https://github.com/zkLend/zklend-v1-core/actions/workflows/lint.yaml/badge.svg)](https://github.com/zkLend/zklend-v1-core/actions/workflows/lint.yaml)
[![test-badge](https://github.com/zkLend/zklend-v1-core/actions/workflows/test.yaml/badge.svg)](https://github.com/zkLend/zklend-v1-core/actions/workflows/test.yaml)## 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](./scripts/compile.sh) is available for compiling all the contracts:
```sh
$ ./scripts/compile.sh
```Note that the script requires the `starknet-compile` command from [starkware-libs/cairo](https://github.com/starkware-libs/cairo) to be installed.
Alternatively, the compilation process can be done inside a Docker container for deterministic output:
```sh
$ ./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](https://github.com/starkware-libs/cairo) must be installed to run tests. To run the tests:
```sh
$ cairo-test --starknet .
```Alternatively, run the tests inside a Docker container:
```sh
$ ./scripts/run_tests_with_docker.sh
```## Documentation
A brief overview of the smart contracts are available [here](./src/README.md).
## License
Licensed under [Business Source License 1.1](./LICENSE).