Mainnet (#478)

* Start work on Mainnet Docs * Bridge * Corret links * SQT token * Polygon bridge docs * Tidy bridging
subquery · Feb 21, 2024 · fa419d4 · fa419d4
1 parent 86096ae
commit fa419d4
Show file tree

Hide file tree

Showing 10 changed files with 108 additions and 40 deletions.
diff --git a/docs/.vuepress/public/assets/img/network/bridge_polygon_token_1.png b/docs/.vuepress/public/assets/img/network/bridge_polygon_token_1.png
diff --git a/docs/.vuepress/public/assets/img/network/bridge_polygon_token_2.png b/docs/.vuepress/public/assets/img/network/bridge_polygon_token_2.png
diff --git a/docs/.vuepress/public/assets/img/network/swap.png b/docs/.vuepress/public/assets/img/network/swap.png
diff --git a/docs/.vuepress/public/assets/img/network/swap_confirm.png b/docs/.vuepress/public/assets/img/network/swap_confirm.png
diff --git a/docs/subquery_network/community.md b/docs/subquery_network/community.md
@@ -101,6 +101,7 @@ Links
 ### Kepler Network Dashboard (by DappLooker)
 
 To monitor the progress and performance of the Kepler Network, DappLooker has created a dashboard that displays the following key metrics:
+
 - Active Indexers / Delegators: The number of Indexers and Delegators who are actively participating in the Kepler Network.
 - Weekly Indexer Stake / Delegation: The amount of kSQT that Indexers and Delegators have staked on the Kepler Network in the past week.
 - Weekly Rewards: The amount of kSQT that Indexers have earned as rewards for serving data requests on the Kepler Network in the past week.

diff --git a/docs/subquery_network/introduction/introduction.md b/docs/subquery_network/introduction/introduction.md
@@ -27,23 +27,3 @@ There’s a role for everyone in the network, from highly technical developers t
 **Delegators** will participate in the Network by supporting their favourite Node Operators to earn rewards based on the work those Node Operators do. Learn more about [Delegators](../delegators/introduction.md).
 
 ![Token economic flow](/assets/img/network/token_economy.png)
-
-## SubQuery Kepler Network
-
-SubQuery’s mission is to help developers create the decentralised products of the future. In order to realise this, we are focused on the release of the [decentralised SubQuery Network](https://subquery.network/network). The final phase before launching the SubQuery Network was deploying the Kepler Network.
-
-:::note
-
-[View the SubQuery Kepler network now](https://kepler.subquery.network)
-
-:::
-
-### Why Did We Launching Kepler?
-
-You can think of Kepler as a pre-mainnet, a controlled phase that helped us bootstrap the mainnet with participants and activity.
-
-In order to launch our decentralised network (The SubQuery Network), there are several technical milestones that must be met. The first significant milestone was achieved in 2022, with three successful ‘seasons’ (or phases) of our Frontier testnet which stress-tested the network in a test environment. After taking these learnings, we elected to take a novel approach by allowing participants in our testnet to get started on real world projects now via Kepler rather than waiting for the launching of our token.
-
-A further consideration is that when we survey the web3 ecosystem today, we see that many other projects that provide decentralised services have made poor progress migrating customers from their centralised services to their decentralised alternatives. Kepler is designed to migrate real projects from our managed service to the decentralised SubQuery Kepler Network in a carefully choreographed way whilst providing incentives to all.
-
-The rationale is that we can demonstrate both the technical and commercial applications of the SubQuery Network and bootstrap the mainnet with participants and activity to accelerate our growth.
diff --git a/docs/subquery_network/introduction/kepler.md b/docs/subquery_network/introduction/kepler.md
@@ -0,0 +1,41 @@
+## SubQuery Kepler Network
+
+SubQuery’s mission is to help developers create the decentralised products of the future. In order to realise this, the final phase before launching the SubQuery Network was deploying the Kepler Network.
+
+:::note
+
+SubQuery Kepler is now retired, all previous members can swap their KSQT for SQT via the official [Kepler Swap Mechanism](../token/swap.md).
+
+:::
+
+### Why Did We Launch Kepler?
+
+You can think of Kepler as a pre-mainnet, a controlled phase that helped us bootstrap the mainnet with participants and activity.
+
+In order to launch our decentralised network (The SubQuery Network), there are several technical milestones that must be met. The first significant milestone was achieved in 2022, with three successful ‘seasons’ (or phases) of our Frontier testnet which stress-tested the network in a test environment. After taking these learnings, we elected to take a novel approach by allowing participants in our testnet to get started on real world projects now via Kepler rather than waiting for the launching of our token.
+
+A further consideration is that when we survey the web3 ecosystem today, we see that many other projects that provide decentralised services have made poor progress migrating customers from their centralised services to their decentralised alternatives. Kepler is designed to migrate real projects from our managed service to the decentralised SubQuery Kepler Network in a carefully choreographed way whilst providing incentives to all.
+
+The rationale is that we can demonstrate both the technical and commercial applications of the SubQuery Network and bootstrap the mainnet with participants and activity to accelerate our growth.
+
+## KSQT
+
+kSQT is the name of the token that is used by participants who operate within the Kepler Network. This token mimics the properties of the eventual SubQuery Network token (SQT) in that tokens will be rewarded to Node Operators for performing tasks and Delegators can allocate their tokens to Node Operators to secure the network and receive rewards.
+
+Kepler is designed to enable participants to provide value to real projects which are migrated from SubQuery’s managed service to the decentralised offering and receive incentives via the Kepler token (kSQT). The kSQT token is issued with a very limited supply, but users can swap kSQT to USDC using our [Swap feature](./swap.md).
+
+### Adding kSQT to your Wallet
+
+kSQT is deployed on the Polygon network with the following contract address:
+
+`0xcEE50Ee839a2ab3914cF4c3cbAc78f6F11E0c937` ([PolygonScan](https://polygonscan.com/address/0xcEE50Ee839a2ab3914cF4c3cbAc78f6F11E0c937)).
+
+You can add it to your wallet from the wallet selector in the [Kepler App](https://kepler.subquery.network/explorer).
+
+![Add kSQT to Wallet](/assets/img/network/kSQT_add_wallet.png)
+
+### How do I Receive kSQT?
+
+The supply of kSQT is intentionally heavily restricted and has been airdropped to Node Operators and Ambassadors to help launch the network and show our appreciation for their support. For users that did not receive an airdrop, kSQT can be swapped using our [Swap feature](./swap.md).
+
+Upon the retirement of Kepler, all kSQT can be burnt in exchange for SQT after SubQuery Network launch.
diff --git a/docs/subquery_network/node_operators/indexers/indexer-security-guide.md b/docs/subquery_network/node_operators/indexers/indexer-security-guide.md
@@ -37,7 +37,7 @@ sudo wget -O /usr/local/bin/ufw-docker https://github.com/chaifeng/ufw-docker/ra
 sudo chmod +x /usr/local/bin/ufw-docker
 ```
 
-Then using the following command to modify the ` after.rules`` file of  `ufw``
+Then using the following command to modify the `after.rules`` file of `ufw``
 
 ```bash
 ufw-docker install
@@ -54,9 +54,11 @@ Expose the port 8000 allow Only My IP (change 192.168.10.1 to your IP Address):
 ```bash
 ufw route allow proto tcp from 192.168.10.1 to 172.18.0.28 port 8000 comment 'allow indexer_coordinator 8000/tcp indexer_services'
 ```
+
 :::tip Tip
 
-You can find IPAddress Mapping ex `172.18.0.10`, `172.18.0.28` with 
+You can find IPAddress Mapping ex `172.18.0.10`, `172.18.0.28` with
+
 ```
 docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' <container_id_or_name>
 ```

diff --git a/docs/subquery_network/token/swap.md b/docs/subquery_network/token/swap.md
@@ -1,18 +1,63 @@
-# Swap kSQT for USDC
+# Swap kSQT for SQT
 
 :::warning
 
 Now that the SubQuery Mainet have been announced, we have disabled swaps of USDC.e -> kSQT and kSQT -> USDC.e. After SubQuery's TGE on the 23rd of February we will allow direct swaps of kSQT for SQT at a premium rate (1:1.83) when the network launches.
 
 :::
 
-Swaps allows users to swap kSQT to USDC.
+Swaps allows users to swap kSQT to SQT.
 
 While kSQT will not have transfer restrictions, we do not envision it as a free-float token, hence will not provide or support liquidity. kSQT will have a controlled supply that is intended to be just enough for the minimum viable network running with limited capabilities.
 
-SubQuery will offer a basic swap mechanism for kSQT rewards (but not the airdrop itself). You will be able to use this swap mechanism to convert rewards earned via indexing and delegation into USDC at a predetermined rate. The swap contract will be seeded with just enough USDC to purchase all reward emissions over the lifetime of Kepler. This is done with the sole purpose of reimbursing infrastructure costs incurred by the Node Operators, hopefully at a profit - this exercise will allow us to calibrate reward emissions in conditions close to the real market.
+## How to Swap
 
-The reward tokens acquired by the swap contract become available for release to potential delegators, who wish to get hold of kSQT and participate in the Kepler Network. The swap contract will also have a spread between the acquiring and releasing rates discouraging idle swapping and speculation.
+:::warning
+
+kSQT -> SQT Swap will only be open from when the mainnet launches, expected to be around 8am Friday 23rd February UTC.
+
+:::
+
+There are three steps for swapping kSQT to SQT and then being able to use it on the network
+
+1. Ensure that all remaining kSQT is unlocked and swappable
+2. Swap kSQT to SQT on Polygon
+3. Bridge SQT from Polygon to Ethereum
+4. Bridge SQT from Ethereum to Base
+
+![Swap UI](/assets/img/network/swap.png)
+
+### 1. Unlock Remaining kSQT
+
+To unlock your kSQT tokens for swapping, navigate to the `Swap` page on the old [Kepler app](https://kepler.subquery.network). On the left side of the swap page, you can see any remaining kSQT that you have locked in the app. This includes unclaimed rewards, delegation, staking, and pending withdrawls. Please make sure there is no remaining kSQT in each section by following in the associated instructions.
+
+- [Claim kSQT Rewards](../node_operators/rewards.md#claiming-rewards-by-eras)
+- [Undelegate kSQT](../delegators/delegating.md#how-to-undelegate-from-an-indexer)
+- [Unstake kSQT](../node_operators/rewards.md#staking)
+- [Complete kSQT Withdrawls](../delegators/delegating.md#how-to-withdraw-undelegated-tokens)
+
+### 2. Swap kSQT to SQT
+
+To swap your kSQT tokens for SQT, navigate to the `Swap` page on the old [Kepler app](https://kepler.subquery.network). Then on the right slide, enter an amount of kSQT that you want to swap, and click `Swap` - we recommend inputting the maximum amount.
+
+After this step, you will now have kSQT on Polygon - the contract address of SQT on Polygon is [`0xc52F0f8361835B53A18408BB44d7f4136f0EF69D`](https://polygonscan.com/token/0xc52F0f8361835B53A18408BB44d7f4136f0EF69D#balances) - you might need to add it to your wallet as a custom token.
+
+### 3. Bridge SQT from Polygon to Ethereum
+
+We recommend using official bridges like [Polygon Portal](https://portal.polygon.technology/bridge). SubQuery can't be responsible for the use of any third party bridges.
+
+You will want to brige from `Polygon POS`, not `Polygon zkEVM` - the token address for SQT on Polygon POS is [`0xc52F0f8361835B53A18408BB44d7f4136f0EF69D`](https://polygonscan.com/token/0xc52F0f8361835B53A18408BB44d7f4136f0EF69D#balances).
+
+In the [Polygon Portal bridge](https://portal.polygon.technology/bridge), when selecting tokens, you can click `+ Add Token` and then enter the SubQuery Token Address on Polygon `0xc52F0f8361835B53A18408BB44d7f4136f0EF69D`
+
+![Add custom token to Polygon Bridge](/assets/img/network/bridge_polygon_token_1.png)
+![Add custom token to Polygon Bridge](/assets/img/network/bridge_polygon_token_2.png)
+
+Once you have added SQT to the Polygon Bridge, you are free to bridge over your SQT to Ethereum from Polygon.
+
+### 4. Bridge SQT from Ethereum to Base
+
+Follow the guide on how to bridge your SQT from Ethereum Mainnet to Base [here](./token.md#bridging-tokens-to-base).
 
 :::info
 

diff --git a/docs/subquery_network/token/token.md b/docs/subquery_network/token/token.md
@@ -1,6 +1,6 @@
-# The SubQuery Tokens (SQT and kSQT)
+# The SubQuery Token (SQT)
 
-The SubQuery Network is powered by the SubQuery Token (SQT). Kepler has it's own token for the Kepler network with its own supply and contract address, please read more about it there under [kSQT](#ksqt).
+The SubQuery Network is powered by the SubQuery Token (SQT).
 
 The SubQuery Token (SQT) is designed as a utility token that powers the SubQuery Network, providing an incentive for participation, as well as serving as a medium of exchange for transactions within the SubQuery Network. Consumers of data will commit SQT in exchange for RPC queries from RPC Providers or indexed data from Data Indexers and this SQT will be distributed among Node Operators based on the payment method selected.
 
@@ -10,24 +10,23 @@ There is no intention for SQT to be used as a medium of exchange for goods or se
 
 ![Token economic flow](/assets/img/network/token_economy.png)
 
-## KSQT
-
-kSQT is the name of the token that is used by participants who operate within the Kepler Network. This token mimics the properties of the eventual SubQuery Network token (SQT) in that tokens will be rewarded to Node Operators for performing tasks and Delegators can allocate their tokens to Node Operators to secure the network and receive rewards.
+## Adding SQT to your Wallet
 
-Kepler is designed to enable participants to provide value to real projects which are migrated from SubQuery’s managed service to the decentralised offering and receive incentives via the Kepler token (kSQT). The kSQT token is issued with a very limited supply, but users can swap kSQT to USDC using our [Swap feature](./swap.md).
+SQT is an ERC20 token deployed on the Ethereum mainnet, and is commonly bridged over to Base. It has the following contract addresses:
 
-### Adding kSQT to your Wallet
+- [Ethereum mainnet](https://etherscan.io/token/0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85): `0x09395a2A58DB45db0da254c7EAa5AC469D8bDc85`
+- [Base](https://basescan.org/token/0x858c50C3AF1913b0E849aFDB74617388a1a5340d): `0x858c50C3AF1913b0E849aFDB74617388a1a5340d`
 
-kSQT is deployed on the Polygon network with the following contract address:
+You can add it to your wallet from the wallet selector in the [Network App](https://app.subquery.network/explorer).
 
-`0xcEE50Ee839a2ab3914cF4c3cbAc78f6F11E0c937` ([PolygonScan](https://polygonscan.com/address/0xcEE50Ee839a2ab3914cF4c3cbAc78f6F11E0c937)).
+![Add SQT to Wallet](/assets/img/network/kSQT_add_wallet.png)
 
-You can add it to your wallet from the wallet selector in the [Kepler App](https://kepler.subquery.network/explorer).
+## Bridging Tokens to Base
 
-![Add kSQT to Wallet](/assets/img/network/kSQT_add_wallet.png)
+Although SQT is an ERC20 token minted on Ethereum Mainnet, the SubQuery Network operates on the Base Network. You will need to bridge your tokens between these networks, thankfully this is quite straightforward.
 
-### How do I Receive kSQT?
+The official bridge, [Base Bridge](https://bridge.base.org/deposit), does not yet support SubQuery and there are other [quicker third-party bridges](https://base.org/ecosystem?tag=bridge), for example [superbridge.app](https://superbridge.app/), SubQuery can't be responsible for the use of any third party bridges.
 
-The supply of kSQT is intentionally heavily restricted and has been airdropped to Node Operators and Ambassadors to help launch the network and show our appreciation for their support. For users that did not receive an airdrop, kSQT can be swapped using our [Swap feature](./swap.md).
+## KSQT
 
-Upon the retirement of Kepler, all kSQT can be burnt in exchange for SQT after SubQuery Network launch.
+kSQT was the name of our pre-mainnet token, it is now retired, all holders can swap their kSQT for SQT via the official [Kepler Swap Mechanism](./swap.md).