Skip to content

Commit

Permalink
chore: add comment in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wei3erHase committed Mar 28, 2024
1 parent 33c55f0 commit a15e858
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ The `Unlock` contract is meant to be used as a receiver of a Yearn Vesting Escro

<img src="unlock.svg" alt="vesting and unlocking" align="center" />

## Dependencies

This contract is designed to be integrated with Yearn's [Vesting Escrow v0.3.0](https://github.com/yearn/yearn-vesting-escrow) contract, ([audited](https://github.com/yearn/yearn-security/tree/master/audits/20231013_Mixbytes_yearn_vesting_escrow)). The `ConnextVestingWallet` contract is meant to be the receiver of the tokens that are being vested.

**NOTE**: This Vesting Escrow contract version is compatible with post-shangai EVM versions only (as it requires `PUSH0` compatibility).

## Setup

1. Copy the `.env.example` file to `.env` and fill in the variables.
Expand Down

0 comments on commit a15e858

Please sign in to comment.