Skip to content

Commit b1b914a

Browse files
SipherSipher
authored
Fast bridge doc (#42)
* Add 404.mdx with custom error page and navigation to aid users in finding relevant content and support options * Add nginx configuration for serving static files with gzip and security headers, and copy config into Docker image * Add a GIF to the 404 page, update messaging for better user guidance, and improve support feedback options * Update how-to guides and add Fast Bridge documentation; enhance navigation in table of contents for easier access to resources * Fix link formatting in the table of contents, ensuring consistency and better navigation in how-to guides for users
1 parent 4bd4e41 commit b1b914a

File tree

6 files changed

+331
-2
lines changed

6 files changed

+331
-2
lines changed

‎astro.config.mjs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,9 +100,10 @@ export default defineConfig({
100100
collapsed: true,
101101
items: [
102102
{ label: "Setup a Wallet", slug: "how-to-guides/holders/setup-a-wallet" },
103-
{ label: "Bridge from Base", slug: "how-to-guides/holders/bridge-from-base" },
103+
{ label: "Fast Bridge", slug: "how-to-guides/holders/fast-bridge" },
104104
{ label: "Stake your Torus", slug: "how-to-guides/holders/stake-your-torus" },
105105
{ label: "Vote on Proposals", slug: "how-to-guides/holders/vote-on-proposals" },
106+
{ label: "Standard Bridge", slug: "how-to-guides/holders/standard-bridge" },
106107
],
107108
},
108109
{

‎public/images/how-to-guide/simple-bridge/bridge-mecannisms.png‎

406 KB
Loading

‎public/images/how-to-guide/simple-bridge/connect-both-wallets.png‎

271 KB
Loading

‎src/content/docs/how-to-guides/holders/fast-bridge.mdx‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
title: Fast Bridge
3+
description: Bridging from TORUS Base all the way to Native TORUS on the Network.
4+
---
5+
6+
import {
7+
Steps,
8+
Aside,
9+
CardGrid,
10+
Card
11+
} from "@astrojs/starlight/components";
12+
import ClickableImage from '/src/components/ClickableImage.astro';
13+
import RedText from '/src/components/RedText.astro';
14+
import connectBothWallets from '/public/images/how-to-guide/simple-bridge/connect-both-wallets.png';
15+
import bridgeMechanisms from '/public/images/how-to-guide/simple-bridge/bridge-mecannisms.png';
16+
17+
In this guide, we'll **bridge TORUS between Torus and Base** using the Fast Bridge method.
18+
This process is necessary in order to obtain **Native TORUS**, which is required to interact with Torus directly.
19+
This process also works to bridge from **Native TORUS** to **Base TORUS**.
20+
21+
The Fast Bridge streamlines the bridging process by automating the intermediate steps, completing in minutes rather than requiring manual multi-step transactions.
22+
23+
#### Why bridge TORUS tokens?
24+
25+
You need Native TORUS to participate in Torus - it's required for registering agents, becoming a Root Agent, staking, governance voting, and all on-chain activities. Bridging converts your Base TORUS into the native format.
26+
27+
To keep things clear and concise, **Native TORUS** will be referred to as **TORUS** from this point forward.
28+
29+
#### What we will accomplish
30+
31+
- Bridge TORUS from Base to TORUS in one streamlined process
32+
- Bridge TORUS from Torus back to Base (bidirectional support)
33+
34+
<Aside>
35+
⏱️ **Estimated time to complete this guide: 4 minutes**
36+
</Aside>
37+
38+
---
39+
40+
## Prerequisites
41+
42+
<CardGrid>
43+
<Card title="Torus Wallet" icon="seti:license">
44+
A Torus wallet connected.
45+
If you don't have one, you can follow the [setup guide here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/).
46+
</Card>
47+
48+
<Card title="Base TORUS Wallet" icon="seti:config">
49+
For this guide, we will be using [MetaMask](https://metamask.io/) as our wallet of choice.
50+
You must have enough funds to cover the bridge fees.
51+
{/* If you don't have Base TORUS or funds to cover the fees, you can follow the steps in this video tutorial by Omni Labs. */}
52+
</Card>
53+
</CardGrid>
54+
55+
---
56+
57+
<Aside type="danger">
58+
Avoid storing BASE TORUS in SubWallet, as it will cause issues with the bridge that could result in loss of funds.
59+
</Aside>
60+
61+
62+
63+
## Steps for the Bridge Process
64+
65+
<Steps>
66+
67+
1. **Connect both the Torus and MetaMask wallets in the [Fast Bridge Web App](https://bridge.torus.network/?tab=simple&from=base&to=torus)**.
68+
At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**.
69+
<ClickableImage src={connectBothWallets} alt="Connect both wallets" />
70+
71+
2. **Swap from Base TORUS to TORUS**
72+
- Make sure you are **connected** to **both wallets**
73+
- Make sure it is <RedText variant="light">FROM</RedText> **Base TORUS** <RedText variant="light">TO</RedText> **TORUS**
74+
75+
Fill in the amount you want to convert, then click **Submit Base to Torus transaction**.
76+
77+
<ClickableImage src={bridgeMechanisms} alt="Bridge mechanisms interface" />
78+
79+
3. **Add Torus EVM network to MetaMask**
80+
The bridge will automatically prompt MetaMask to switch to the Torus EVM network for the second transaction. If this is your first time, you may need to approve adding this network.
81+
82+
<Aside type="note" title="Manual network setup">
83+
If the automatic network switch fails, manually add Torus EVM to MetaMask:
84+
85+
**Torus EVM Network Configuration:**
86+
- **Network Name**: Torus EVM
87+
- **Default RPC URL**: https://api.torus.network
88+
*(Alternate: https://api-hyperlane.nodes.torus.network)*
89+
- **Chain ID**: 21000
90+
- **Currency Symbol**: TORUS
91+
- **Block Explorer**: https://blockscout.torus.network
92+
93+
Follow [MetaMask's guide to add custom networks](https://support.metamask.io/networks-and-sidechains/managing-networks/how-to-add-a-custom-network-rpc/) using the configuration above.
94+
</Aside>
95+
96+
4. **Sign both transactions in MetaMask**
97+
You will need to approve two transactions - one on Base and one on Torus EVM. The second step is automated by the bridge, but requires your signature to complete.
98+
99+
<Aside type="caution">
100+
Always verify transaction details before signing. Ensure you have enough funds in your MetaMask wallet to cover both transaction fees.
101+
</Aside>
102+
103+
5. **Confirmation of the swap**
104+
After the transactions succeed, your Base TORUS should now be displayed as TORUS.
105+
This process can take a while to complete on the blockchain,
106+
so <RedText variant="light">please wait a few minutes and **don't** refresh the page.</RedText>
107+
108+
You should now have TORUS on Torus.
109+
110+
</Steps>
111+
112+
<Aside type="caution">
113+
**If the process fails mid-transaction:**
114+
115+
If your funds get stuck in the TORUS EVM layer, you can complete the bridging process using the [Standard Bridge](https://docs.torus.network/how-to-guides/holders/standard-bridge/) to transfer from TORUS EVM to TORUS.
116+
</Aside>
117+
118+
---
119+
120+
## Bridging from TORUS to Base TORUS
121+
122+
The process to bridge from TORUS back to Base TORUS is nearly identical. Simply follow the same steps above, but swap the direction:
123+
124+
- In **Step 2**, make sure it is <RedText variant="light">FROM</RedText> **TORUS** <RedText variant="light">TO</RedText> **Base TORUS**
125+
- Click **Submit Torus to Base transaction** instead
126+
127+
Everything else remains the same - you'll still need to approve adding the Torus EVM network (if not already added) and sign both transactions in MetaMask. The bridge handles the rest automatically.
128+
129+
---
130+
131+
132+
133+
## What's Next?
134+
135+
Now that you have TORUS tokens, you can:
136+
137+
- **Start earning rewards**: [Stake your TORUS](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) to support agents and earn emissions
138+
- **Become an agent**: [Register an agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) to provide services and earn directly
139+
- **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://portal.torus.network/)
140+
- **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/explanations/holders/tokenomics/) and emission mechanisms
141+
142+
Connect with the community:
143+
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
144+
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
145+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news

‎src/content/docs/how-to-guides/holders/standard-bridge.mdx‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
---
2+
title: Bridge TORUS from Base to Torus
3+
description: Bridging from TORUS Base all the way to Native TORUS on the Network.
4+
---
5+
6+
import {
7+
Steps,
8+
Aside,
9+
CardGrid,
10+
Card
11+
} from "@astrojs/starlight/components";
12+
import ClickableImage from '/src/components/ClickableImage.astro';
13+
import RedText from '/src/components/RedText.astro';
14+
import metamaskSubwalletConnect from '/public/images/how-to-guide/bridge-to-base/metamask-subwallet-connect.png';
15+
import fillInFormToConvert from '/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert.png';
16+
import confirmTransactionInMetamask from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask.png';
17+
import baseTorusSwappedSuccessfully from '/public/images/how-to-guide/bridge-to-base/base-torus-swapped-successfully.png';
18+
import metamaskConnectEvm from '/public/images/how-to-guide/bridge-to-base/metamask-connect-evm.png';
19+
import fillInFormToConvertTorusEvmNativeTorus from '/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert-torus-evm-native-torus.png';
20+
import confirmTransactionInMetamaskTorusEvmToTorus from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask-torus-evm-to-torus.png';
21+
import torusEvmConvertSuccessfully from '/public/images/how-to-guide/bridge-to-base/torus-evm-convert-successfully.png';
22+
import connectedToTorusEvm from '/public/images/how-to-guide/bridge-to-base/connected-to-torus-evm.png';
23+
24+
In this guide, we'll **bridge TORUS between Torus and Base**.
25+
This process is necessary in order to obtain **Native TORUS**, which is required to interact with Torus directly.
26+
27+
#### Why bridge TORUS tokens?
28+
29+
You need Native TORUS to participate in Torus - it's required for registering agents, becoming a Root Agent, staking, governance voting, and all on-chain activities. Bridging converts your Base TORUS into the native format.
30+
31+
To keep things clear and concise, **Native TORUS** will be referred to as **TORUS** from this point forward.
32+
33+
#### What we will accomplish
34+
35+
- Bridge TORUS on Base to TORUS EVM
36+
- Bridge from TORUS EVM to TORUS
37+
38+
<Aside>
39+
⏱️ **Estimated time to complete this guide: 20 minutes**
40+
</Aside>
41+
42+
<Aside type="caution">
43+
**Most users should use the [Fast Bridge](https://docs.torus.network/how-to-guides/holders/fast-bridge/) instead.**
44+
45+
The Standard Bridge is a multi-step process that requires bridging through the TORUS EVM layer. Only use this method if you understand why you need it or if your funds are already stuck in the TORUS EVM layer and need to be recovered.
46+
</Aside>
47+
48+
---
49+
50+
## Prerequisites
51+
52+
<CardGrid>
53+
<Card title="Torus Wallet" icon="seti:license">
54+
A Torus wallet connected.
55+
If you don't have one, you can follow the [setup guide here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/).
56+
</Card>
57+
58+
<Card title="Base TORUS Wallet" icon="seti:config">
59+
For this guide, we will be using [MetaMask](https://metamask.io/) as our wallet of choice.
60+
You must have enough funds to cover the bridge fees.
61+
{/* If you don't have Base TORUS or funds to cover the fees, you can follow the steps in this video tutorial by Omni Labs. */}
62+
</Card>
63+
</CardGrid>
64+
65+
---
66+
67+
<Aside type="danger">
68+
Avoid storing BASE TORUS in SubWallet, as it will cause issues with the bridge that could result in loss of funds.
69+
</Aside>
70+
71+
72+
73+
## Steps for the Bridge Process
74+
75+
### Bridge BASE Torus to Torus EVM
76+
77+
<Steps>
78+
79+
1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**.
80+
At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**.
81+
<ClickableImage src={metamaskSubwalletConnect} alt="SubWallet and MetaMask connect screen" />
82+
83+
2. **Swap from Base TORUS to Torus EVM**
84+
- Make sure you are **connected** to **both wallets**
85+
- Make sure you are on the <RedText variant="light">**correct tab**</RedText>, <RedText variant="light">**TORUS EVM - Base**</RedText>
86+
- Make sure it is <RedText variant="light">FROM</RedText> **Base TORUS** <RedText variant="light">TO</RedText> **Torus EVM**
87+
88+
Fill in the form with the amount you want to convert and the Recipient Address, by clicking on the <RedText variant="light">Self button</RedText>, it will automatically fill the address for you with your connected base wallet.
89+
With all the information filled in, click **Continue**.
90+
91+
<ClickableImage src={fillInFormToConvert} alt="Convert Base TORUS with Torus EVM" />
92+
93+
3. **Confirm the transaction**
94+
After filling in the form, you will be prompted to confirm the transaction in Metamask.
95+
<Aside type="caution">
96+
Always verify the transaction in MetaMask before signing it, as it is your responsibility to verify the transaction details.
97+
You also must have enough funds in your MetaMask wallet to cover the transaction fees.
98+
</Aside>
99+
<ClickableImage src={confirmTransactionInMetamask} alt="Confirm the transaction in MetaMask" />
100+
101+
4. **Confirmation of the swap**
102+
After the transaction succeeds, your Base TORUS should now be displayed as Torus EVM as it was successfully swapped.
103+
This process can take a while to complete on the blockchain,
104+
so <RedText variant="light">please wait a few minutes and refresh the page.</RedText>
105+
<ClickableImage src={baseTorusSwappedSuccessfully} alt="Confirmation of the swap" />
106+
107+
108+
</Steps>
109+
110+
---
111+
112+
### Bridge Torus EVM to Torus
113+
114+
<Steps>
115+
1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**.
116+
At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**.
117+
<ClickableImage src={metamaskConnectEvm} alt="SubWallet and MetaMask connect screen" />
118+
119+
120+
2. **Verify you're connected to Torus EVM**
121+
Make sure MetaMask is connected to the Torus EVM network. You should see "Torus EVM" in your MetaMask network dropdown.
122+
123+
<ClickableImage src={connectedToTorusEvm} alt="MetaMask connected to Torus EVM" />
124+
125+
<Aside type="note" title="Do not see Torus EVM?">
126+
**If MetaMask shows a different network or the Bridge doesn't automatically switch to Torus EVM**, you may need to manually add the network to your MetaMask wallet first.
127+
128+
**Torus EVM Network Configuration:**
129+
- **Network Name**: Torus EVM
130+
- **Default RPC URL**: https://api.torus.network
131+
*(Alternate: https://api-hyperlane.nodes.torus.network)*
132+
- **Chain ID**: 21000
133+
- **Currency Symbol**: TORUS
134+
- **Block Explorer**: https://blockscout.torus.network
135+
136+
**MetaMask Setup:** Follow [MetaMask's guide to add custom networks](https://support.metamask.io/networks-and-sidechains/managing-networks/how-to-add-a-custom-network-rpc/) using the configuration above, then return to the Bridge and retry your transaction.
137+
138+
The Bridge will attempt to add this network automatically, but manual setup ensures a smooth experience if the auto-switch fails.
139+
</Aside>
140+
141+
3. **Swap from Torus EVM to Torus**
142+
- Make sure you are **connected** in **Both Wallets**
143+
- Make sure you are in the <RedText variant="light">**correct Tab**</RedText>, <RedText variant="light">**TORUS EVM - Base**</RedText>
144+
- Make sure it is <RedText variant="light">FROM</RedText>**Torus EVM** <RedText variant="light">TO</RedText> **Torus**
145+
146+
Fill in the form with the amount you want to convert, after confirmation, you will be prompted to sign the transaction in Torus.
147+
<ClickableImage src={fillInFormToConvertTorusEvmNativeTorus} alt="Convert Torus EVM to Native TORUS" />
148+
149+
4. **Confirm the transaction**
150+
After filling in the form, you will be prompted to confirm the transaction in Metamask.
151+
<Aside type="caution">
152+
Always verify the transaction in MetaMask before signing it, as it is your responsibility to verify the transaction details.
153+
You also must have enough funds in your MetaMask wallet to cover the transaction fees.
154+
</Aside>
155+
156+
<ClickableImage src={confirmTransactionInMetamaskTorusEvmToTorus} alt="Confirm the transaction in MetaMask" />
157+
158+
5. **Confirmation of the swap**
159+
After the transaction succeeds, your Torus EVM should now be displayed as TORUS as it was successfully swapped.
160+
This process can take a while to complete on the blockchain,
161+
so <RedText variant="light">please wait a few minutes and refresh the page.</RedText>
162+
<ClickableImage src={torusEvmConvertSuccessfully} alt="Confirmation of the swap" />
163+
164+
4. **All Done**
165+
You've now successfully bridged TORUS tokens between **Torus**, **Torus EVM**, and **Base**.
166+
You can view your updated balances directly in the [Torus Web App](https://wallet.torus.network) or SubWallet.
167+
</Steps>
168+
169+
170+
## What's Next?
171+
172+
Now that you have TORUS tokens, you can:
173+
174+
- **Start earning rewards**: [Stake your TORUS](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) to support agents and earn emissions
175+
- **Become an agent**: [Register an agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) to provide services and earn directly
176+
- **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://portal.torus.network/)
177+
- **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/explanations/holders/tokenomics/) and emission mechanisms
178+
179+
Connect with the community:
180+
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
181+
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
182+
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news

‎src/content/docs/how-to-guides/table-of-contents.mdx‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,10 @@ If you're managing permissions and system-level coordination:
3737
If you want to interact with Torus as an end-user or holder:
3838

3939
- [Set up a Wallet](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/) — Configure SubWallet to connect to Torus network
40-
- [Bridge from Base](https://docs.torus.network/how-to-guides/holders/bridge-from-base/) — Transfer TORUS tokens from Base network to Torus
40+
- [Fast Bridge](https://docs.torus.network/how-to-guides/holders/fast-bridge/) — Transfer TORUS tokens from Base to Torus quickly with fewer steps
4141
- [Stake your TORUS](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) — Delegate tokens to agents and participate in network rewards
4242
- [Vote on Proposals](https://docs.torus.network/how-to-guides/holders/vote-on-proposals/) — Participate in governance decisions and proposal voting
43+
- [Standard Bridge](https://docs.torus.network/how-to-guides/holders/standard-bridge/) — Transfer TORUS tokens from Base to Torus using the traditional multi-step process
4344

4445
---
4546

0 commit comments

Comments
 (0)