Skip to content

Commit

Permalink
Add new category and pages for concepts and strategies
Browse files Browse the repository at this point in the history
  • Loading branch information
ioanSL committed Feb 8, 2024
1 parent 6bff39d commit 6bf4b3d
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 45 deletions.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ title: Overview
sidebar_position: 1
---

# Nimbora Strategies
# Nimbora Overview
File renamed without changes.
27 changes: 0 additions & 27 deletions docs/contracts/architecture/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,32 +19,5 @@ Nimbora Sync Yield allows users to access L1 yields from L2 without delay, addit

![arch](/content/arch.png)

## L2 Contracts

### Pooling Manager

The pooling manager plays an intermediate role with L2 strategies and L1 communication. The idea is to significantly reduce gas costs on L1 by hashing all of the data and mutualizing bridge transfer. He is also responsible for registering all available strategies and is the only one able to process reports. although he is processing all at once, he is also able to process only one report individually so a broken strategy has no impact on others.

### Pooling Factory

The pooling factory is the contract used to deploy new “strategy packages”: token, and token manager, those contracts are the same for any strategy.

### N-yield Token Manager

The token manager contains all the logic for token accountability through a strategy report, setting the share price at each epoch. It is also the entry point for deposit and withdraw, only this contract can mint or burn tokens.

### N-yield Token

The Nimbora yield token represents the l1 strategy yield-bearing token, increasing in value at each epoch. Once minted, it can be used in DeFi through the Starknet ecosystem.

## L1 Contracts

### Pooling Manager

The pooling manager plays an intermediate role with L1 strategies and L2 communication. The contract receives a payload of data, containing all the information required to cover L2 strategy requests: deposit more in a strategy, inform the underlying NAV, or withdraw some assets.

### Strategy handler

The strategy handler is an adapter used to interact with strategies, it receives data of payload similar for each handler and processes the request before returning the new NAV of the strategy and potentially some ETH to bridge.

Nimbora Yield DEX off-chain services allow for the indexing and processing L1 and L2 reports. For more details, please check this link.
20 changes: 10 additions & 10 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,21 @@ const config = {
},
items: [
{
to: 'docs/contracts/architecture/overview',
to: 'docs/concepts/overview',
position: 'left',
label: 'Contracts',
label: 'Concepts',
className: 'V3_active'
},
{
to: 'docs/sdks/sdk/overview',
to: 'docs/contracts/architecture/overview',
position: 'left',
label: 'SDK',
label: 'Contracts',
className: 'V3_active'
},
{
to: 'docs/strategies/overview',
to: 'docs/sdks/sdk/overview',
position: 'left',
label: 'Strategies',
label: 'SDK',
className: 'V3_active'
},
{
Expand All @@ -98,6 +98,10 @@ const config = {
{
title: 'Docs',
items: [
{
to: 'docs/concepts/overview',
label: 'Concepts',
},
{
to: 'docs/contracts/architecture/overview',
label: 'Contracts',
Expand All @@ -106,10 +110,6 @@ const config = {
to: 'docs/sdks/sdk/overview',
label: 'SDK',
},
{
to: 'docs/strategies/overview',
label: 'Strategies',
},
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
contractsSidebar: [{type: 'autogenerated', dirName: 'contracts'}],
sdkSidebar: [{type: 'autogenerated', dirName: 'sdks'}],
strategiesSidebar: [{type: 'autogenerated', dirName: 'strategies'}],
strategiesSidebar: [{type: 'autogenerated', dirName: 'concepts'}],
};

export default sidebars;
12 changes: 6 additions & 6 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ import { ArrowUpRight as LinkIcon, BookOpen, HelpCircle, Info, MessageCircle } f


export const actions = [
{
title: 'What is Nimbora',
icon: HelpCircle,
to: '/docs/concepts/overview',
text: 'Learn about Nimbora and how to interact with it L1 and L2 strategies',
},
{
title: 'Nimbora Smart Contracts',
icon: Info,
Expand All @@ -22,12 +28,6 @@ export const actions = [
to: '/docs/sdks/sdk/overview',
text: 'Learn how to integrate Nimbora with your application',
},
{
title: 'What is Nimbora',
icon: HelpCircle,
to: '/docs/strategies/overview',
text: 'Learn about Nimbora and how to interact with it L1 and L2 strategies',
}
]

const IconWrapper = styled.div`
Expand Down

0 comments on commit 6bf4b3d

Please sign in to comment.