Feature/new docs

.gitignore

@@ -0,0 +1,24 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.vscode
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+external/sdk
+docs/sdk/**/*.ts

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "external/sdk"]
+	path = external/sdk
+	url = [email protected]:stakewise/v3-sdk.git

README.md

@@ -1,125 +1,41 @@
----
-description: Everything you want to know about StakeWise at your fingertips
-cover: .gitbook/assets/Frame 27513376 (1).png
-coverY: 0
----
+# Website
 
-# Main Hub
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
 
-Welcome to StakeWise - the premier liquid staking protocol on Ethereum and Gnosis Chain.  
+### Installation
 
-To find out more about StakeWise and the StakeWise DAO please refer to the sections below.
+```
+$ yarn
+```
 
-### What can I do with StakeWise?
+### Local Development
 
-{% tabs %}
-{% tab title="ETH" %}
-StakeWise is a liquid staking protocol that enables simple and secure ETH staking for individuals and organizations. It also provides the tools & software to allow anyone to launch their own staking Pool (called Vault) and earn fees by running validators for others. 
+```
+$ yarn start
+```
 
-All Ether staked using StakeWise can be made liquid with osETH, a liquid staking token.
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
 
-### Staking with StakeWise
+### Build
 
-* [<mark style="color:blue;">How to stake with StakeWise</mark>](guides/staking.md)
-* [<mark style="color:blue;">How to solo stake with StakeWise</mark>](guides/staking.md#liquid-solo-staking)
-* [<mark style="color:blue;">How to get osETH</mark>](guides/ostoken.md)
+```
+$ yarn build
+```
 
-### Running a Vault with StakeWise
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
 
-* [<mark style="color:blue;">How to launch a Vault with StakeWise</mark>](guides/running-a-vault.md)
+### Deployment
 
-### Use cases
+Using SSH:
 
-For all guides on how to use StakeWise please refer to the [Guides](broken-reference) section.
-{% endtab %}
+```
+$ USE_SSH=true yarn deploy
+```
 
-{% tab title="GNO" %}
-StakeWise is a liquid staking protocol that enables simple and secure GNO staking for individuals and organizations. It also provides the tools & software to allow anyone to launch their own staking Pool (called Vault) and earn fees by running validators for others.&#x20;
+Not using SSH:
 
-All GNO staked using StakeWise can be made liquid with osGNO, a liquid staking token.
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
 
-### Staking with StakeWise
-
-* [<mark style="color:blue;">How to stake with StakeWise</mark>](guides/staking.md)
-* [<mark style="color:blue;">How to solo stake with StakeWise</mark>](guides/staking.md#liquid-solo-staking)
-* [<mark style="color:blue;">How to get osGNO</mark>](guides/ostoken.md)
-
-### Running a Vault with StakeWise
-
-* [<mark style="color:blue;">How to launch a Vault with StakeWise</mark>](guides/running-a-vault.md)
-
-### Use cases (coming up)
-
-For all guides on how to use StakeWise please refer to the [Guides](broken-reference) section.&#x20;
-{% endtab %}
-{% endtabs %}
-
-### How does StakeWise work?
-
-{% tabs %}
-{% tab title="ETH" %}
-The main components of the StakeWise protocol are Vaults, osETH token, and Oracles.
-
-### Vaults
-
-Users stake ETH into different Vaults and earn ETH rewards, while Vault operators earn a staking fee in exchange. Anyone can launch their own Vault to allow others to stake in it.
-
-[<mark style="color:blue;">Read more about Vaults -></mark>](protocol-overview-in-depth/vaults.md)
-
-### osETH
-
-osETH is a token for liquid staking that accrues ETH rewards to its holders. It can be used in DeFi to trade staked ETH and farm additional rewards.&#x20;
-
-osETH is minted by stakers in Vaults that want to use their stake in DeFi. Anyone can swap their ETH for osETH in DeFi to start earning ETH rewards by holding the token.&#x20;
-
-[<mark style="color:blue;">Read more about osETH -></mark>](protocol-overview-in-depth/ostoken.md)
-
-### Oracles
-
-Oracles ensure that Vaults register validators without assuming custody of funds, calculate Vault rewards, and push information about validator registrations and exits on-chain.&#x20;
-
-[Read more about Oracles ->](protocol-overview-in-depth/oracles.md)
-{% endtab %}
-
-{% tab title="GNO" %}
-The main components of the StakeWise protocol are Vaults, osGNO token, and Oracles.&#x20;
-
-### Vaults
-
-Users stake GNO into different Vaults and earn GNO rewards, while Vault operators earn a staking fee in exchange. Anyone can launch their own Vault to allow others to stake in it.
-
-[<mark style="color:blue;">Read more about Vaults -></mark>](protocol-overview-in-depth/vaults.md)
-
-### osGNO
-
-osGNO is a token for liquid staking that accrues GNO rewards to its holders. It can be used in DeFi to trade staked GNO and farm additional rewards.&#x20;
-
-osGNO is minted by stakers in Vaults that want to use their stake in DeFi. Anyone can swap their GNO for osGNO in DeFi to start earning GNO rewards by holding the token.&#x20;
-
-[<mark style="color:blue;">Read more about osGNO -></mark>](protocol-overview-in-depth/ostoken.md)
-
-### Oracles
-
-Oracles ensure that Vaults register validators without assuming custody of funds, calculate Vault rewards, and push information about validator registrations and exits on-chain.&#x20;
-
-[Read more about Oracles ->](protocol-overview-in-depth/oracles.md)
-{% endtab %}
-{% endtabs %}
-
-<details>
-
-<summary>What is StakeWise DAO and how can I get involved?</summary>
-
-StakeWise DAO is a community of SWISE token holders that govern the parameters of the StakeWise protocol and control the assets of its Treasury.&#x20;
-
-### Governance resources
-
-* [<mark style="color:blue;">StakeWise Forum</mark> 🔗](https://forum.stakewise.io)
-* [<mark style="color:blue;">StakeWise Snapshot</mark> 🔗](https://vote.stakewise.io)
-* [<mark style="color:blue;">StakeWise Governance Principles</mark> 🔗](https://forum.stakewise.io/t/stakewise-dao-governance-process/49)
-
-</details>
-
-Join the vibrant and welcoming StakeWise community across our socials!
-
-<table data-view="cards" data-full-width="false"><thead><tr><th></th><th align="center"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td align="center"><img src=".gitbook/assets/Logo_of_Twitter.svg.png" alt="" data-size="line"><a href="https://twitter.com/stakewise_io">  <strong>StakeWise Twitter</strong></a></td><td></td><td><a href="https://twitter.io/stakewise_io">https://twitter.io/stakewise_io</a></td><td></td></tr><tr><td></td><td align="center"><img src=".gitbook/assets/636e0a6a49cf127bf92de1e2_icon_clyde_blurple_RGB-2 (1).png" alt="" data-size="line">  <a href="https://discord.com/invite/2BSdr2g"><strong>StakeWise Discord</strong></a></td><td></td><td><a href="https://discord.gg/stakewise">https://discord.gg/stakewise</a></td><td></td></tr><tr><td></td><td align="center"><img src=".gitbook/assets/Telegram_logo.svg-2.png" alt="" data-size="line"> <a href="https://t.me/stakewise_io"><strong>StakeWise Telegram</strong></a></td><td></td><td><a href="https://t.me/stakewise_io">https://t.me/stakewise_io</a></td><td></td></tr></tbody></table>
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/contracts/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Contracts",
+  "position": 0,
+  "link": {
+    "type": "doc",
+    "id": "contracts/index"
+  }
+}

docs/contracts/networks/Chiado.mdx

@@ -0,0 +1,40 @@
+---
+title: Chiado
+sidebar_position: 4
+---
+
+# Chiado
+
+:::custom-info[Block Explorer]
+View contracts on [Chiado Blockscout ↗](https://gnosis-chiado.blockscout.com)
+:::
+
+| Contract Name | Address |
+|---------------|---------|
+| BalancedCurator | `0xD30E7e4bDbd396cfBe72Ad2f4856769C54eA6b0b` |
+| BlocklistErc20VaultFactory | `0x39c6eef5f955bcC280966504bc5c82F2394Fa368` |
+| BlocklistVaultFactory | `0x608d8Ca6916b96edf63Dd429e62Fe1366ae6f3B5` |
+| ConsolidationsChecker | `0x033E5BaE5bdc459CBb7d388b41a9d62020Be810F` |
+| CuratorsRegistry | `0xa23F7c8d25f4503cA4cEd84d9CC2428e8745933C` |
+| DepositDataRegistry | `0xFAce8504462AEb9BB6ae7Ecb206BD7B1EdF7956D` |
+| Erc20VaultFactory | `0x97795DA27138BD8d79204D37F3A2e80fA4d30488` |
+| GenesisVault | `0xF82f6E46d0d0a9536b9CA4bc480372EeaFcd9E6c` |
+| Keeper | `0x5f31eD13eBF81B67a9f9498F3d1D2Da553058988` |
+| LegacyPoolEscrow | `0x928F9a91E674C886Cae0c377670109aBeF7e19d6` |
+| LegacyRewardToken | `0x14c74b1C7eCa8362D4ABcCd71051Ce174d61a3D4` |
+| MerkleDistributor | `0xd0747320d5457256D0203dfe61209Afbb90d22D7` |
+| MetaVaultFactory | `0x6107dB0bdd84023228E0aB11099190E88B073c1D` |
+| OsToken | `0x0b4F6bFB694790051E0203Db83edbB5888099556` |
+| OsTokenConfig | `0x6D5957e075fd93b3B9F36Da93d7462F14387706d` |
+| OsTokenFlashLoans | `0x7bC48037433d610C6069a873beA8CF7D3cE1Ff01` |
+| OsTokenRedeemer | `0xdF3123dD182b8d3e0266a2dC37eEb8366d149B5A` |
+| OsTokenVaultController | `0x5518052f2d898f062ee59964004A560F24E2eE7d` |
+| OsTokenVaultEscrow | `0x00aa8A78d88a9865b5b0F4ce50c3bB018c93FBa7` |
+| PriceFeed | `0x3CC131e6f6b975423151E5aaE8C466f4f81A8A4c` |
+| PrivErc20VaultFactory | `0x1831834dC4Bf88B9d9183015e1285B105Ec2FdC9` |
+| PrivVaultFactory | `0x4C958642F1CD735F13aed02A4FB015153edDf8Fd` |
+| RewardSplitterFactory | `0xd12Df8543e0522CCbF12d231e822B7264c634775` |
+| SharedMevEscrow | `0x453056f0bc4631abB15eEC656139f88067668E3E` |
+| ValidatorsChecker | `0x3b629aF425277FfD7cEB841a24e75d34F868651C` |
+| VaultFactory | `0x7A8cbBf690084E43De778173cfAcf7313c9122DD` |
+| VaultsRegistry | `0x8750594B33516232e751C8B9C350a660cD5f1BB8` |

docs/contracts/networks/Gnosis.mdx

@@ -0,0 +1,40 @@
+---
+title: Gnosis
+sidebar_position: 2
+---
+
+# Gnosis
+
+:::custom-info[Block Explorer]
+View contracts on [Gnosisscan ↗](https://gnosisscan.io)
+:::
+
+| Contract Name | Address |
+|---------------|---------|
+| BalancedCurator | `0xD30E7e4bDbd396cfBe72Ad2f4856769C54eA6b0b` |
+| BlocklistErc20VaultFactory | `0x39c6eef5f955bcC280966504bc5c82F2394Fa368` |
+| BlocklistVaultFactory | `0x608d8Ca6916b96edf63Dd429e62Fe1366ae6f3B5` |
+| ConsolidationsChecker | `0x033E5BaE5bdc459CBb7d388b41a9d62020Be810F` |
+| CuratorsRegistry | `0xa23F7c8d25f4503cA4cEd84d9CC2428e8745933C` |
+| DepositDataRegistry | `0x58e16621B5c0786D6667D2d54E28A20940269E16` |
+| Erc20VaultFactory | `0x97795DA27138BD8d79204D37F3A2e80fA4d30488` |
+| GenesisVault | `0x4b4406Ed8659D03423490D8b62a1639206dA0A7a` |
+| Keeper | `0xcAC0e3E35d3BA271cd2aaBE688ac9DB1898C26aa` |
+| LegacyPoolEscrow | `0xfc9B67b6034F6B306EA9Bd8Ec1baf3eFA2490394` |
+| LegacyRewardToken | `0x6aC78efae880282396a335CA2F79863A1e6831D4` |
+| MerkleDistributor | `0xFBceefdBB0ca25a4043b35EF49C2810425243710` |
+| MetaVaultFactory | `0x6107dB0bdd84023228E0aB11099190E88B073c1D` |
+| OsToken | `0xF490c80aAE5f2616d3e3BDa2483E30C4CB21d1A0` |
+| OsTokenConfig | `0xd6672fbE1D28877db598DC0ac2559A15745FC3ec` |
+| OsTokenFlashLoans | `0xe84183EfFbcc76D022Cccc31b95EAa332bB5Bb11` |
+| OsTokenRedeemer | `0xdF3123dD182b8d3e0266a2dC37eEb8366d149B5A` |
+| OsTokenVaultController | `0x60B2053d7f2a0bBa70fe6CDd88FB47b579B9179a` |
+| OsTokenVaultEscrow | `0x28F325dD287a5984B754d34CfCA38af3A8429e71` |
+| PriceFeed | `0x9B1b13afA6a57e54C03AD0428a4766C39707D272` |
+| PrivErc20VaultFactory | `0x1831834dC4Bf88B9d9183015e1285B105Ec2FdC9` |
+| PrivVaultFactory | `0x4C958642F1CD735F13aed02A4FB015153edDf8Fd` |
+| RewardSplitterFactory | `0xd12Df8543e0522CCbF12d231e822B7264c634775` |
+| SharedMevEscrow | `0x30db0d10d3774e78f8cB214b9e8B72D4B402488a` |
+| ValidatorsChecker | `0x3b629aF425277FfD7cEB841a24e75d34F868651C` |
+| VaultFactory | `0x7A8cbBf690084E43De778173cfAcf7313c9122DD` |
+| VaultsRegistry | `0x7d014B3C6ee446563d4e0cB6fBD8C3D0419867cB` |

docs/contracts/networks/Hoodi.mdx

@@ -0,0 +1,41 @@
+---
+title: Hoodi
+sidebar_position: 3
+---
+
+# Hoodi
+
+:::custom-info[Block Explorer]
+View contracts on [Hoodi Etherscan ↗](https://hoodi.etherscan.io)
+:::
+
+| Contract Name | Address |
+|---------------|---------|
+| BalancedCurator | `0xD30E7e4bDbd396cfBe72Ad2f4856769C54eA6b0b` |
+| BlocklistErc20VaultFactory | `0x39c6eef5f955bcC280966504bc5c82F2394Fa368` |
+| BlocklistVaultFactory | `0x608d8Ca6916b96edf63Dd429e62Fe1366ae6f3B5` |
+| ConsolidationsChecker | `0x033E5BaE5bdc459CBb7d388b41a9d62020Be810F` |
+| CuratorsRegistry | `0xa23F7c8d25f4503cA4cEd84d9CC2428e8745933C` |
+| DepositDataRegistry | `0x93a3f880E07B27dacA6Ef2d3C23E77DBd6294487` |
+| Erc20VaultFactory | `0x97795DA27138BD8d79204D37F3A2e80fA4d30488` |
+| FoxVault | `0xE96aC18cFE5A7AF8FE1FE7Bc37FF110d88bc67fF` |
+| GenesisVault | `0xba447498DC4c169f2b4f427B2c4D532320457E89` |
+| Keeper | `0xA7D1Ac9D6F32B404C75626874BA56f7654c1dC0f` |
+| LegacyPoolEscrow | `0x291Fa5849215847081B475450cBE5De46CfD4fAE` |
+| LegacyRewardToken | `0x75c57bd50A3EB7291Da3429956D3566E0153A38f` |
+| MerkleDistributor | `0xc61847D6Fc1F64162fF9F1d06205D9c4cDb2f239` |
+| MetaVaultFactory | `0x6107dB0bdd84023228E0aB11099190E88B073c1D` |
+| OsToken | `0x7345fC8268459413beE9e9dd327f31283C65Ee7e` |
+| OsTokenConfig | `0x5b817621EBE00622b9a71b53c942b392751c8197` |
+| OsTokenFlashLoans | `0xCd5F3C1BA0342e1de907eEE09aeC52183ef5D99e` |
+| OsTokenRedeemer | `0xdF3123dD182b8d3e0266a2dC37eEb8366d149B5A` |
+| OsTokenVaultController | `0x140Fc69Eabd77fFF91d9852B612B2323256f7Ac1` |
+| OsTokenVaultEscrow | `0xdC1347cC04d4a8945b98A09C3c5585286bbA5C2B` |
+| PriceFeed | `0xe8a222D887b468a71Ee8a27df4fa3b886A4B7BA1` |
+| PrivErc20VaultFactory | `0x1831834dC4Bf88B9d9183015e1285B105Ec2FdC9` |
+| PrivVaultFactory | `0x4C958642F1CD735F13aed02A4FB015153edDf8Fd` |
+| RewardSplitterFactory | `0xd12Df8543e0522CCbF12d231e822B7264c634775` |
+| SharedMevEscrow | `0x51FD45BAEfB12f54766B5C4d639b360Ea50063bd` |
+| ValidatorsChecker | `0x3b629aF425277FfD7cEB841a24e75d34F868651C` |
+| VaultFactory | `0x7A8cbBf690084E43De778173cfAcf7313c9122DD` |
+| VaultsRegistry | `0xf16fea93D3253A401C3f73B0De890C6586740B25` |