-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Tangle DApp usage guides: bridging, liquid staking, and restaking (…
…#65) * Fix typos, add screenshots * Add more steps for joining & creating pools * Adjust to new changes made by Drew * Improve phrasing * Fix dead links * Finish pool creation & joining guide * Add first drafts for restake and bridge pages * Optimize images, improve text * Progress on bridge docs * Phrasing Co-authored-by: drewstone <[email protected]> * Cleanup bridge page * Add restaking deposit DApp steps * Reorganize `How to Restake` structure * Improve `Resources` * Add restaking delegate steps * Create unstake page * Improve withdraw PolkadotJS page * Add restake withdraw steps * Format using Prettier * Fix links * Remove redundant LST intro * Minor improvements * Remove bridge fees section * DApp capitalization --------- Co-authored-by: drewstone <[email protected]>
- Loading branch information
1 parent
af29694
commit dffecf0
Showing
117 changed files
with
670 additions
and
370 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 18 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,9 @@ | ||
| # Supported Assets on Tangle Restaking | ||
|
|
||
| ## Supported Assets | ||
|
|
||
| Supported assets include all "liquid" assets on Tangle Network, including liquid staked TNT tokens. The network does not limit or restrict the assets that can be used for restaking. But assets are | ||
| preferred by adding them to a reward pool. | ||
| Supported assets include all "liquid" assets on Tangle network, including liquid staked TNT tokens. The network does not limit or restrict the assets that can be used for restaking, but assets are preferred by adding them to a reward pool. | ||
|
|
||
| ## Integrate New Assets | ||
|
|
||
| New assets may be added through on-chain governance and TNT community approval. | ||
|
|
||
| To discuss new assets, you can [discuss at our forum.](https://commonwealth.im/tangle/discussions) | ||
| To propose new assets, [join the community discussion](https://commonwealth.im/tangle/discussions). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| import Callout from "/components/Callout"; | ||
|
|
||
| # Bridge | ||
|
|
||
| In order to participate in Tangle's restaking infrastructure, users need to first bridge in their assets from connected networks such as Ethereum. For this, we have a dedicated bridge DApp that allows users to easily bring their assets to Tangle and transfer them out. | ||
|
|
||
| [Access Tangle DApp's Bridge page here](https://app.tangle.tools/bridge) | ||
|
|
||
| ## Supported Assets | ||
|
|
||
| As of the time of writing of this page, the bridge only supports WETH for testnet transfers between Holesky and Tangle. | ||
|
|
||
| Soon, users will be able to create and deploy a Hyperlane Warp Route blueprint instance to support additional assets. [Learn more about Blueprints here](/developers/blueprints). | ||
|
|
||
| More information about adding support for additional assets will be provided in the near future. For now, make sure you've joined our Discord server & Telegram channel to stay updated. | ||
|
|
||
| ## How the Bridge Works | ||
|
|
||
| Bridging from EVM-based blockchains into Tangle EVM works by leveraging Hyperlane, a permissionless interoperability layer that allows smart contract developers to send arbitrary data between blockchains. [Learn more about Hyperlane here](https://docs.hyperlane.xyz/docs/protocol/protocol-overview). | ||
|
|
||
| ## How to Use the Bridge | ||
|
|
||
| ### Step 1: Access Tangle DApp & Connect Wallet | ||
|
|
||
| - Open [Tangle DApp's Bridge page](https://app.tangle.tools/bridge). | ||
| - Connect your wallet to the DApp by clicking on the **Connect Wallet** button on the top right and selecting your preferred wallet provider. | ||
|
|
||
| ### Step 2: Select the Source & Destination Networks | ||
|
|
||
| In this example, we'll be bridging in WETH from Holesky to Tangle Testnet EVM. Select the source network as Holesky and the destination network as Tangle Testnet EVM. | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Fill in Details | ||
|
|
||
| - Enter the amount of WETH you'd like to bridge in. | ||
| - Enter the recipient address. This is the address on Tangle where the bridged assets will be deposited. If transferring into Tangle EVM (like in this example), this should be an EVM address. | ||
|
|
||
| <Callout type="default"> | ||
| Ensure that the recipient address entered is correct to avoid losing your funds. We recommend sending a small amount first to get comfortable with the process. | ||
| </Callout> | ||
|
|
||
| - Click on the **Transfer** button. | ||
|
|
||
| ### Step 4: Perform the Transaction | ||
|
|
||
| - After clicking on the **Transfer** button, a confirmation dialog will appear. Review the details & fees, and click on the **Confirm** button to initiate the transaction. | ||
| - After a few seconds, the transaction dialog from your wallet provider (such as MetaMask) will appear. The bridging process consists of two transations: one to approve the bridge contract to spend your WETH, and the other to interact with the bridge contract. Review all details and confirm the first transaction to continue. | ||
|
|
||
|  | ||
|
|
||
| - After the first transaction is confirmed, a second transaction confirmation dialog will automatically appear. This is the transaction used to interact with the bridge smart contract. Review all details and confirm the transaction to complete the bridging process. | ||
|
|
||
|  | ||
|
|
||
| ### Step 5: Monitor Transaction Progress | ||
|
|
||
| - Once the second transaction is confirmed, you can monitor the progress of the bridging process right from the DApp. A small toast notification will automatically appear on the top right of the screen with the transaction details. | ||
| - Once you see the **Executed** status, the bridging process is complete. You can also use the [Tangle Testnet's EVM explorer](https://testnet-explorer.tangle.tools/) to find and track the transaction. Check the [Resources and Tools page](/resources) for other explorers. | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| { | ||
| "pool-roles": "Pool Roles", | ||
| "benefits-and-risks": "Benefits and Risks", | ||
| "lst-pool-create": "Create using PolkadotJs", | ||
| "lst-pool-create-tangle": "Create using Tangle DApp" | ||
| "lst-pool-create-tangle": "Create using Tangle DApp", | ||
| "lst-pool-create": "Create using PolkadotJS" | ||
| } |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,29 @@ | ||
| ## How to Create a Liquid Staking Pool Using Tangle DApp | ||
|
|
||
| TBD | ||
| ### Step 1: Access Tangle DApp & Connect Wallet | ||
|
|
||
| - Open [Tangle DApp's Liquid Staking page](https://app.tangle.tools/liquid-staking). | ||
| - Connect your wallet to the DApp by clicking on the **Connect Wallet** button on the top right and selecting your preferred wallet provider. | ||
| - Connect to the desired Tangle network by selecting the appropriate network from the dropdown list. Note that liquid staking pools are only available on the networks in which they are created. | ||
|
|
||
|  | ||
|
|
||
| ### Step 2: Configure & Create a Pool | ||
|
|
||
| - Once on the liquid staking page, scroll down until you see the **CREATE POOL** button. Click on it to bring up a form where you can configure your new pool. | ||
|
|
||
|  | ||
|
|
||
| - Choose a brief, descriptive name for your pool so that other users can easily identify it, enter an initial bond amount, and set the pool's roles (Root, Nominator, Bouncer). | ||
| - By default, all of the roles will be assigned to the active wallet's address. You can change these addresses to other accounts if needed. | ||
| - Some details such as the pool's commission and nominations can be set **after** the pool is created: You'll be able to easily manage it under the **My Pools** tab. | ||
| - Once you've entered and verified all the details, click on the **Create Pool** button to initiate the transaction. | ||
|
|
||
|  | ||
|
|
||
| ### Step 3: Manage Your Pool | ||
|
|
||
| - After you've created your pool, you can view & manage it under the **My Pools** tab. Here, you can set the commission rate, manage nominations, and view the pool's performance. In case that you don't see the pool you've just created right away, try refreshing the page. | ||
| - Note that the `MANAGE` button or some of its dropdown options will only be visible **if the active account has the corresponding role**. For example, only the account with the nominator role will be able to see the `Update Nominations` button on the dropdown. If you've set all roles to the same account, you will have all the management options available. | ||
|
|
||
|  |
Oops, something went wrong.