From 8aeb5d97d8e4f86cb6ce7ab2e85ffa23965c1196 Mon Sep 17 00:00:00 2001 From: James Bayly Date: Fri, 23 Feb 2024 14:35:40 +0800 Subject: [PATCH] Rename Kepler to mainnet --- docs/build/graph-migration.md | 4 +-- docs/miscellaneous/vulnerability-reporting.md | 2 +- docs/subquery_network/community.md | 4 +-- .../consumers/introduction.md | 6 ---- .../subquery_network/delegators/delegating.md | 30 +++++++------------ docs/subquery_network/delegators/rewards.md | 2 +- .../introduction/reward-distribution.md | 2 +- .../node_operators/indexers/index-project.md | 6 +--- .../node_operators/setup/security-guide.md | 4 +-- docs/subquery_network/publish.md | 6 ++++ docs/subquery_network/token/claim.md | 2 +- docs/subquery_network/token/swap.md | 22 ++++---------- 12 files changed, 33 insertions(+), 57 deletions(-) diff --git a/docs/build/graph-migration.md b/docs/build/graph-migration.md index 069f83817d2..1acf0f987a5 100644 --- a/docs/build/graph-migration.md +++ b/docs/build/graph-migration.md @@ -9,7 +9,7 @@ SubQuery provides a superior developer experience to The Graph, while maintainin - **Multi-chain indexing support** - SubQuery allows you to index data from across different layer-1 networks into the same database, this allows you to query a single endpoint to get data for all supported networks. [Read more](../build/multi-chain.md). - **More control** - A large library of [command line parameters](../run_publish/references.md) to all you to run, monitor, and optimise your locally hosted project - **Managed Service hosting** - We have no plans to sunset our [Managed Service](https://managedservice.subquery.network), which provides enterprise-level infrastructure hosting and handles over hundreds of millions of requests each day -- **A decentralised network supporting all chains** - Our [decentralised network](https://kepler.subquery.network) supports all chains that SubQuery support, there is no _second-class_ chain support in the SubQuery ecosystem +- **A decentralised network supporting all chains** - Our [decentralised network](https://app.subquery.network) supports all chains that SubQuery support, there is no _second-class_ chain support in the SubQuery ecosystem ![Competitor Comparison](/assets/img/build/competitor_comparison.jpg) @@ -308,7 +308,7 @@ export async function handleNewGravatar(log: NewGravatarLog): Promise { } export async function handleUpdatedGravatar( - log: UpdatedGravatarLog, + log: UpdatedGravatarLog ): Promise { const id: string = log.args.id.toHexString()!; let gravatar = await Gravatar.get(id); diff --git a/docs/miscellaneous/vulnerability-reporting.md b/docs/miscellaneous/vulnerability-reporting.md index 16fc83f5c76..3772e0e43cc 100644 --- a/docs/miscellaneous/vulnerability-reporting.md +++ b/docs/miscellaneous/vulnerability-reporting.md @@ -6,7 +6,7 @@ SubQuery welcomes security vulnerability reports from the public, and we do pay While we welcome reports for any vulnerability or issue, our standard practice is to only reward responsibly reported vulnerabilities that are found with a [CVSS score](https://en.wikipedia.org/wiki/Common_Vulnerability_Scoring_System) of 4.5 or higher. -At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Managed Service](https://managedservice.subquery.network/) and [Decentralised Network](https://kepler.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a cusomer's codebase we will: +At a high level, all services under the `subquery.network` and `subquery.foundation` domains are in scope for reporting. However, we run SubQuery project code on behalf of customers in our [Managed Service](https://managedservice.subquery.network/) and [Decentralised Network](https://app.subquery.network/) (e.g. a customer provides us executable SubQuery project code), so in the case where a reported issue is from a cusomer's codebase we will: - Contact you to let you know that the vulnerability has been determined to exist in the customer's codebase, and to give you a chance to directly contact our customer via their own vulnerability/bug submission processes. - If no response has been received after 72 hours from you, we will automatically pass knowledge of this vulnerability to the relevant customer (with correct attribution to you). diff --git a/docs/subquery_network/community.md b/docs/subquery_network/community.md index e42d5897081..b4019df8965 100644 --- a/docs/subquery_network/community.md +++ b/docs/subquery_network/community.md @@ -4,11 +4,11 @@ The key focus of the [SubQuery Foundation](./foundation.md) and community is to ## Connecting with others -Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Kepler Network will want to join `#kepler-general`, and Indexers or Delegators should join `#kepler-indexer-chat` or `#kepler-delegator-chat` respectively. +Discord is our main community for talking about SubQuery and learning more. You can join with [this link here](https://discord.com/invite/subquery). People most interested in the SubQuery Network will want to join `#network-general`, and Indexers or Delegators should join `#network-indexer-chat` or `#network-delegator-chat` respectively. ## Post on our Forum -When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Kepler, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! +When the conversation is deeper and requires more thought, we move the conversation to [our Forum](https://forum.subquery.network/). Here you will find longer topics, a history of all announcements to Network, and deeper conversation about the direction of the network. Feel free to join and start posting at [forum.subquery.network](https://forum.subquery.network/)! ## Contributing to Codebases diff --git a/docs/subquery_network/consumers/introduction.md b/docs/subquery_network/consumers/introduction.md index 2334d2efdad..70c1aae7f8d 100644 --- a/docs/subquery_network/consumers/introduction.md +++ b/docs/subquery_network/consumers/introduction.md @@ -1,11 +1,5 @@ # Introduction to Consumers -:::info - -The SubQuery Kepler Network does not yet have the Consumer role. Consumers will launch with the SubQuery Mainnet. - -::: - ## What is a Consumer? A Consumer is a participant in the SubQuery Network and is either an individual or organisation that pays for processed and organised blockchain data and/or RPC queries from the SubQuery Network. Consumers effectively make requests to the SubQuery Network for specific data or the ability to submit transactions to RPC providers and pay an agreed amount of SQT in return. diff --git a/docs/subquery_network/delegators/delegating.md b/docs/subquery_network/delegators/delegating.md index 625ed42ffec..4394b3380a0 100644 --- a/docs/subquery_network/delegators/delegating.md +++ b/docs/subquery_network/delegators/delegating.md @@ -1,48 +1,40 @@ # Delegating to a Node Operator -:::info Kepler - -In Kepler, you can only delegate to Indexers. When mainnet launches we will rename this section to Node Operators - -::: - -## How to delegate to an Indexer +## How to delegate to an Node Operator
-After you have [selected what indexer to delegate to](./rewards.md#how-to-select-what-node-operators-to-delegate-to), navigate to `Delegator` -> `Indexers`(on the left sidebar). Then select `Delegate` in the last column next to your desired Indexer. - +After you have [selected what Node Operator to delegate to](./rewards.md#how-to-select-what-node-operators-to-delegate-to), navigate to `Delegator` -> `Node Operators`(on the left sidebar). Then select `Delegate` in the last column next to your desired Node Operator. -::: warning +::: warning Ensure you have ether for gas fees. Ether needs to be on the Base network. More information can be found [here](../token/claim.html#how-to-obtain-ether-on-base) ::: - -![Delegate Indexer List](/assets/img/network/delegate_indexers.png) +![Delegate Node Operator List](/assets/img/network/delegate_indexers.png) Select your source for the delegation (it can be your wallet, or from an existing delegation amount) and enter an amount. Click on `Delegate`. You will be asked to confirm your transaction with Metamask. Please wait for a while after confirming the transaction. -![Delegate to an Indexer part 2](/assets/img/network/delegate_action.png) +![Delegate to an Node Operator part 2](/assets/img/network/delegate_action.png) -Note that some Indexers cannot be delegated to, until they collect all the early era's rewards. You will have to contact the Indexer to resolve the issue. +Note that some Node Operators cannot be delegated to, until they collect all the early era's rewards. You will have to contact the Node Operator to resolve the issue. ![Cannot delegate](/assets/img/network/delegate_cannot.png) -## How to undelegate from an Indexer +## How to undelegate from an Node Operator ::: info You can redelegate without waiting for the unlocking period -If you want to switch your delegation from one indexer to another, you can avoid the undelegation lock period by instead redelegating. When you initially delegate to an Indexer, you can instead select another Indexer's delegation as the source of funds to redelegate. +If you want to switch your delegation from one Node Operator to another, you can avoid the undelegation lock period by instead redelegating. When you initially delegate to an Node Operator, you can instead select another Node Operator's delegation as the source of funds to redelegate. ::: -To undelegate from an Indexer, navigate to `Delegator` -> `Delegating`. +To undelegate from an Node Operator, navigate to `Delegator` -> `Delegating`. -![Undelegate from an Indexer](/assets/img/network/delegate_status.png) +![Undelegate from an Node Operator](/assets/img/network/delegate_status.png) Click on `Undelegate` and enter the amount of SQT you want to undelegate. Then click `Confirm Undelegation`. You will be asked to confirm your transaction with Metamask. Confirm it and wait for a few seconds. @@ -52,6 +44,6 @@ You can notice the change in the Delegation Amount under the `Your DELEGATION AM ## How to withdraw undelegated tokens -When you undelegate from an Indexer, the tokens are locked for a specific period before they can be withdrawn. You can see pending unlocks and execute withdrawls in the `My profile` -> `Withdrawls`. When the tokens are unlocked, the `Withdraw` button will be available. Alternatively you can cancel the withdrawl here and redelegate your tokens. +When you undelegate from an Node Operator, the tokens are locked for a specific period before they can be withdrawn. You can see pending unlocks and execute withdrawls in the `My profile` -> `Withdrawls`. When the tokens are unlocked, the `Withdraw` button will be available. Alternatively you can cancel the withdrawl here and redelegate your tokens. ![Withdraw delegated tokens](/assets/img/network/profile_withdrawls.png) diff --git a/docs/subquery_network/delegators/rewards.md b/docs/subquery_network/delegators/rewards.md index b49d9d3f05e..523de74aa65 100644 --- a/docs/subquery_network/delegators/rewards.md +++ b/docs/subquery_network/delegators/rewards.md @@ -28,7 +28,7 @@ For example, Node Operator A has set an NOCR of 80% and has received SQT from 8 Note that Delegators must have delegated their tokens for the entire [Era](../introduction/era.md) to be eligible for these rewards (note [Non-reward period](#non-reward-period)). -For Data Indexers, we've made it easier for you to see other data about all Data Indexers in our app. Navigate to `Delegator` > `Indexers` and view the [leaderboard](https://kepler.subquery.network/delegator/node_operators/indexers/top) which shows various scores and details that we think are important to you when deciding what Data Indexer to choose. The Data Indexers Score takes into account an Data Indexer’s uptime, slashing events, and other parameters. +For Data Indexers, we've made it easier for you to see other data about all Data Indexers in our app. Navigate to `Delegator` > `Indexers` and view the [leaderboard](https://app.subquery.network/delegator/node_operators/indexers/top) which shows various scores and details that we think are important to you when deciding what Data Indexer to choose. The Data Indexers Score takes into account an Data Indexer’s uptime, slashing events, and other parameters. ## Non-reward period diff --git a/docs/subquery_network/introduction/reward-distribution.md b/docs/subquery_network/introduction/reward-distribution.md index 72914147c3b..3724ec3cc6f 100644 --- a/docs/subquery_network/introduction/reward-distribution.md +++ b/docs/subquery_network/introduction/reward-distribution.md @@ -19,7 +19,7 @@ There is a reward pool for each deployments Node Operator runs where the adjustm ## Network Inflation Rewards -Some projects in our network are considered “Public Good” projects, for example; network dictionaries and the various SubQuery projects that the [official Network app](https://kepler.subquery.network) runs on. In these cases, we need to ensure Node Operators will run and host them, but generally there will be no single customer that will take the lead in financing these requests +Some projects in our network are considered “Public Good” projects, for example; network dictionaries and the various SubQuery projects that the [official Network app](https://app.subquery.network) runs on. In these cases, we need to ensure Node Operators will run and host them, but generally there will be no single customer that will take the lead in financing these requests Additionally, for Node Operators, running projects incurs significant costs. Without clear demand, Node Operators might not want to risk the time and resources to setup a new project. diff --git a/docs/subquery_network/node_operators/indexers/index-project.md b/docs/subquery_network/node_operators/indexers/index-project.md index 8b1eab898fd..2f4ec8e9b4d 100644 --- a/docs/subquery_network/node_operators/indexers/index-project.md +++ b/docs/subquery_network/node_operators/indexers/index-project.md @@ -2,11 +2,7 @@ ## Introduction -To become a SubQuery Indexer, you need to stake a minimum of 1000 SQT. - -::: info Note -Only Indexers that have been airdropped kSQT will be able to join Kepler as an indexer. In the future, we may invite more indexers into the network. -::: +To become a SubQuery Indexer, you need to stake a minimum of 200,000 SQT. ## 1. Initial Set-Up diff --git a/docs/subquery_network/node_operators/setup/security-guide.md b/docs/subquery_network/node_operators/setup/security-guide.md index af1a5f0baec..f6beaae4723 100644 --- a/docs/subquery_network/node_operators/setup/security-guide.md +++ b/docs/subquery_network/node_operators/setup/security-guide.md @@ -113,7 +113,7 @@ sudo apt install -y nginx ```shell # docker-compose.yml proxy: - image: subquerynetwork/indexer-proxy:v1.3.9 + image: subquerynetwork/indexer-proxy:v2.0.0 container_name: indexer_proxy restart: always ports: @@ -125,7 +125,7 @@ proxy: - --jwt-secret=<...> - --secret-key=<...> - --service-url=http://indexer_coordinator:8000 - - --network=kepler # network type, need to be same with coordinator + - --network=mainnet # network type, need to be same with coordinator - --network-endpoint=https://polygon-rpc.com - --token-duration=24 # query auth token validity [hours] - --redis-endpoint=redis://indexer_cache diff --git a/docs/subquery_network/publish.md b/docs/subquery_network/publish.md index 7f2fd3a5c41..1b9186cd90d 100644 --- a/docs/subquery_network/publish.md +++ b/docs/subquery_network/publish.md @@ -1,5 +1,11 @@ # Publishing your Project to the SubQuery Network +:::warning + +This guide is outdated as we have now moved to the mainnet. We will update it shortly with instructions on how anyone can submit a new project deployment to the SubQuery network. + +::: + We're building the most open, performant, reliable, and scalable data service for dApp developers. The SubQuery Network indexes and services data to the global community in an incentivised and verifiable way. After publishing your project to the SubQuery Network, anyone can index and host it - providing data to users around the world faster and reliably. The final phase before launching the SubQuery Network is deploying the Kepler Network. You can think of Kepler as a pre-mainnet, a controlled phase that will help us bootstrap the mainnet with participants and activity. diff --git a/docs/subquery_network/token/claim.md b/docs/subquery_network/token/claim.md index 808ab0c03e9..f82d87077e7 100644 --- a/docs/subquery_network/token/claim.md +++ b/docs/subquery_network/token/claim.md @@ -21,7 +21,7 @@ If claiming your public sale tokens, you must use the same wallet address you pa Select the appropriate account and then click next. You may have to approve to switch the network connection to the Base network. -The SubQuery Token Claim claim page should load up showing any token allocation that you have permission to claim. Note that the balance may show 0 prior to TGE. Once the tokens have been generated and allocated on the token generation date, the balance should reflect your correct amount. +The SubQuery Token Claim claim page should load up showing any token allocation that you have permission to claim. Once the tokens have been generated and allocated on the token generation date, the balance should reflect your correct amount. ![claim page](/assets/img/network/claim_page_tokens.png) diff --git a/docs/subquery_network/token/swap.md b/docs/subquery_network/token/swap.md index 85a174f911c..5195f325751 100644 --- a/docs/subquery_network/token/swap.md +++ b/docs/subquery_network/token/swap.md @@ -1,24 +1,12 @@ # 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 SQT. +Swaps allows users to swap kSQT to SQT at a fixed rate of 1:1.83. 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. ## How to Swap -:::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 +There are three steps for swapping kSQT to SQT and then being able to use it on the network, you can carry these actions out on the old [Kepler app](https://kepler.subquery.network/swapksqt). 1. Ensure that all remaining kSQT is unlocked and swappable 2. Swap kSQT to SQT on Polygon @@ -29,7 +17,7 @@ There are three steps for swapping kSQT to SQT and then being able to use it on ### 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. +To unlock your kSQT tokens for swapping, navigate to the `Swap` page on the old [Kepler app](https://kepler.subquery.network/swapksqt). 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) @@ -38,7 +26,7 @@ To unlock your kSQT tokens for swapping, navigate to the `Swap` page on the old ### 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. +To swap your kSQT tokens for SQT, navigate to the `Swap` page on the old [Kepler app](https://kepler.subquery.network/swapksqt). 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. @@ -61,6 +49,6 @@ Follow the guide on how to bridge your SQT from Ethereum Mainnet to Base [here]( :::info -If you need any help, you can reach out on the `#kepler-swap-support` channel in our Discord. +If you need any help, you can reach out on the `#sqt-swap-support` channel in our Discord. :::