Skip to content

Commit cf7cf00

Browse files
SipherSipher
committed
add how-to guides for setting up a wallet and participating in the Torus Network, plus related images
1 parent d60152b commit cf7cf00

File tree

10 files changed

+352
-7
lines changed

10 files changed

+352
-7
lines changed

‎astro.config.mjs‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,16 @@ export default defineConfig({
3737
{
3838
label: "v0.5",
3939
items: [
40-
// { label: "Network Overview", slug: "concepts/network-overview" },
41-
{ label: "Control Space", slug: "v05/control-space" },
42-
{ label: "Permission System", slug: "v05/permissions" },
43-
{ label: "Capability Permissions", slug: "v05/capability-permissions" },
44-
{ label: "Emission Permissions", slug: "v05/emission-permissions" },
45-
{ label: "Tokenomics", slug: "concepts/tokenomics" },
46-
{ label: "Governance & DAO", slug: "concepts/governance-dao" },
40+
// { label: "Network Overview", slug: "concepts/network-overview" },
41+
{ label: "Control Space", slug: "v05/control-space" },
42+
{ label: "Permission System", slug: "v05/permissions" },
43+
{
44+
label: "Capability Permissions",
45+
slug: "v05/capability-permissions",
46+
},
47+
{ label: "Emission Permissions", slug: "v05/emission-permissions" },
48+
{ label: "Tokenomics", slug: "concepts/tokenomics" },
49+
{ label: "Governance & DAO", slug: "concepts/governance-dao" },
4750
],
4851
},
4952
{
@@ -96,6 +99,16 @@ export default defineConfig({
9699
},
97100
],
98101
},
102+
{
103+
label: "How-to Guides",
104+
items: [
105+
{ label: "Setup a wallet", slug: "how-to-guides/setup-a-wallet" },
106+
// {
107+
// label: "Setup a wallet",
108+
// slug: "how-to-guides/setup-a-wallet",
109+
// },
110+
],
111+
},
99112
],
100113
customCss: ["./src/tailwind.css"],
101114
}),

‎public/images/how-to-guide/setup-wallet/subwallet-created-successfully.png‎

223 KB
Loading

‎public/images/how-to-guide/setup-wallet/subwallet-done-torus-setup.png‎

159 KB
Loading

‎public/images/how-to-guide/setup-wallet/subwallet-extension-activated.png‎

312 KB
Loading

‎public/images/how-to-guide/setup-wallet/subwallet-open-setup.png‎

272 KB
Loading

‎public/images/how-to-guide/setup-wallet/subwallet-search-torus-network.png‎

154 KB
Loading

‎public/images/how-to-guide/setup-wallet/subwallet-select-config-to-add-network.png‎

174 KB
Loading

