-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #417 from djeck1432/feat/documentation
Added Defi_spring and Spotnet Documentation
- Loading branch information
Showing
6 changed files
with
288 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -87,4 +87,4 @@ services: | |
|
|
||
| volumes: | ||
| postgres_data: | ||
| redis_data: | ||
| redis_data: | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| import React, { useEffect } from 'react'; | ||
| import './defi-spring.css'; | ||
| import TableOfContents from '../../../components/TableOfContent/TableOfContents'; | ||
| import ScrollButton from '../../../components/scrollButton/ScrollButton'; | ||
| import Sections from 'components/Sections'; | ||
|
|
||
| const Documentation = () => { | ||
|
|
||
| useEffect(() => { | ||
| window.scrollTo(0, 0); | ||
| }, []); | ||
|
|
||
|
|
||
| const tableOfContents = [ | ||
| { title: 'Introduction', link: '#introduction' }, | ||
| { | ||
| title: 'Program overview', | ||
| link: '#overview', | ||
| }, | ||
| { title: 'Claiming rewards', link: '#claiming-rewards' }, | ||
| { title: 'Important notes', link: '#important-notes' }, | ||
| { title: 'Maximize your profit', link: '#maximize-your-profit' }, | ||
| { title: 'The Hub And Zones', link: '#hub-2' }, | ||
| { title: 'The Hub And Zones', link: '#hub-3' }, | ||
| { title: 'The Hub And Zones', link: '#hub-4' }, | ||
| { title: 'The Hub And Zones', link: '#hub-5' } | ||
| ]; | ||
|
|
||
| const sectionsData = [ | ||
| { | ||
| id: 'Introduction', | ||
| title: 'introduction', | ||
| content: [ | ||
| { | ||
| type: 'text', | ||
| value: | ||
| 'Welcome to the DeFi Spring Program!\nwhere you can earn rewards through the zkLend protocol. As part of this initiative, participants will have the opportunity to receive STRK token rewards for engaging with the platform. Here’s everything you need to know to get started and make the most of your participation.', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| id: 'overview', | ||
| title: 'Program Overview', | ||
| content: [ | ||
| { | ||
| type: 'list', | ||
| items: [ | ||
| 'Start Date: March 14, 2024, at 00:00 UTC.', | ||
| 'Duration: 6-8 months.', | ||
| 'Eligibility: Open to everyone!.', | ||
| 'Reward APR: The approximate $STRK rewards APR will be displayed next to eligible supply and borrow pools, in addition to the base interest rate.', | ||
| ] | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| id: 'claiming-rewards', | ||
| title: 'Claiming rewards', | ||
| content: [ | ||
| { | ||
| type: 'list', | ||
| items: [ | ||
| 'Reward Phases: Rewards are earned in phases, each lasting from Thursday to Wednesday. After each phase ends, it will take about 1 day for the rewards to be claimable.', | ||
| 'Reward Claims: Rewards can be claimed via zkLend Rewards.', | ||
| 'Accrued Rewards: The total rewards earned will be visible at the end of the program. You can claim your rewards all at once at that time.', | ||
| 'Final Claim Deadline: Be sure to claim your rewards before the DeFi Spring program ends. Any unclaimed rewards will be returned to the Starknet Foundation.' | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
|
|
||
| { | ||
| id: 'important-notes', | ||
| title: 'Important notes', | ||
| content: [ | ||
| { | ||
| type: 'list', | ||
| items: [ | ||
| 'Dynamic APRs: The APRs (Annual Percentage Rates) are updated daily based on market conditions, pool sizes, and allocations from the Starknet Foundation. These rates may change throughout the program.', | ||
| 'Incentive Strategy: Different actions, such as depositing or borrowing, may receive varying rewards depending on market dynamics', | ||
| 'Recursive Borrow Adjustment: Rewards are based on your net deposit after accounting for borrowed funds. For example, if you deposit 100 ETH and borrow 50 ETH, your net deposit is considered 50 ETH. Recursive borrowers will see a higher APR than what they ultimately claim.', | ||
| 'Stablecoin Considerations: From Phase 3 onward, stablecoins (USDC, USDT, DAI) will be treated as the same asset for reward calculations. Your eligible net deposit for these will be calculated as the value of stablecoins deposited minus the value of stablecoins borrowed.' | ||
| ], | ||
| }, | ||
|
|
||
| ], | ||
| }, | ||
|
|
||
| { | ||
| id: 'maximize-your-profit', | ||
| title: 'Maximize your profit', | ||
| content: [ | ||
| { | ||
| type: 'text', | ||
| value: 'By participating in the DeFi Spring program, you can leverage your assets and earn additional rewards, contributing to a more liquid and dynamic DeFi ecosystem. Keep an eye on your rewards as you participate, and make the most out of the program!' | ||
| }, | ||
|
|
||
| ], | ||
| }, | ||
|
|
||
| ]; | ||
|
|
||
| return ( | ||
| <div className="documentation-page"> | ||
| <TableOfContents tabelTitle={"Table Of Content"} defaultActiveId={"introduction"} headerHeight={80} items={tableOfContents} /> | ||
|
|
||
| <div className="main-content"> | ||
| <h1 className="main-title">Defi Spring Documentation</h1> | ||
| <Sections sections={sectionsData} /> | ||
| </div> | ||
|
|
||
| <ScrollButton /> | ||
| </div> | ||
|
|
||
| ); | ||
| }; | ||
|
|
||
| export default Documentation; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| .documentation-container { | ||
| display: flex; | ||
| min-height: 100vh; | ||
| color: var(--primary); | ||
| position: relative; | ||
| padding-top: 70px; | ||
| } | ||
|
|
||
| .documentation-container::before { | ||
| content: ''; | ||
| position: absolute; | ||
| top: 0; | ||
| right: 0; | ||
| width: 100%; | ||
| height: 100%; | ||
| background-image: radial-gradient(circle at 85% 15%, rgba(255, 255, 255, 0.25) 1px, transparent 1px), | ||
| radial-gradient(circle at 15% 85%, rgba(255, 255, 255, 0.25) 1px, transparent 1px), | ||
| radial-gradient(circle at 75% 75%, rgba(255, 255, 255, 0.25) 1px, transparent 1px); | ||
| background-size: 100px 100px; | ||
| pointer-events: none; | ||
| z-index: 0; | ||
| } | ||
|
|
||
| .main-content { | ||
| margin-left: 370px; | ||
| flex: 1; | ||
| background: url('../../../../public/background.png') no-repeat; | ||
| background-size: cover; | ||
| background-position: center 39%; | ||
| position: relative; | ||
| min-height: 100vh; | ||
| } | ||
|
|
||
| .sections-container { | ||
| margin-left: 20px; | ||
| } | ||
|
|
||
| .main-title { | ||
| font-size: 2.5rem; | ||
| font-weight: 700; | ||
| margin-top: 94px; | ||
| margin-bottom: 3rem; | ||
| margin-left: 40px; | ||
| color: white !important; | ||
| background: white; | ||
| -webkit-background-clip: text; | ||
| -webkit-text-fill-color: transparent; | ||
| } | ||
|
|
||
| html { | ||
| scroll-behavior: smooth; | ||
| scroll-padding-top: 80px; | ||
| } | ||
|
|
||
| @media (max-width: 1440px) { | ||
| .main-content { | ||
| margin-left: 280px; | ||
| } | ||
| } | ||
|
|
||
| @media (max-width: 768px) { | ||
| .main-content { | ||
| margin-left: 0; | ||
| padding: 1rem; | ||
| } | ||
|
|
||
| .main-title { | ||
| font-size: 2rem; | ||
| } | ||
| } |