Savings Vault

This repository contains the smart contracts for integration with the Notional protocol. Savings Vault is implemented according to the ERC4626 standard.

Environment

Scripts & tests depend on several environment variables to work, as well as external services for some additional functionality.

Providing environment vars

You will need to create an .env file in the root folder and provides values for variables according to the .env.example file.

cp .env.example .env

Getting Started

In case you don't have `Foundry installed make sure to follow the steps described in the following link.

• Use Foundry:

forge install
forge build

• Use Hardhat:

npm install
npx hardhat compile

Features

• Write / run tests with either Hardhat or Foundry:

forge test
# or
npx hardhat test

• Install libraries with Foundry which work with Hardhat.

forge install rari-capital/solmate # Already in this repo, just an example

Update dependencies

• Update libraries with Foundry:

forge update

Notes

Whenever you install new libraries using Foundry, make sure to update your remappings.txt file by running forge remappings > remappings.txt. This is required because we use hardhat-preprocessor and the remappings.txt file to allow Hardhat to resolve libraries you install with Foundry.

The openzeppelin-contract-upgradeable library has been set to commit 54803be6 since there were some changes to how ERC4626Upgradeable contract handles the decimals of underlying asset in later versions. In case this library is updated, be aware that some tests are going to be failing.

Licensing

The primary license for Phuture Savings Vault V1 is the Business Source License 1.1 (BUSL-1.1), see LICENSE_PHUTURE.

Exceptions

• Files in src/interfaces/ are licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see src/interfaces/LICENSE_GPL
• Files in src/libraries/ are licensed under GPL-2.0-or-later (as indicated in their SPDX headers), see src/libraries/LICENSE_GPL
• Files in src/external/ are licensed under MIT (as indicated in their SPDX headers), see src/external/LICENSE_MIT
• Several files in src/external/notional/interfaces are licensed under AGPL-3.0-only (as indicated in their SPDX headers), see src/external/notional/interfaces/LICENSE_AGPL
• Several files in src/external/notional/interfaces are licensed under GPL-3.0-only (as indicated in their SPDX headers), see src/external/notional/interfaces/LICENSE_GPL
• All files in test and src/test remain unlicensed.