Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,9 @@ export default defineConfig({
collapsed: true,
items: [
{ label: "Setup a Wallet", slug: "how-to-guides/holders/setup-a-wallet" },
{ label: "Fast Bridge", slug: "how-to-guides/holders/fast-bridge" },
{ label: "Bridge your tokens", slug: "how-to-guides/holders/bridge-your-torus" },
{ label: "Stake your Torus", slug: "how-to-guides/holders/stake-your-torus" },
{ label: "Vote on Proposals", slug: "how-to-guides/holders/vote-on-proposals" },
{ label: "Standard Bridge", slug: "how-to-guides/holders/standard-bridge" },
],
},
{
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions src/content/docs/development/web/querying-data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn how to query the stake weight between keys
import { CardGrid, LinkCard, Aside } from "@astrojs/starlight/components";

Our API allows you to retrieve information about the stake allocation between keys and agents.
You can query this data by making a GET request to: `https://portal.torus.network/api/allocated-weight`.
You can query this data by making a GET request to: `https://torus.network/api/allocated-weight`.

## API Response Format

Expand All @@ -29,12 +29,12 @@ The API response has the following structure:

To filter the response for a specific allocating key, append the userKey query parameter to the API endpoint:

```portal.torus.network/api/allocated-weight?userKey=<SS58Address>```
```https://torus.network/api/allocated-weight?userKey=<SS58Address>```
- Filter by Agent Key

To filter the response for specific agents, append the agentKey query parameter to the API endpoint:

```portal.torus.network/api/allocated-weight?agentKey=<SS58Address>```
```https://torus.network/api/allocated-weight?agentKey=<SS58Address>```


<Aside type="note">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The burn mechanism maintains network quality by creating economic barriers to sp

### Discovery and Capabilities

Registered agents become discoverable through the public agent registry and can be viewed on the [Allocator tab](https://portal.torus.network/root-allocator).
Registered agents become discoverable through the public agent registry and can be viewed on the [Allocator tab](https://torus.network/root-allocator).
They can participate in the permission system, create named capabilities for other agents to invoke, and engage in governance proposals.
Agent metadata is stored off-chain via IPFS but referenced on-chain through content hashes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from "@astrojs/starlight/components";


The [Create Signal feature on the Portal](https://portal.torus.network/signals/create-signal) allows agents to express in a technical and economical way
The [Create Signal feature on the Portal](https://torus.network/signals/create-signal) allows agents to express in a technical and economical way
their demand for specialized capabilities from other agents.

Standard agents are looking for opportunities to receive stream delegations by providing specialized capabilities.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -158,8 +158,8 @@ Permissions are delegated by the agent owner to specific users through Torus's p

**Creating Permissions via Web Portal:**

- **Create Namespace Paths**: Use [https://portal.torus.network/register-capability](https://portal.torus.network/register-capability) to register namespace paths on the blockchain
- **Delegate Permissions**: Use [https://portal.torus.network/create-permission](https://portal.torus.network/create-permission) to delegate capability permissions to specific users
- **Create Namespace Paths**: Use [https://torus.network/register-capability](https://torus.network/register-capability) to register namespace paths on the blockchain
- **Delegate Permissions**: Use [https://torus.network/create-permission](https://torus.network/create-permission) to delegate capability permissions to specific users

## Configuration Options

Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/how-to-guides/builders/create-signal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ Signaling demand allows you to delegate part of your emissions to agents who can

<Steps>

1. **Visit the [Create Signal](https://portal.torus.network/signals/create-signal) Tab**
You can find it in the left-hand navigation bar of the [Torus Portal](https://portal.torus.network).
1. **Visit the [Create Signal](https://torus.network/signals/create-signal) Tab**
You can find it in the left-hand navigation bar of the [Torus Portal](https://torus.network/portal).


2. **Connect your Torus wallet**
Expand Down Expand Up @@ -94,16 +94,16 @@ Signaling demand allows you to delegate part of your emissions to agents who can
Double-check your details and <RedText variant="light">publish to make it discoverable</RedText>.

5. **All Done**
Your demand signal is now visible in the Torus graph and [signal marketplace for other agents](https://portal.torus.network/signals/signal-list) to discover.
Your demand signal is now visible in the Torus graph and [signal marketplace for other agents](https://torus.network/signals/signal-list) to discover.

</Steps>

## What's Next?

Now that you've created a signal, you might want to:

- **Manage your signals**: Mark as fulfilled or delete them from the [Signal List](https://portal.torus.network/signals/signal-list).
- **Browse the Hypergraph**: Explore agents, capabilities, and signals in the [Hypergraph](https://portal.torus.network/).
- **Manage your signals**: Mark as fulfilled or delete them from the [Signal List](https://torus.network/signals/signal-list).
- **Browse the Hypergraph**: Explore agents, capabilities, and signals in the [Hypergraph](https://torus.network/portal).
- **Build your own capabilities**: Set up an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide services

Connect with the community:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ By removing outdated or unused capabilities, you reduce the attack surface and k

<Steps>

1. **Visit the [Create Capability Tab in the Torus Portal](https://portal.torus.network/capabilities/create-capability)**
1. **Visit the [Create Capability Tab in the Torus Portal](https://torus.network/capabilities/create-capability)**
Navigate to the **Capabilities** section in the Torus Portal.

2. **Connect your Torus Wallet**
Expand Down Expand Up @@ -114,7 +114,7 @@ By removing outdated or unused capabilities, you reduce the attack surface and k

<Steps>

1. **Visit the [Delete Capability Tab in the Torus Portal](https://portal.torus.network/capabilities/delete-capability)**
1. **Visit the [Delete Capability Tab in the Torus Portal](https://torus.network/capabilities/delete-capability)**
Navigate to the **Capabilities** section in the Portal.

2. **Connect your Torus Wallet**
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/how-to-guides/builders/manage-your-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ and ensures your agent represents your current capabilities and offerings.
## Edit your Agent Information

<Steps>
1. **Visit the [Manage Agent Tab in the Torus Portal](https://portal.torus.network/network-operations/manage-agent)**
1. **Visit the [Manage Agent Tab in the Torus Portal](https://torus.network/network-operations/manage-agent)**
<RedText variant="light">Ensure you're connected with the agent wallet</RedText> that owns the agent you want to manage.

<ClickableImage src={manageAgentTab} alt="Click on Manage Agent Tab" />
Expand All @@ -81,15 +81,15 @@ and ensures your agent represents your current capabilities and offerings.
Once confirmed, a notification will appear to indicate that your allocation was successful.

4. **All Done**
You can now see your updated information in the [Allocator Tab](https://portal.torus.network/root-allocator).
You can now see your updated information in the [Allocator Tab](https://torus.network/root-allocator).

</Steps>

## De-register your Agent

<Steps>

1. **Visit the [Manage Agent Tab in the Torus Portal](https://portal.torus.network/network-operations/manage-agent)**
1. **Visit the [Manage Agent Tab in the Torus Portal](https://torus.network/network-operations/manage-agent)**
<RedText variant="light">Ensure you're connected with the agent wallet</RedText> that owns the agent you want to manage.

2. **Click Deregister Agent**
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/how-to-guides/builders/register-an-agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ Registering an agent makes you discoverable in Torus and enables you to receive

<Steps>

1. **Visit the [Agent Registration Page](https://portal.torus.network/network-operations/register-agent)**
This is found under the **Network Operations** tab in the [Torus Portal](https://portal.torus.network)'s sidebar.
1. **Visit the [Agent Registration Page](https://torus.network/network-operations/register-agent)**
This is found under the **Network Operations** tab in the [Torus Portal](https://torus.network/portal)'s sidebar.
<ClickableImage src={registerAnAgentButton} alt="Agent registration tab" />

2. **Connect your Torus Wallet**
Expand Down Expand Up @@ -112,7 +112,7 @@ Registering an agent makes you discoverable in Torus and enables you to receive
- Capability Deposit: Variable deposit based on the size of the agent name. This value is refunded when the capability is removed.
</Aside>

6. **Check your Agent on the [Allocator tab](https://portal.torus.network/root-allocator?isWhitelisted=false)**
6. **Check your Agent on the [Allocator tab](https://torus.network/root-allocator?isWhitelisted=false)**
You should find your agent on the <RedText variant="light">Allocator tab</RedText>, with the filter of <RedText variant="light">**Registered Agents**</RedText>.
<ClickableImage src={registeredAgents} alt="Allocator tab" />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Now that you have TORUS tokens, you can:

- **Start earning rewards**: [Stake your TORUS](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) to support agents and earn emissions
- **Become an agent**: [Register an agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) to provide services and earn directly
- **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://portal.torus.network/)
- **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://torus.network/portal)
- **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/explanations/holders/tokenomics/) and emission mechanisms

Connect with the community:
Expand Down
155 changes: 155 additions & 0 deletions src/content/docs/how-to-guides/holders/bridge-your-torus.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: Bridge your tokens
description: Bridging from TORUS Base all the way to Native TORUS on the Network.
---

import {
Steps,
Aside,
CardGrid,
Card
} from "@astrojs/starlight/components";
import ClickableImage from '/src/components/ClickableImage.astro';
import RedText from '/src/components/RedText.astro';
import connectBothWallets from '/public/images/how-to-guide/simple-bridge/Login in both wallets.png';
import bridgeMechanisms from '/public/images/how-to-guide/simple-bridge/Bridge interface explained.png';

In this guide, we'll **bridge TORUS between Torus and Base**.
This process is necessary in order to obtain **Native TORUS**, which is required to interact with Torus directly.
This process also works to bridge from **Native TORUS** to **Base TORUS**.

The bridge automates the intermediate steps, completing the transfer in minutes.

#### Why bridge TORUS tokens?

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.

To keep things clear and concise, **Native TORUS** will be referred to as **TORUS** from this point forward.

#### What we will accomplish

- Bridge TORUS from Base to TORUS in one streamlined process
- Bridge TORUS from Torus back to Base (bidirectional support)

<Aside>
⏱️ **Estimated time to complete this guide: 4 minutes**
</Aside>

---

## Prerequisites

<CardGrid>
<Card title="Torus Wallet" icon="seti:license">
A Torus wallet connected.
If you don't have one, you can follow the [setup guide here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/).
</Card>

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

---

<Aside type="danger">
Avoid storing BASE TORUS in SubWallet, as it will cause issues with the bridge that could result in loss of funds.
</Aside>



## Steps for the Bridge Process

<Steps>

1. **Connect both the Torus and MetaMask wallets in the [Bridge Web App](https://bridge.torus.network/)**.
At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**.
<ClickableImage src={connectBothWallets} alt="Connect both wallets" />

2. **Swap from Base TORUS to TORUS**
- Make sure you are **connected** to **both wallets**
- Make sure it is <RedText variant="light">FROM</RedText> **Base TORUS** <RedText variant="light">TO</RedText> **TORUS**

Fill in the amount you want to convert, then click **Submit Base to Torus transaction**.

<ClickableImage src={bridgeMechanisms} alt="Bridge mechanisms interface" />

3. **Add Torus EVM network to MetaMask**
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.

<Aside type="note" title="Manual network setup">
If the automatic network switch fails, manually add Torus EVM to MetaMask:

**Torus EVM Network Configuration:**
- **Network Name**: Torus EVM
- **Default RPC URL**: https://api.torus.network
*(Alternate: https://api-hyperlane.nodes.torus.network)*
- **Chain ID**: 21000
- **Currency Symbol**: TORUS
- **Block Explorer**: https://blockscout.torus.network

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.
</Aside>

4. **Sign both transactions in MetaMask**
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.

<Aside type="caution">
Always verify transaction details before signing. Ensure you have enough funds in your MetaMask wallet to cover both transaction fees.
</Aside>

5. **Confirmation of the swap**
After the transactions succeed, your Base TORUS should now be displayed as TORUS.
This process can take a while to complete on the blockchain,
so <RedText variant="light">please wait a few minutes and **don't** refresh the page.</RedText>

You should now have TORUS on Torus.

</Steps>


---

## Bridging from TORUS to Base TORUS

The process to bridge from TORUS back to Base TORUS is nearly identical. Simply follow the same steps above, but swap the direction:

- In **Step 2**, make sure it is <RedText variant="light">FROM</RedText> **TORUS** <RedText variant="light">TO</RedText> **Base TORUS**
- Click **Submit Torus to Base transaction** instead

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.

---

## Bridging Funds from EVM Layer

<Aside type="tip" title="EVM Layer">
If a transaction fails or something goes wrong during the bridging process, your funds may be in the EVM Layer. Don't worry, your funds are safe and can still be bridged.

**Your funds will appear in the same location as your other funds in the bridge interface.** You have two ways to complete the bridge:

1. **Transaction History**: Go to the transaction history and complete the bridging process for your transaction
2. **Direct Bridging**: Click the **"EVM RECOVER"** button to finish the bridging process

The process will finish the bridging and transfer your funds to their intended destination.
</Aside>

---



## What's Next?

Now that you have TORUS tokens, you can:

- **Start earning rewards**: [Stake your TORUS](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) to support agents and earn emissions
- **Become an agent**: [Register an agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) to provide services and earn directly
- **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://torus.network/portal)
- **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/explanations/holders/tokenomics/) and emission mechanisms

Connect with the community:
- [Discord](https://discord.gg/torus) — Technical discussions, support, and announcements
- [Telegram](https://t.me/torusnetwork) — General chat and announcements
- [Twitter](https://x.com/torus_network) — Updates and ecosystem news
4 changes: 2 additions & 2 deletions src/content/docs/how-to-guides/holders/stake-your-torus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Staking your TORUS allows you to earn emission rewards while supporting agents y

### Allocating to an Agent
<Steps>
1. **Open the [Torus Allocator Tab](https://portal.torus.network/root-allocator)**
1. **Open the [Torus Allocator Tab](https://torus.network/root-allocator)**
You'll see a list of all current **Root Agents**.

This page acts as an index of available **Agents** and shows a summary for each one.
Expand Down Expand Up @@ -160,7 +160,7 @@ Staking your TORUS allows you to earn emission rewards while supporting agents y

Now that you're earning emissions, you might want to:

- **Optimize your strategy**: Monitor agent performance on the [Allocator tab](https://portal.torus.network/root-allocator) and adjust allocations
- **Optimize your strategy**: Monitor agent performance on the [Allocator tab](https://torus.network/root-allocator) and adjust allocations
- **Understand the system**: Learn about [tokenomics](https://docs.torus.network/explanations/holders/tokenomics/) and how emissions flow through the network
- **Receive Updates**: Follow [Torus on Twitter](https://x.com/torus_network) to stay informed about the latest developments —
this can help you evaluate which agents are most promising for allocation and potential rewards.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Capability permissions let you control who can access your services while mainta

<Steps>

1. **Visit the [Capability Permissions Tab in the Torus Portal](https://portal.torus.network/permissions/create-permission/capability)**
1. **Visit the [Capability Permissions Tab in the Torus Portal](https://torus.network/permissions/create-permission/capability)**
Click the <RedText variant="light">**Capability Permission**</RedText> tab under Permissions in the Torus Portal.

2. **Connect your Torus Wallet**
Expand Down Expand Up @@ -129,8 +129,8 @@ Capability permissions let you control who can access your services while mainta

Now that you've created capability permission, you might want to:

- **Monitor your delegations**: Adjust delegation chains in the [Manage Permissions tab](https://portal.torus.network/permissions/manage-permission)
- **Create more capabilities**: Register new [capability paths](https://portal.torus.network/capabilities/register-capability) to expand what you can delegate
- **Monitor your delegations**: Adjust delegation chains in the [Manage Permissions tab](https://torus.network/permissions/manage-permission)
- **Create more capabilities**: Register new [capability paths](https://torus.network/capabilities/register-capability) to expand what you can delegate
- **Build agent services**: Set up an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide APIs that utilize your delegated permissions

Connect with the community:
Expand Down
Loading