owned this note
owned this note
Published
Linked with GitHub
---
tags: WPOKT, proposal
title: ⚔️ Raid Guild Proposal <> wPOKT LP Staking/Farming ⚔️
---
# ⚔️ Raid Guild Proposal <> wPOKT LP Staking/Farming ⚔️
> Creation of the wpokt/ETH LP Pool and staking UI for the wPokt ERC20
<br />

<br />
----
## Scope of Work
This proposal covers the work required to create a Uniswap V2 LP pool, a staking/rewards contract and the UI to govern said utility. Specific scope detail is contained in the below scope documents.
## Proposal from RaidGuild
## Expected Deliverables
### Design Overview
This document details the user experience and visual design needs to build a liquidity pool farming page for Wrapped Pocket, or wPOKT. This proposal is to create a minimum viable version of the product, and so will not contain every feature that may be eventually added. If something is not included in this document, assume it will not be designed as a part of this initial project.
### Elements
* Farming Interface
* Visual Design
#### Farming Interface
An end-user oriented web page which will allow users to stake Liquidity Pool (LP) Tokens received from an external currency exchange. (In this case Uniswap) Staked tokens will yield wPOKT periodically, which will also be claimable on this page.
Functionally, this page will borrow heavily from https://0xmons.xyz/#/farm
#### Navigation
* Pocket Network (Home)
* Connect ETH Wallet (Metamask: any others?)
* Disconnect
#### Farming Interface
* Explainer
* Text describing the function of this app.
* Farming Round Timing
* A timer indicating when the next round of wPOKT will be released.
* Staking/Claiming Widget
*An interface for staking LP Tokens, and claiming wPOKT.*
* Display: Amount (tokens) currently staked
* Display: Amount (tokens) available to stake
* Form Field: Amount (tokens) to add to stake
* Button: Stake
* Button Withdraw (all stake)
* Display: Amount (wPOKT) available to claim
* Button: Claim (wPOKT, only for this pairing)
* Toast/Modal: LP Tokens successfully staked.
* * Toast/Modal: LP Tokens successfully withdrawn.
* Toast/Modal: wPOKT successfully claimed.
* * Toast/Modal: error in transaction.
* Disclaimer/APY Estimator
*A disclaimer informing the user that estimations of APY are only rough predictions, and not guarantees of returns. The following information may need to be displayed individually for each supported LP pair.*
* Display: Value of 1 LP Token in ETH/DAI/wPOKT.
* Display: Value of 24 hour return on 1 staked token in DAI/wPOKT.
* Display: Percentage of 1 LP Token earned as rewards in 24 hours.
## Visual Design
We expect POKT to undergo a brand refresh in the near future. To make that process smoother, this project will use existing assets developed for the wPOKT bridge raid where possible.
---
### FrontEnd Overview
This document details the frontend build for the wPOKT LP Staking app raid. It composes of UI, UX and smart contract interactions to deliver a pleasant and simple interface for users to gain wPOKT-related yield.
#### Tech Stack
- NextJS
- Chakra UI
- Wagmi/Ethers
- Rainbowkit
#### UI Components
Below is an overview of the visual components to be built. Further details of these components can be found in the design scope.
- Navigation/Header
- Main
- Staking section
- Claim section
- APY estimation display
- Balance and Rewards display
- Toasts/Modals
*Note, components from the wPOKT Bridge raid will be reused in this raid whenever possible for speed and cost efficiency.*
#### Functions
* APY calculation
* Estimates returns based on amount (to be) staked
* Rewards timer
* Indicates time for next round of wPOKT released
* Fetching balance and rewards
* Staking
* Claiming
* Feedback & Error Handling
* This includes, but not limited to, UI/UX animations, transaction errors and event handling.
---
### Smart Contracts Overview
The Pocket Network wants to provide liquidity incentives for participating liquidity providers. We will use bullet-proof and battle tested contracts without modification for this; especially the OpenZeppelin library and Synthetix Core Staking Rewards contract.
#### Tech Stack
- [Synthetix Staking Rewards](https://github.com/Synthetixio/synthetix/blob/develop/contracts/StakingRewards.sol)
- [OpenZeppelin Contracts Library](https://github.com/OpenZeppelin)
- SafeERC20
- ReentrancyGuard
- SafeMath
- [Foundry](https://book.getfoundry.sh/)
#### Deliverables
- Deployed and initialized staking rewards contract.
- Code repository specific to the Pocket Network and deployment script for Foundry
- Documentation and instructions for deploying new staking rewards contracts
## Milestones
1) July 21st
+ UI Design
2) Aug 4th
+ Front End
+ Smart Contracts
+ Full Build
### Out of Scope
### Required Resources
TBD
----
## Proposal
| | Estimate | Time Estimate |
| ------------- | -------- | -------------
| UI Design | $ 1,800 wxDAI | 1 weeks |
| Front End | $ 4,200 wxDAI | 1.5 weeks |
| Smart Contracts | $ 3,500 wxDAI | 1 weeks|
| **Total Estimate** | **$ 9,500wxDAI**| **2.5 weeks** |
*Note: UI design and the development work can be run in conjunction. Conservative estimate would involve an overlap in SC and FE work.*
*Note: the above figures include administration and project management*
## Payment
Verified payment of **$ 9,500wxDAI** into RaidGuild's smart escrow service will initiate the project.
> https://smartescrow.raidguild.org
> Raid ID: 6bfd6656-f8b8-409c-ab10-1492b8cc75f5
Please connect with your EOA to submit payment into escrow.
Upon successful completion of deliverables, we will ask you to release the full funds in escrow.
## In case of dispute
If you lose confidence in the Raid Party at any time, you may `Lock` the remaining funds in escrow.
If you do not release funds upon completion of deliverables, the Raid Party may `Lock` the remaining funds in escrow.
In both cases, the `Lock` triggers the arbitration provider (i.e., LexDAO) to review the dispute. Based on their review, the arbitration provider will decide which party should receive what amount of funds, and will send a transaction to the escrow contract that will transfer the appropriate amounts to each party.
We sincerely hope this won't be the case, but all parties are protected nevertheless.
**We look forward to Raiding, please reach out with any questions or concerns!**
<br />

<br />