‎src/content/docs/how-to-guides/how-to-guides.mdx‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: How to be a builder on Torus
3+
description: A practical guide to getting involved in the Torus Network, from permissions to integration.
4+
---
5+
6+
## Overview
7+
8+
Participating in the Torus Network means becoming an **agent** that contributes value through **signals** and **integrations**. This guide walks you through each step — from setting up your wallet to delivering a fully working agent.
9+
10+
---
11+
12+
## 🧭 Step-by-Step Path
13+
14+
### 1. Set up your wallet
15+
16+
Every agent begins with a wallet that can sign transactions.
17+
18+
👉 [How to create a wallet](/how-to-guides/set-up-wallet)
19+
20+
---
21+
22+
### 2. Register your agent
23+
24+
To act on-chain, your wallet must be registered or whitelisted.
25+
26+
👉 [How to register an agent](/how-to-guides/register-agent)
27+
👉 [How to apply to be whitelisted](/how-to-guides/apply-to-be-whitelisted)
28+
29+
---
30+
31+
### 3. Create a permission namespace
32+
33+
Define your agent’s capabilities by creating a permission.
34+
35+
👉 [How to create a permission](/how-to-guides/create-permission)
36+
👉 [How to edit a permission](/how-to-guides/edit-permission)
37+
38+
---
39+
40+
### 4. Grant or manage capabilities
41+
42+
Give specific agents (including yourself) the ability to act.
43+
44+
👉 [How to create capabilities](/how-to-guides/create-capabilities)
45+
👉 [How to delete capabilities](/how-to-guides/delete-capabilities)
46+
47+
---
48+
49+
### 5. Create a signal
50+
51+
Agents produce **signals** to announce work, ideas, or needs. To emit signals, you must have emissions permissions.
52+
53+
👉 [How to create a signal](/how-to-guides/create-signal)
54+
👉 [How to receive emissions](/how-to-guides/receive-emissions)
55+
56+
---
57+
58+
### 6. Interact with the API
59+
60+
To read/write from the network, learn how to use the API.
61+
62+
👉 [How to interact with the Agent API](/how-to-guides/agent-api)
63+
64+
---
65+
66+
### 7. Integrate it all
67+
68+
Bring everything together into a working, running agent.
69+
70+
👉 [How to host an agent](/how-to-guides/host-agent)
71+
👉 [How to connect to the chain](/how-to-guides/connect-to-chain)
72+
73+
---
74+
75+
## 🧑‍💻 Participating in Signals (as a developer)
76+
77+
Once a signal is live, others can collaborate:
78+
79+
1. **Find** a relevant signal
80+
2. **Talk** to the issuer
81+
3. **Develop** based on the signal’s namespace + permissions
82+
4. **Deliver** your work
83+
84+
👉 [How to find and respond to a signal](/how-to-guides/respond-to-signal)
85+
👉 [How to host an agent](/how-to-guides/host-agent)
86+
87+
---
88+
89+
## 🔄 Ready to start?
90+
91+
Start from the top or jump into the step you need. Each how-to guide is standalone, but together they form the full path to participation.

‎src/content/docs/how-to-guides/how-to-take-part.mdx‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: How to be a builder on Torus
3+
description: A practical guide to getting involved in the Torus Network, from permissions to integration.
4+
---
5+
6+
## Overview
7+
8+
Participating in the Torus Network means becoming an **agent** that contributes value through **signals** and **integrations**. This guide walks you through each step — from setting up your wallet to delivering a fully working agent.
9+
10+
---
11+
12+
## 🧭 Step-by-Step Path
13+
14+
### 1. Set up your wallet
15+
16+
Every agent begins with a wallet that can sign transactions.
17+
18+
👉 [How to create a wallet](/how-to-guides/set-up-wallet)
19+
20+
---
21+
22+
### 2. Register your agent
23+
24+
To act on-chain, your wallet must be registered or whitelisted.
25+
26+
👉 [How to register an agent](/how-to-guides/register-agent)
27+
👉 [How to apply to be whitelisted](/how-to-guides/apply-to-be-whitelisted)
28+
29+
---
30+
31+
### 3. Create a permission namespace
32+
33+
Define your agent’s capabilities by creating a permission.
34+
35+
👉 [How to create a permission](/how-to-guides/create-permission)
36+
👉 [How to edit a permission](/how-to-guides/edit-permission)
37+
38+
---
39+
40+
### 4. Grant or manage capabilities
41+
42+
Give specific agents (including yourself) the ability to act.
43+
44+
👉 [How to create capabilities](/how-to-guides/create-capabilities)
45+
👉 [How to delete capabilities](/how-to-guides/delete-capabilities)
46+
47+
---
48+
49+
### 5. Create a signal
50+
51+
Agents produce **signals** to announce work, ideas, or needs. To emit signals, you must have emissions permissions.
52+
53+
👉 [How to create a signal](/how-to-guides/create-signal)
54+
👉 [How to receive emissions](/how-to-guides/receive-emissions)
55+
56+
---
57+
58+
### 6. Interact with the API
59+
60+
To read/write from the network, learn how to use the API.
61+
62+
👉 [How to interact with the Agent API](/how-to-guides/agent-api)
63+
64+
---
65+
66+
### 7. Integrate it all
67+
68+
Bring everything together into a working, running agent.
69+
70+
👉 [How to host an agent](/how-to-guides/host-agent)
71+
👉 [How to connect to the chain](/how-to-guides/connect-to-chain)
72+
73+
---
74+
75+
## 🧑‍💻 Participating in Signals (as a developer)
76+
77+
Once a signal is live, others can collaborate:
78+
79+
1. **Find** a relevant signal
80+
2. **Talk** to the issuer
81+
3. **Develop** based on the signal’s namespace + permissions
82+
4. **Deliver** your work
83+
84+
👉 [How to find and respond to a signal](/how-to-guides/respond-to-signal)
85+
👉 [How to host an agent](/how-to-guides/host-agent)
86+
87+
---
88+
89+
## 🔄 Ready to start?
90+
91+
Start from the top or jump into the step you need. Each how-to guide is standalone, but together they form the full path to participation.

