README.md

Yield Streamer

This repository contains YieldStreamer smart contracts.

Project Setup

1. Clone the repo.
2. Create the .env file based on the .env.example one:
   • Windows:

   copy .env.example .env

   • MacOS/Linux:

   cp .env.example .env

3. Optionally update the settings in the newly created .env file (e.g., Solidity version, number of optimization runs, network RPC URLs, private keys (PK) for networks, etc.).

Build and test

# Install all dependencies
npm install

# Compile all contracts
npx hardhat compile

# Run all tests
npx hardhat test

Licensing

This project is released under the MIT License, see LICENSE.