https://github.com/boringcrypto/YieldBox

https://github.com/boringcrypto/YieldBox

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/boringcrypto/YieldBox
• Owner: boringcrypto
• Created: 2021-12-13T04:07:53.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-19T14:08:07.000Z (almost 2 years ago)
• Last Synced: 2024-04-21T06:35:35.608Z (7 months ago)
• Language: TypeScript
• Size: 2.18 MB
• Stars: 113
• Watchers: 10
• Forks: 46
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# YieldBox

### Introduction Video

[![YIΞLDBOX - @BoringCrypto at @ETHDubaiConf

](https://img.youtube.com/vi/JbMQg6-pH8E/0.jpg)](https://www.youtube.com/watch?v=JbMQg6-pH8E)

### Local development

Clone the repo and run `yarn`

To start hardhat, the sample UI and workbench:

`yarn dev`

There may be a few errors while things recompile. Be sure to add your Alchemy key to .env and it's recommended to use VSCode with the plugins suggested below.

### Setting up your .env

You can include your environment variables in a `.env` file in the root of your repo. Alternatively you can set an actual environment variable called `DOTENV_PATH` to point to a central `.env` file to be used. This way you can use the same environment settings accross multiple projects.

Some useful settings:

```

ALCHEMY_API_KEY=

COINMARKETCAP_API_KEY=

HARDHAT_NETWORK=hardhat

HARDHAT_MAX_MEMORY=4096

HARDHAT_SHOW_STACK_TRACES=true

HARDHAT_VERBOSE=true

```

### Recommended VSCode extentions

-   solidity - Juan Blanco

-   Mocha Test Explorer - Holger Benl

-   Vue Language Features (Volar) - Johnson Chu

### Want to help out?

Contact BoringCrypto on Twitter (@Boring_Crypto) or on Discord (BoringCrypto#3523).

To move YieldBox along, help is needed with:

-   Documentation (setting up GitBook and building out docs)

-   Sample apps - Several sample contracts have been created, they need a UI, testing and documentation

    -   Salary - stream with optional cliff

    -   Escrow -

    -   Lending - isolated lending contract

    -   Tokenizer - tokenize anything, most useful for NFTs

    -   Swap - AMM based off Uni V2

-   Building strategies (you're free to add a fee to your strategy)