‎src/content/docs/how-to-guides/setup-a-wallet.mdx‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title: Setup a Wallet
3+
description: Learn how to set up a wallet to manage your assets on Torus.
4+
---
5+
6+
import {
7+
Steps,
8+
Aside,
9+
CardGrid,
10+
LinkCard,
11+
} from "@astrojs/starlight/components";
12+
13+
In this guide, we’ll walk through setting up a wallet with the **SubWallet** browser extension, a popular non-custodial wallet for managing assets across multiple blockchains.
14+
If you prefer a different extension, scroll to the bottom for a list of other wallets that work with Torus.
15+
For simplicity’s sake, though, we’ll focus on SubWallet.
16+
17+
#### What we will accomplish
18+
19+
- Install the SubWallet extension
20+
- Create a new wallet (master password + seed phrase)
21+
- Connect SubWallet to Torus
22+
23+
## Steps to connect your SubWallet to Torus.
24+
25+
### 1. Installing the SubWallet Extension
26+
27+
<Steps>
28+
29+
1. **Download the Extension**
30+
Visit the [SubWallet download page](https://www.subwallet.app/download.html) and choose the appropriate extension for your browser (Chrome, Brave, Firefox, or Microsoft Edge).
31+
32+
2. **Add to Browser**
33+
Click on the download link and follow the prompts to add the SubWallet extension to your browser.
34+
35+
3. **Activate/Pin the Extension**
36+
In some cases, you may need to activate the extension manually. Refer to the [SubWallet documentation](https://docs.subwallet.app/main) for instructions.
37+
38+
If everything is correct, the SubWallet icon should appear in the top-right corner of your browser. You are ready to move to the next step and create a new wallet.
39+
40+
<span style={{ fontSize: "0.9rem", fontStyle: "italic" }}>
41+
42+
Below is a reference image of the SubWallet extension activated/pinned in
43+
the Brave browser:
44+
45+
</span>
46+
47+
![SubWallet extension activated in Brave browser](/images/how-to-guide/setup-wallet/subwallet-extension-activated.png)
48+
49+
</Steps>
50+
51+
### 2. Creating a New Account
52+
53+
<Steps>
54+
55+
1. **Open the SubWallet extension in you browser**:
56+
Click on the SubWallet icon in your browser’s extension area to open the wallet.
57+
58+
2. **Click Create a New Account**:
59+
You will be prompted between three options, **Select Create new account**:
60+
61+
- Create new account
62+
- Import account
63+
- Connect existing account
64+
65+
3. **Create a Master Password**:
66+
You will be prompted to create a master password. This password is crucial as it encrypts your wallet data on your device for security.
67+
68+
4. **Backup Your Seed Phrase**:
69+
After setting your password and accepting all the seed phrase terms, you will receive a seed phrase. **Write this down and store it in a secure location. This seed phrase is essential for recovering your wallet if you forget your password or lose access to your device.**
70+
[Here's a video for you to watch later about methods to keep your seed phrase safe](https://www.youtube.com/watch?v=fdtx0MG0Xgo).
71+
72+
<Aside type="danger">
73+
74+
Never share your seed phrase with anyone, as it gives full access to all
75+
your funds on the wallet. Keep it secure and private.
76+
77+
</Aside>
78+
79+
5. **Create an account name**:
80+
Choose an account name, this does not impact on anything, so feel free to choose any name you like. If you want to change it later, you can do so from the account settings.
81+
82+
<span style={{ fontSize: "0.9rem", fontStyle: "italic" }}>
83+
84+
Below is a reference image of a successfull account created in the
85+
SubWallet extension:
86+
87+
</span>
88+
89+
![SubWallet account succesfully created](/images/how-to-guide/setup-wallet/subwallet-created-successfully.png)
90+
91+
</Steps>
92+
93+
### 3. Adding Torus to the Subwallet
94+
95+
<Steps>
96+
1. **Open the Subwallet Setup**:
97+
Click in the three bars(**☰**) on the top left corner of the subwallet extension.
98+
![SubWallet setup button](/images/how-to-guide/setup-wallet/subwallet-open-setup.png)
99+
100+
2. **Select Manage Networks**:
101+
Under the **Assets & Addresses** tab, click on **Manage Networks**.
102+
![SubWallet manage networks button](/images/how-to-guide/setup-wallet/subwallet-select-config-to-add-network.png)
103+
104+
3. **Search for Torus and activate it**:
105+
Click on the search bar, type Torus, and select it from the list. Make sure to enable it so it appears in your list of active tokens.
106+
![SubWallet search for Torus button](/images/how-to-guide/setup-wallet/subwallet-search-torus-network.png)
107+
108+
4. **Confirm Torus is active**:
109+
Once enabled, **Torus** will appear in your list of active networks.
110+
You mihgt have to scroll down to find Torus in the list.
111+
You're now ready to interact with the Torus ecosystem using your SubWallet.
112+
![SubWallet network list with torus](/images/how-to-guide/setup-wallet/subwallet-done-torus-setup.png)
113+
114+
<Aside>
115+
If you don't see **Torus** in the list, you might need to add it manually.
116+
Follow the steps in this [video tutorial by Omni Labs](https://www.youtube.com/watch?v=3JDQFYg0u_A&t=172s).
117+
118+
**RPC URL:** `wss://api.torus.network`
119+
120+
</Aside>
121+
122+
</Steps>
123+
124+
## Support and Resources
125+
126+
For further assistance, you can access detailed tutorials and user guides on the [SubWallet Documentation page](https://docs.subwallet.app/main). Additionally, community support is available through channels like Telegram, Discord, and YouTube.
127+
128+
By following these steps, you can effectively set up and start using your SubWallet to manage, receive, and send assets across multiple blockchain networks, ensuring a secure and efficient digital asset management experience.
129+
130+
<Aside>
131+
**Security Features**: SubWallet is non-custodial, meaning you control your
132+
keys. It also supports hardware wallets like Ledger and Keystone for enhanced
133+
security.
134+
</Aside>
135+
136+
## Other Supported Wallets
137+
138+
While this guide uses SubWallet, other wallets are also compatible with the Torus Network.
139+
The list below includes some of the most known and tested options, but it may not cover every possible wallet.
140+
141+
These wallets are not officially endorsed, and while they are known to work with Substrate networks, we recommend using them only if you're already familiar or willing to explore.
142+
143+
- [Polkadot.js Extension](https://polkadot.js.org/extension/).
144+
The official extension for Substrate-based networks. Well-supported and reliable for Torus.
145+
- [Talisman](https://talisman.xyz/).
146+
A modern wallet for the Polkadot ecosystem with a user-friendly interface and Torus compatibility.
147+
- [Nova Wallet](https://novawallet.io/).
148+
Mobile-only (iOS/Android), good for monitoring and mobile usage. Not recommended for browser dApps.
149+
- [Ledger (via Polkadot.js)](https://wiki.polkadot.network/docs/learn-ledger).
150+
For advanced users, hardware wallet support via Polkadot.js ensures enhanced security.

0 commit comments

Comments
 (0)