The Euler Vault Kit is a system for constructing credit vaults. Credit vaults are ERC-4626 vaults with added borrowing functionality. Unlike typical ERC-4626 vaults which earn yield by actively investing deposited funds, credit vaults are passive lending pools. See the whitepaper for more details.

To install Euler Vault Kit in a Foundry project:

forge install euler-xyz/euler-vault-kit

To install Foundry:

curl -L https://foundry.paradigm.xyz | bash

This will download foundryup. To start Foundry, run:

foundryup

To clone the repo:

git clone https://github.com/euler-xyz/euler-vault-kit.git && cd euler-vault-kit

To run the tests in a default mode:

forge test

./test/scripts/coverage.sh

./test/scripts/echidna.sh # property mode
./test/scripts/echidna-assert.sh # assertion mode
./test/scripts/medusa.sh 

This software is experimental and is provided "as is" and "as available".

No warranties are provided and no liability will be accepted for any loss incurred through the use of this codebase.

Always include thorough tests when using the Euler Vault Kit to ensure it interacts correctly with your code.

The Euler Vault Kit is currently undergoing security audits and should not be used in production.

Refer to the whitepaper for a list of known limitations and security considerations.

(c) 2024 Euler Labs Ltd.

The Euler Vault Kit code is licensed under GPL-2.0 or later except for the files in src/EVault/modules/, which are licensed under Business Source License 1.1 (see the file LICENSE). These files will be automatically re-licensed under GPL-2.0 or later on April 24th, 2029.