Skip to content

Commit 04cf364

Browse files
authored
Merge pull request #16 from renlabs-dev/dev
Moved how to guides to the top and added a start here file to guide users
2 parents 6c289d2 + 1650157 commit 04cf364

File tree

13 files changed

+427
-103
lines changed

13 files changed

+427
-103
lines changed

astro.config.mjs

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,24 @@ export default defineConfig({
2626
label: "Getting Started",
2727
items: [
2828
{ label: "Introduction", slug: "index" },
29+
{ label: "Tokenomics", slug: "concepts/tokenomics" },
2930
{
3031
label: "Concepts & Terminology",
3132
slug: "getting-started/concepts",
3233
},
33-
{ label: "Setup CLI", slug: "getting-started/setup-cli" },
34-
{ label: "Setup Wallet", slug: "getting-started/setup-wallet" },
34+
],
35+
},
36+
{
37+
label: "How-to Guides",
38+
items: [
39+
{ label: "Start Here", slug: "how-to-guides/start-here" },
40+
{ label: "Setup a Wallet", slug: "how-to-guides/setup-a-wallet" },
41+
{ label: "Bridge to Base", slug: "how-to-guides/bridge-to-base"},
42+
{ label: "Stake your Torus", slug: "how-to-guides/stake-your-torus" },
43+
{ label: "Register an Agent", slug: "how-to-guides/register-an-agent" },
44+
{ label: "Become a Root Agent", slug: "how-to-guides/become-a-root-agent" },
45+
{ label: "Edit your Agent", slug: "how-to-guides/edit-your-agent" },
46+
{ label: "Setup CLI", slug: "how-to-guides/setup-cli" },
3547
],
3648
},
3749
{
@@ -45,7 +57,6 @@ export default defineConfig({
4557
slug: "v05/capability-permissions",
4658
},
4759
{ label: "Emission Permissions", slug: "v05/emission-permissions" },
48-
{ label: "Tokenomics", slug: "concepts/tokenomics" },
4960
{ label: "Governance & DAO", slug: "concepts/governance-dao" },
5061
],
5162
},
@@ -99,20 +110,6 @@ export default defineConfig({
99110
},
100111
],
101112
},
102-
{
103-
label: "How-to Guides",
104-
items: [
105-
{ label: "Setup a Wallet", slug: "how-to-guides/setup-a-wallet" },
106-
{ label: "Bridge to Base", slug: "how-to-guides/bridge-to-base"},
107-
{ label: "Stake your Torus", slug: "how-to-guides/stake-your-torus" },
108-
{ label: "Register an Agent", slug: "how-to-guides/register-an-agent" },
109-
{ label: "Become a Root Agent", slug: "how-to-guides/become-a-root-agent" },
110-
// {
111-
// label: "Setup a wallet",
112-
// slug: "how-to-guides/setup-a-wallet",
113-
// },
114-
],
115-
},
116113
],
117114
customCss: ["./src/tailwind.css"],
118115
}),
192 KB
Loading
199 KB
Loading
574 KB
Loading

src/content/docs/agents/server-setup.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The AgentServer uses **Hono** for HTTP routing and **Zod** for input validation,
2323
- **Namespace Permissions**: Blockchain-based access control
2424
- **OpenAPI Documentation**: Automatic API documentation generation
2525
- **Type Safety**: Full TypeScript support with Zod schemas
26-
- **Blockchain Integration**: Direct connection to Torus Network
26+
- **Blockchain Integration**: Direct connection to Torus
2727

2828
## Installation
2929

