https://github.com/cloudwalk/brlc-yield-streamer-v2

This repository contains the second version of the yield streamer contract.
https://github.com/cloudwalk/brlc-yield-streamer-v2

Last synced: about 1 year ago
JSON representation

This repository contains the second version of the yield streamer contract.

• Host: GitHub
• URL: https://github.com/cloudwalk/brlc-yield-streamer-v2
• Owner: cloudwalk
• License: mit
• Created: 2024-11-18T19:05:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-07T05:38:18.000Z (about 1 year ago)
• Last Synced: 2025-03-07T06:27:27.552Z (about 1 year ago)
• Language: TypeScript
• Size: 235 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# Yield Streamer



  



[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![example branch parameter](https://github.com/cloudwalk/brlc-yield-streamer/actions/workflows/build.yml/badge.svg?branch=main)

![example branch parameter](https://github.com/cloudwalk/brlc-yield-streamer/actions/workflows/test.yml/badge.svg?branch=main)

This repository contains YieldStreamer smart contracts.

## Project Setup

1. Clone the repo.

2. Create the `.env` file based on the `.env.example` one:

   * Windows:

    ```sh

    copy .env.example .env

    ```

   * MacOS/Linux:

    ```sh

    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

```sh

# 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](./LICENSE).