yichiehliu / squeeth-monorepo

Squeeth is a new financial primitive in DeFi that gives traders exposure to ETH²

Squeeth Monorepo

The Squeethiest 🐱

🤔 What is Squeeth

The squeeth contract is designed for users to long or short a special index: Eth², as an implementation of a Power Perpetual.

This monorepo contains the source code for the frontend app as well as the contracts, you can spin up the environment locally, run tests, or play around with the code. For more details about how to use the contracts and frontend, go to packages/ and choose hardhat for the contracts or frontend, we have more detailed explanation in each sub-folder.

📚 Learn more

• Read our GitBook Documentation
• Visit our official Medium page where we have tons of great posts
• Original paper on Power Perpetual
• Join our Discord to chat with all the derivative big brains

🔒 Security And Bug Bounty Program

Security is our one of our highest priorities. Our team has created a protocol that we believe is safe and dependable, and is audited by Trail of Bits and Akira, and is insured by Sherlock. All smart contract code is publicly verifiable and we have a bug bounty for undiscovered vulnerabilities. We encourage our users to be mindful of risk and only use funds they can afford to lose. Smart contracts are still new and experimental technology. We want to remind our users to be optimistic about innovation while remaining cautious about where they put their money.

Please see here for details on our security audit and bug bounty program.

🏄‍♂️ Quick Start

Prerequisites

1. Install Node LTS
2. Install Yarn

Steps

install and start your 👷‍ Hardhat chain:

cd packages/hardhat
yarn install
yarn chain

in a second terminal window, start your 📱 frontend:

cd packages/frontend
yarn install
yarn dev

in a third terminal window, 🛰 deploy your contract:

cd packages/hardhat
yarn deploy

Open http://localhost:3000 to see the app