Skip to content

Commit

Permalink
Add Bridge Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesbayly committed Feb 23, 2024
1 parent fa419d4 commit d20e7da
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 11 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/.vuepress/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -486,6 +486,7 @@ export const getSidebar = (locale: string) =>
children: [
`${locale}/subquery_network/token/token.md`,
`${locale}/subquery_network/token/tokenomics.md`,
`${locale}/subquery_network/token/bridge.md`,
`${locale}/subquery_network/token/swap.md`,
`${locale}/subquery_network/token/claim.md`,
],
Expand Down
2 changes: 1 addition & 1 deletion docs/run_publish/other_tools/metabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The installation steps are thoroughly documented, ensuring a seamless configurat

![](/assets/img/run_publish/metabase/metabase-database-connection.png)

If you are running your indexer project [locally](./run.md) through Docker, all the requisite information can be found in the `docker-compose.yml` file. When you provide the correct credentials, Metabase will attempt to establish a connection. It will only proceed if the connection is successful. This connection allows Metabase to access the indexed blockchain data, enabling robust analysis and visualisation capabilities.
If you are running your indexer project [locally](../run.md) through Docker, all the requisite information can be found in the `docker-compose.yml` file. When you provide the correct credentials, Metabase will attempt to establish a connection. It will only proceed if the connection is successful. This connection allows Metabase to access the indexed blockchain data, enabling robust analysis and visualisation capabilities.

## Browse Data

Expand Down
2 changes: 2 additions & 0 deletions docs/subquery_network/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Contracts for SubQuery Network.

<https://github.com/subquery/network-contracts>

You can find smart contract addresses for all network contracts here in [GitHub](https://github.com/subquery/network-contracts/blob/develop/publish/mainnet.json)

### `network-app-backend`

SubQuery project for the backend of the SubQuery App.
Expand Down
6 changes: 3 additions & 3 deletions docs/subquery_network/introduction/kepler.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The rationale is that we can demonstrate both the technical and commercial appli

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).
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 were able to swap kSQT to USDC using the Swap feature.

### Adding kSQT to your Wallet

Expand All @@ -36,6 +36,6 @@ You can add it to your wallet from the wallet selector in the [Kepler App](https

### 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).
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.

Upon the retirement of Kepler, all kSQT can be burnt in exchange for SQT after SubQuery Network launch.
Upon the retirement of Kepler, all kSQT can be burnt in exchange for SQT after SubQuery Network launch using our [swap mechanism](../token/swap.md).
11 changes: 11 additions & 0 deletions docs/subquery_network/token/bridge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Bridging Tokens to Base

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.

SubQuery provides an offical Bridge UI on our [offical Network App](https://app.subquery.network/bridge) that supports bridging from Eth -> Base (will will later add support for Base -> Eth). This allows you to bridge any free SQT from Ethereum to Base and is built using the same contracts and messaging protocols as the official [Base Bridge](https://bridge.base.org/deposit).

![Offical Bridge UI](/assets/img/network/bridge.jpg)

## Other Bridges

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.
2 changes: 1 addition & 1 deletion docs/subquery_network/token/swap.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Once you have added SQT to the Polygon Bridge, you are free to bridge over your

### 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).
Follow the guide on how to bridge your SQT from Ethereum Mainnet to Base [here](./bridge.md).

:::info

Expand Down
6 changes: 0 additions & 6 deletions docs/subquery_network/token/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,6 @@ You can add it to your wallet from the wallet selector in the [Network App](http

![Add SQT to Wallet](/assets/img/network/kSQT_add_wallet.png)

## Bridging Tokens to Base

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.

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.

## KSQT

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).

0 comments on commit d20e7da

Please sign in to comment.