@@ -180,7 +180,7 @@ const agent = new AgentServer({
180180

181181
## Namespace Permissions
182182

183-
The AgentServer integrates with Torus Network's capability permission system for fine-grained access control.
183+
The AgentServer integrates with Torus capability permission system for fine-grained access control.
184184

185185
### Basic Namespace Protection
186186

src/content/docs/how-to-guides/become-a-root-agent.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ import daoShapeTheNetwork from '/public/images/how-to-guide/become-a-root-agent/
1414
import selectTheWhitelistOption from '/public/images/how-to-guide/become-a-root-agent/select-the-whitelist-option.png';
1515

1616

17-
In this guide, well walk through how to **apply to become a Root Agent** on the Torus Network.
17+
In this guide, we'll walk through how to **apply to become a Root Agent** on Torus.
1818
This is a step-by-step overview of the application process.
1919

2020
Becoming a Root Agent allows you to receive emissions directly from the root and play a central role in the network's permission and delegation structure.
2121

2222
<Aside>
2323
- Applying does **not guarantee approval** — all applications are subject to DAO review.
24-
- You dont need to be a Root Agent to actively participate in the Torus Network.
24+
- You don't need to be a Root Agent to actively participate in Torus.
2525
- Registered agents can create permissions, capabilities, signals, and more.
2626
The main difference is that only Root Agents can receive emissions directly from the root.
2727
- If you're looking to participate, start by following the [Register an Agent guide](https://docs.torus.network/how-to-guides/register-an-agent/).
@@ -44,7 +44,7 @@ Becoming a Root Agent allows you to receive emissions directly from the root and
4444
</Card>
4545
<Card title="Torus Balance" icon="seti:shell">
4646
Check your balance on the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees.
47-
You can find a [guide on how to bridge Torus here](https://docs.torus.network/how-to-guides/bridge-to-base/).
47+
You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/bridge-to-base/).
4848
</Card>
4949
<Card title="Discord Account" icon="discord">
5050
Have a valid Discord account and join the official [Torus Discord
@@ -63,14 +63,14 @@ Becoming a Root Agent allows you to receive emissions directly from the root and
6363
2. **Connect your Torus Wallet**
6464
Click the **Connect Wallet** button at the top right and select your Torus wallet.
6565

66-
3. **Click in Shape the Network Button**
67-
It can be found in the top right corner of the dashboard.
66+
3. **Click on Shape the Network Button**
67+
It is located in the top right corner of the dashboard.
6868
It will open a modal with a form to apply for whitelisting.
6969
<ClickableImage src={daoShapeTheNetwork} alt="Shape the network button" />
7070

7171
4. **Select the Whitelist an Agent option and fill the form**
72-
In modal, select the option **Whitelist an Agent** and fill in the required fields for your application.
73-
In this step you must validate your **Discord Account** in order to apply.
72+
In the modal, select the option **Whitelist an Agent** and fill in the required fields for your application.
73+
In this step, you must validate your **Discord Account** in order to apply.
7474
<Aside>
7575
Your Discord account is used solely to validate your application via OAuth.
7676
We do **not** collect or store your password, and we **never** have access to your Discord credentials.
@@ -82,24 +82,24 @@ Becoming a Root Agent allows you to receive emissions directly from the root and
8282
<ClickableImage src={selectTheWhitelistOption} alt="Select whitelist option" />
8383

8484
5. **Submit Proposal**
85-
Click in **Submit Proposal** and confirm the transaction in your wallet after you filled in the form.
85+
After filling in the form, click **Submit Proposal** and confirm the transaction in your wallet.
8686
<Aside>
87-
The proposal cost (**100 Torus**) will be deducted from your connected wallet.
87+
The proposal cost (**100 TORUS**) will be deducted from your connected wallet.
8888

8989
- If your application is **accepted**, the fee will be refunded.
9090
- If your application is **rejected**, the fee will be **burned permanently** and cannot be recovered.
9191
</Aside>
9292

9393

9494
6. **All Done**
95-
Youve now successfully Applited to Whitelist an Agent on Torus.
95+
You've now successfully Applied to Whitelist an Agent on Torus.
9696
Now you must wait for DAO members to review your application.
9797
You can follow the process through the [Whitelist DAO Page](https://dao.torus.network/whitelist-applications)
9898
</Steps>
9999

100100

101101
## Support and Resources
102-
If you want to understand more about the core differences between a Registered agent and a Whitelisted agent, you can relate to the [Concepts & Terminology](https://docs.torus.network/getting-started/concepts/) section.
102+
If you want to understand more about the core differences between a Registered agent and a Whitelisted agent, you can refer to the [Concepts & Terminology](https://docs.torus.network/getting-started/concepts/) section.
103103
You can also get help directly from the community via:
104104

105105
- [Torus Community Discord](https://discord.gg/torus)

src/content/docs/how-to-guides/bridge-to-base.mdx

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Bridge Torus from Base to Torus
3-
description: Bridging from Torus Base all the way to Native Torus on the Torus Network.
3+
description: Bridging from Torus Base all the way to Native TORUS on the Network.
44
---
55

66
import {
@@ -19,23 +19,25 @@ import fillInFormToConvertTorusEvmNativeTorus from '/public/images/how-to-guide/
1919
import confirmTransactionInMetamaskTorusEvmToTorus from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask-torus-evm-to-torus.png';
2020
import torusEvmConvertSuccessfully from '/public/images/how-to-guide/bridge-to-base/torus-evm-convert-successfully.png';
2121

22-
In this guide, well **bridge Torus between the Torus Network and Base**.
23-
This process is necessary in order to obtain **Native Torus**, which is required to interact with the Torus Network directly.
22+
In this guide, we'll **bridge TORUS between Torus and Base**.
23+
This process is necessary in order to obtain **Native TORUS**, which is required to interact with Torus directly.
2424

25-
**Native Torus** is used for essential on-chain actions, such as:
25+
**Native TORUS** is used for essential on-chain actions, such as:
2626

2727
- Registering an Agent
2828
- Becoming a Root Agent
2929
- Creating a permission
3030
- Creating a signal
3131
- And more...
3232

33-
For the sake of simplicity, we are going to refer to the **Native Torus** as **Torus**.
33+
To keep things clear and concise, **Native TORUS** will be referred to as **TORUS** from this point forward.
34+
35+
3436

3537
#### What we will accomplish
3638

37-
- Bridge Torus on Base to Torus EVM
38-
- Bridge from Torus EVM to Torus
39+
- Bridge TORUS on Base to TORUS EVM
40+
- Bridge from TORUS EVM to TORUS
3941

4042
<Aside>
4143
⏱️ **Estimated time to complete this guide: 20 minutes**
@@ -51,17 +53,17 @@ For the sake of simplicity, we are going to refer to the **Native Torus** as **T
5153
If you don't have one, you can follow the [setup guide here](https://docs.torus.network/how-to-guides/setup-a-wallet/).
5254
</Card>
5355

54-
<Card title="Base Torus Wallet" icon="seti:config">
55-
For this guide, we will be using [Metamask](https://metamask.io/) as our wallet of choice.
56+
<Card title="Base TORUS Wallet" icon="seti:config">
57+
For this guide, we will be using [MetaMask](https://metamask.io/) as our wallet of choice.
5658
You must have enough funds to cover the bridge fees.
57-
{/* 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. */}
59+
{/* 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. */}
5860
</Card>
5961
</CardGrid>
6062

6163
---
6264

6365
<Aside type="danger">
64-
Avoid using SubWallet to have BASE Torus on it, as it will cause issues with the bridge that could result in loss of funds.
66+
Avoid storing BASE TORUS in SubWallet, as it will cause issues with the bridge that could result in loss of funds.
6567
</Aside>
6668

6769
## Steps for the Bridge Process
@@ -70,14 +72,14 @@ For the sake of simplicity, we are going to refer to the **Native Torus** as **T
7072

7173
<Steps>
7274

73-
1. **Connect both the Torus and Metamask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**.
75+
1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**.
7476
At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**.
75-
<ClickableImage src={metamaskSubwalletConnect} alt="SubWallet and Metamask connect screen" />
77+
<ClickableImage src={metamaskSubwalletConnect} alt="SubWallet and MetaMask connect screen" />
7678

77-
2. **Swap from Base Torus to Torus EVM**
78-
- Make sure you are **connected** in **Both Wallets**
79-
- Make sure you are in the **correct Tab**, **TORUS EVM - Base**
80-
- Make sure it is **FROM** Base Torus **TO** Torus EVM
79+
2. **Swap from Base TORUS to Torus EVM**
80+
- Make sure you are **connected** to **both wallets**
81+
- Make sure you are on the **correct tab**, **TORUS EVM - Base**
82+
- Make sure it is **FROM** Base TORUS **TO** Torus EVM
8183

8284
Fill in the form with the amount you want to convert and the Recipient Address, by clicking on the Self button, it will automatically fill the address for you with your connected base wallet.
8385
With all the information filled in, click **Continue**.
@@ -87,15 +89,15 @@ For the sake of simplicity, we are going to refer to the **Native Torus** as **T
8789
3. **Confirm the transaction**
8890
After filling in the form, you will be prompted to confirm the transaction in Metamask.
8991
<Aside type="caution">
90-
Always verify the transaction in Metamask before signing it, it is of your responsibility to verify the transaction details.
91-
You also must have enough funds in your Metamask wallet to cover the transaction fees.
92+
Always verify the transaction in MetaMask before signing it, as it is your responsibility to verify the transaction details.
93+
You also must have enough funds in your MetaMask wallet to cover the transaction fees.
9294
</Aside>
93-
<ClickableImage src={confirmTransactionInMetamask} alt="Confirm the transaction in Metamask" />
95+
<ClickableImage src={confirmTransactionInMetamask} alt="Confirm the transaction in MetaMask" />
9496

9597
4. **Confirmation of the swap**
96-
After the transaction succeeds, your Base Torus should now be displayed as Torus EVM as it was successfully swapped.
97-
This process can take a while to happen in the chain side,
98-
so please, wait a few minutes and refresh the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus).
98+
After the transaction succeeds, your Base TORUS should now be displayed as Torus EVM as it was successfully swapped.
99+
This process can take a while to complete on the blockchain,
100+
so please wait a few minutes and refresh the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus).
99101
If you have any issues, reach out to our support on the [Official Torus Discord](https://discord.gg/torus).
100102
<ClickableImage src={baseTorusSwappedSuccessfully} alt="Confirmation of the swap" />
101103

@@ -107,9 +109,9 @@ For the sake of simplicity, we are going to refer to the **Native Torus** as **T
107109
### Bridge Torus EVM to Torus
108110

109111
<Steps>
110-
1. **Connect both the Torus and Metamask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**.
112+
1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**.
111113
At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**.
112-
<ClickableImage src={metamaskConnectEvm} alt="SubWallet and Metamask connect screen" />
114+
<ClickableImage src={metamaskConnectEvm} alt="SubWallet and MetaMask connect screen" />
113115

114116

115117
1. **Swap from Torus EVM to Torus**
@@ -118,32 +120,32 @@ For the sake of simplicity, we are going to refer to the **Native Torus** as **T
118120
- Make sure it is **FROM** Torus EVM **TO** Torus
119121

120122
Fill in the form with the amount you want to convert, after confirmation, you will be prompted to sign the transaction in Torus.
121-
<ClickableImage src={fillInFormToConvertTorusEvmNativeTorus} alt="Convert Torus EVM to Native Torus" />
123+
<ClickableImage src={fillInFormToConvertTorusEvmNativeTorus} alt="Convert Torus EVM to Native TORUS" />
122124

123125
2. **Confirm the transaction**
124126
After filling in the form, you will be prompted to confirm the transaction in Metamask.
125127
<Aside type="caution">
126-
Always verify the transaction in Metamask before signing it, it is of your responsibility to verify the transaction details.
127-
You also must have enough funds in your Metamask wallet to cover the transaction fees.
128+
Always verify the transaction in MetaMask before signing it, as it is your responsibility to verify the transaction details.
129+
You also must have enough funds in your MetaMask wallet to cover the transaction fees.
128130
</Aside>
129131

130-
<ClickableImage src={confirmTransactionInMetamaskTorusEvmToTorus} alt="Confirm the transaction in Metamask" />
132+
<ClickableImage src={confirmTransactionInMetamaskTorusEvmToTorus} alt="Confirm the transaction in MetaMask" />
131133

132134
3. **Confirmation of the swap**
133-
After the transaction succeeds, your Torus EVM should now be displayed as Torus as it was successfully swapped.
134-
This process can take a while to happen in the chain side,
135-
so please, wait a few minutes and refresh the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus).
135+
After the transaction succeeds, your Torus EVM should now be displayed as TORUS as it was successfully swapped.
136+
This process can take a while to complete on the blockchain,
137+
so please wait a few minutes and refresh the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus).
136138
<ClickableImage src={torusEvmConvertSuccessfully} alt="Confirmation of the swap" />
137139

138140
4. **All Done**
139-
Youve now successfully bridged Torus tokens between **Torus**, **Torus EVM**, and **Base**.
141+
You've now successfully bridged TORUS tokens between **Torus**, **Torus EVM**, and **Base**.
140142
You can view your updated balances directly in the [Torus Web App](https://wallet.torus.network) or SubWallet.
141143
</Steps>
142144

143145

144146
## Support and Resources
145147
By following these steps, you can successfully bridge your tokens between Torus, Torus EVM, and Base.
146-
Holding native Torus is required to interact with the Torus Network, and currently, this is the only supported method for bridging.
148+
Holding native TORUS is required to interact with Torus, and currently, this is the only supported method for bridging.
147149
If you need help or have questions, you can reach out through the official community channels:
148150

149151
- [Torus Community Telegram](https://t.me/torusnetwork)

0 commit comments

Comments
 (0)