Merge pull request #8 from 0xSpaceShard/develop

Docs v1.0.0

.snyk

@@ -0,0 +1,33 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.25.1
+ignore: {}
+# patches apply the minimum changes required to fix a vulnerability
+patch:
+  'npm:hoek:20180212':
+    - theme > pkghub > npm > node-gyp > request > hawk > hoek:
+        patched: '2024-02-20T07:21:09.958Z'
+        id: 'npm:hoek:20180212'
+        path: theme > pkghub > npm > node-gyp > request > hawk > hoek
+    - theme > pkghub > npm > node-gyp > request > hawk > boom > hoek:
+        patched: '2024-02-20T07:21:09.958Z'
+        id: 'npm:hoek:20180212'
+        path: theme > pkghub > npm > node-gyp > request > hawk > boom > hoek
+    - theme > pkghub > npm > node-gyp > request > hawk > sntp > hoek:
+        patched: '2024-02-20T07:21:09.958Z'
+        id: 'npm:hoek:20180212'
+        path: theme > pkghub > npm > node-gyp > request > hawk > sntp > hoek
+  'npm:minimatch:20160620':
+    - theme > pkghub > glob > minimatch:
+        patched: '2024-02-20T07:21:09.958Z'
+        id: 'npm:minimatch:20160620'
+        path: theme > pkghub > glob > minimatch
+  'npm:tunnel-agent:20170305':
+    - theme > pkghub > npm > request > tunnel-agent:
+        patched: '2024-02-20T07:21:09.958Z'
+        id: 'npm:tunnel-agent:20170305'
+        path: theme > pkghub > npm > request > tunnel-agent
+  'npm:uglify-js:20151024':
+    - theme > pkghub-render > swig > uglify-js:
+        patched: '2024-02-20T07:21:09.958Z'
+        id: 'npm:uglify-js:20151024'
+        path: theme > pkghub-render > swig > uglify-js

docs/concepts/benefits.md

@@ -0,0 +1,35 @@
+---
+id: benefits
+title: Benefits of using Nimbora
+sidebar_position: 2
+---
+
+# Introduction to Nimbora's Cost-Efficiency
+
+Nimbora stands out in the blockchain space primarily due to its innovative approach to minimizing transaction costs for its users. The platform achieves this remarkable feat by leveraging the power of Layer 2 (L2) solutions, specifically Starknet, to offer gas fees that are up to seven times lower than those on the Ethereum mainnet. This significant cost reduction opens up new possibilities for users, making decentralized finance (DeFi) interactions more accessible and economical.
+
+## Understanding Gas Fees Reduction through Layer 2 Solutions
+
+### The Role of Starknet in Reducing Costs
+
+Starknet plays a crucial role in Nimbora's ability to offer reduced gas fees. As an advanced Layer 2 solution, Starknet enhances the scalability of the blockchain by processing transactions off the main Ethereum chain. This process not only speeds up transactions but also significantly lowers the cost associated with them. By utilizing Starknet, Nimbora taps into these benefits, passing the savings directly to its users.
+
+### Batching Mechanism: Pooling Transactions for Efficiency
+
+Nimbora introduces an innovative batching mechanism that further enhances its cost-efficiency. This mechanism allows users to pool their transactions together, creating a collective action that can interact with DeFi protocols on the Layer 1 (L1) network at a fraction of the usual price. By doing so, Nimbora not only makes transactions more affordable but also fosters a more inclusive and accessible DeFi ecosystem.
+
+## In-Depth Look at Nimbora's Transaction Processing
+
+### The L2 Pooling Manager: Accumulating and Batching Requests
+
+The transaction process begins when the Nimbora L2 Pooling Manager contract receives a request from a user. This contract acts as a collector, gathering individual requests into a new batch. The batching continues until the batch reaches its capacity. At this point, the L2 Pooling Manager packages all the requests into a single bundle and forwards it to the L1 Pooling Manager contract for further processing.
+
+### L1 Verification and Asset Handling
+
+Upon receiving the batch from the L2 side, the L1 Pooling Manager contract must wait for the batch to be verified on the Ethereum mainnet. This verification process is subject to network congestion but typically completes within a 12-hour window. Once verified, the L1 Pooling Manager interacts with the Starkgate Bridge to retrieve the necessary assets. These assets are then deposited according to the predetermined strategies.
+
+### Reporting and Feedback Loop
+
+The final step in the transaction process involves the L1 Pooling Manager generating a detailed report. This report confirms the successful deposit of assets and is sent back to the L2 Pooling Manager. This feedback loop ensures transparency and trust in the transaction process, allowing users to confidently engage with Nimbora's DeFi ecosystem.
+
+By adopting these advanced mechanisms and leveraging Layer 2 solutions like Starknet, Nimbora is paving the way for a more affordable and accessible blockchain experience. Its innovative approach to transaction batching and cost reduction not only benefits individual users but also contributes to the broader goal of fostering a more inclusive DeFi ecosystem.

docs/concepts/overview.md

@@ -1,26 +1,52 @@
 ---
 id: overview
-title: Overview
+title: About Nimbora
 sidebar_position: 1
 ---
 
 # Nimbora Overview
 
-Nimbora is a platform that offers you the opportunity to interact with your favorite Layer 1 (L1) protocols at a fraction of the cost of Layer 2 (L2) solutions.
+Nimbora is a 1-click DeFi pooling product, incubated by the [SpaceShard team](https://www.spaceshard.io/).
 
-## L2 vs L1: Benefits of using Nimbora
+It is a platform that offers you the opportunity to interact with your favorite Layer 1 (L1) protocols at a fraction of the cost of Layer 2 (L2) solutions. The idea behind it is to scale L1 DeFi through seamless L2 execution, all while maintaining super-low fees. The technology behind Nimbora is Zero-Knowledge Rollups, currently Starknet - a permissionless decentralized ZK-Rollup that operates as an L2 network over Ethereum. To put it simply, Nimbora scales L1 DeFi products completely trustlessly using rollups.
 
-The main benefit of using Nimbora is the decreases in gas fees, up to 7x compared with Ethereum mainnet. This significant reduction in gas fees is achieved through the utilization of innovative Layer 2 solutions. These solutions perform most transactions off-chain, only settling the final state on the Ethereum mainnet. This drastically reduces the number of transactions that need to be processed on the congested Ethereum network, thereby reducing overall gas fees. This makes transactions on Nimbora more affordable and accessible for all users, fostering a more inclusive DeFi ecosystem.
+You can learn more about Nimbora by following us on [Medium](https://medium.com/@Nimbora), [Twitter](https://twitter.com/nimbora_io), or by joining our [Discord group](https://discord.gg/feJJnkmYzc).
+
+You can also check out our founder's talk from ETHDenver about the [experience of building Nimbora: a Cross-Chain Yield DEX on Starknet](https://twitter.com/i/status/1762609002435727749)
+
+## Starknet
+
+Starknet is a Layer-2 network that utilizes zk-STARKs technology to enhance Ethereum transactions. It aims to make transactions faster, cheaper, and more secure. Official Starknet token is [STRK](https://www.starknet.io/en/content/claiming-your-strk), launched on Feb 20, 2024.
+
+:::note
+Key features:
+- Low costs
+- Developer-friendly
+- Speed and efficiency
+:::
+
+More info at [Starknet website](https://www.starknet.io/en) or check [Spaceshard's blog](https://www.spaceshard.io/blog/learning-starknet-community-edu-resources) to learn about Starknet.
 
 ## What wallets can I connect with?
 
 At the moment, Nimbora supports compatibility with [Argent X wallet](https://www.argent.xyz/argent-x/) and [Braavos wallet](https://braavos.app/). Argent X is a smart wallet designed to provide a simple and secure way to manage and invest digital assets. On the other hand, Braavos wallet is a decentralized wallet known for its user-friendly interface and high-level security features. The integration of these wallets with Nimbora allows users to conveniently interact with preferred Layer 1 protocols at a significantly reduced cost. Nimbora is committed to enhancing user experience and thus, plans to integrate more wallets in the near future.
 
-## Transaction processing and batching
+:::important
+
+Please be aware that **there is still no official Nimbora token launched,** nor a public sale of Nimbora tokens by any entity! Be alert for scams around any token claims and provisions, including fake links and accounts impersonating Nimbora. Make sure to follow the information in our official channels only:
+
+[Twitter](https://twitter.com/nimbora_)
+
+[Discord](https://discord.gg/feJJnkmYzc)
+
+[Website](https://www.nimbora.io/)
+
+[Medium](https://medium.com/@Nimbora)
 
-When the Nimbora [L2 Pooling Manager](/docs/contracts/architecture/L2_arch.md#pooling-manager) contract receives a requests, it opens a new batch and accumulates those requests until the batch is full. Once the batch is full, the contract will empack all the requests and send them to the [L1 Pooling Manager](/docs/contracts/architecture/L1_arch.md#pooling-manager) contract. This message will take some time to be verified on L1 depending on the network congestion, but it should not take more than 12h. Once the block is validated on L1, the message is ready to be consumed by the L1 Pooling Contract.
+[LinkedIn](https://www.linkedin.com/company/nimbora/)
 
-When consuming the message, the L1 Pooling Manager will get the assets to be handled from the Starkgate Bridge and deposit them within the strategies. Finally, the L1 Pooling Manager will generate a report to inform the L2 Pooling Manager that the deposits were made correctly.
+Email subscription: link coming soon
+:::
 
 ## Where can I get help?
 

docs/concepts/risks/01-risk-lusd.md

@@ -0,0 +1,31 @@
+---
+id: liquity_lsud
+title: LUSD strategy
+sidebar_position: 2
+---
+
+# Understanding Risks Associated with Liquity
+
+[Liquity](https://www.liquity.org/) is a decentralized borrowing protocol that allows users to take out loans against Ethereum collateral without paying interest. These loans are paid out in LUSD, a stablecoin pegged to the USD. While our previous guide covered the basic risks associated with using Liquity, this expanded guide incorporates insights from recent discussions about price stability and addresses concerns within the Liquity ecosystem.
+
+## Expanded Risks and Features in Liquity
+
+### Price Stability and the Redemption Mechanism
+
+- **Redemption Mechanism**: A unique feature of Liquity is its redemption mechanism, allowing LUSD holders to redeem their LUSD for the underlying ETH collateral at face value anytime. This mechanism is crucial for maintaining the price stability of LUSD and ensuring it remains pegged to $1.
+- **Impact on Borrowers**: If one Trove (the term for a loan account in Liquity) is redeemed against, you won't experience a net loss but may lose some of your ETH exposure while receiving a lesser debt. To minimize the risk of being affected by redemptions, maintaining a collateral ratio significantly above the minimum requirement (110%) is advisable. A ratio of 150% or higher is generally recommended according to Liquity sources.
+
+### Strategic Considerations for Trove Owners
+
+- **Monitoring and Adjusting**: Nimbora Troves are monitored to stay out of the "line of fire" of redemptions. This proactive approach can help maintain a desired level of ETH exposure while managing your debt in LUSD.
+
+### Liquity's Funding and Development
+
+- **Series A Funding**: Liquity has secured $6 million in Series A funding, led by Pantera Capital and supported by other notable investors. This investment underscores the confidence in Liquity's potential and its role in the DeFi ecosystem.
+- **Ongoing Development**: Liquity is built on experimental technology that is still under active development. The team's commitment to security, evidenced by regular audits and a significant bug bounty program, aims to minimize risks related to smart contract vulnerabilities.
+
+## Conclusion
+
+Liquity's innovative approach to decentralized borrowing, characterized by its no-interest loans, low collateral requirements, and unique redemption mechanism, offers significant opportunities for users. However, understanding the associated risks, especially those related to price stability and the redemption mechanism, is crucial for informed participation in the Liquity ecosystem. By staying informed and strategically managing your loan, you can navigate these risks while taking advantage of what Liquity has to offer.
+
+Remember, informed decision-making is key to navigating the complexities of decentralized finance (DeFi).

docs/concepts/risks/02-risk-sdai.md

@@ -0,0 +1,32 @@
+---
+id: sdai
+title: sDAI strategy
+sidebar_position: 3
+---
+
+# Understanding Risks Associated with sDAI
+
+When considering the use of [sDAI](https://spark.fi/) through Nimbora, it's crucial for users, especially those who are not deeply technical, to understand the associated risks. This guide aims to simplify the primary risk related to using sDAI in an accessible manner.
+
+## No Yield Generation
+
+### What Does This Mean?
+
+- **Yield Generation**: In the context of decentralized finance (DeFi), yield refers to the earnings generated over time by your cryptocurrency investments. It's akin to earning interest in a traditional savings account but within the DeFi ecosystem.
+- **Risk with sDAI**: The sole risk associated with sDAI is the potential for your deposit not to generate any yield. This means that, despite your investment, there could be periods where you do not earn additional sDAI or other returns on your deposited DAI.
+
+### Why Might This Happen?
+
+The yield in DeFi platforms, including those involving sDAI, is influenced by various factors such as market demand, the platform's protocol mechanics, and broader economic conditions. There may be times when these factors align in such a way that yield generation is temporarily halted or significantly reduced.
+
+### What Should You Consider?
+
+- **Investment Goals**: Understand your investment timeline and goals. If generating immediate yield is crucial for your strategy, consider how the risk of no yield with sDAI aligns with your objectives.
+- **Market Research**: Stay informed about the market conditions and factors that could influence yield generation. This knowledge can help you make more informed decisions.
+- **Diversification**: Consider diversifying your DeFi investments to mitigate the risk of no yield on a specific asset like sDAI.
+
+## Conclusion
+
+While sDAI offers a novel way to potentially earn yield on your DAI deposits within the DeFi ecosystem, it's important to be aware of the risk that your investment may not generate yield. By understanding this risk and considering your investment strategy carefully, you can better navigate the DeFi space and make choices that align with your financial goals.
+
+Remember, informed decision-making is key to managing risks and capitalizing on opportunities in the world of decentralized finance.

docs/concepts/risks/03-risk-lStaking.md

@@ -0,0 +1,37 @@
+---
+id: liquid_stake
+title: wstETH Strategy
+sidebar_position: 4
+---
+
+# Understanding Risks Associated with LIDO and Liquid Staking
+
+[LIDO](https://lido.fi/) and its approach to liquid staking on Ethereum's Beacon Chain present an innovative way for users to earn staking rewards without locking up their assets. However, as with any investment, there are inherent risks involved. This guide aims to break down these risks in simple terms.
+
+## Key Risks in LIDO and Liquid Staking
+
+### Smart Contract Security Risk
+
+- **What It Means**: Like any program, LIDO's smart contracts (the code that runs its operations) could have vulnerabilities or bugs.
+- **Mitigation Efforts**: LIDO's code is open-source, meaning anyone can review it, and it undergoes regular audits to identify and fix potential vulnerabilities. Additionally, LIDO has a substantial bug bounty program with Immunefi to encourage the discovery and reporting of any issues.
+
+### Beacon Chain: Technical Risk
+
+- **What It Means**: LIDO operates on the Beacon Chain, part of Ethereum's upgrade to a more efficient system. This technology is still experimental and under development, which means it could have undiscovered errors.
+- **Mitigation Efforts**: While LIDO cannot directly control the Beacon Chain's development, it continuously monitors and adapts to changes and updates within the ecosystem.
+
+### Slashing Risk
+
+- **What It Means**: Validators (the entities that confirm transactions on the Beacon Chain) face penalties, known as slashing, if they fail in their duties. This can affect up to 100% of the staked funds.
+- **Mitigation Efforts**: LIDO diversifies its staking across multiple reputable node operators to spread out this risk. It also has self-coverage mechanisms in place to mitigate potential losses from slashing.
+
+### wstETH Price Risk
+
+- **What It Means**: The exchange price of wstETH (the token you get for staking ETH through LIDO) could be lower than its actual value. This discrepancy is partly because withdrawals from LIDO are restricted, making it difficult to arbitrage or make risk-free profits.
+- **Mitigation Efforts**: The LIDO DAO (decentralized autonomous organization) actively works to minimize these risks and aims to eliminate them as much as possible.
+
+## Conclusion
+
+While LIDO offers a compelling solution for earning staking rewards without locking up assets, it's essential to be aware of the associated risks. These include smart contract vulnerabilities, technical risks related to the Beacon Chain, slashing risks for validators, and wstETH price fluctuations. By understanding these risks and the efforts made to mitigate them, users can make more informed decisions about liquid staking with LIDO.
+
+Remember, informed decision-making is crucial in navigating the evolving landscape of decentralized finance (DeFi).

docs/concepts/risks/_category_.json

@@ -0,0 +1,5 @@
+{
+    "label": "Risks",
+    "position": 4,
+    "collapsed": false
+}