diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 409be8d..37c61c7 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -26,7 +26,7 @@ jobs: - name: Setup PNPM uses: pnpm/action-setup@v4 with: - version: latest + version: 10 package_json_file: ./package.json - name: Setup Node diff --git a/.github/workflows/dry-run-build.yml b/.github/workflows/dry-run-build.yml index db105c7..11a5a00 100644 --- a/.github/workflows/dry-run-build.yml +++ b/.github/workflows/dry-run-build.yml @@ -20,7 +20,7 @@ jobs: - name: Setup PNPM uses: pnpm/action-setup@v4 with: - version: latest + version: 10 package_json_file: ./package.json - name: Setup Node diff --git a/astro.config.mjs b/astro.config.mjs index ceaea33..714e596 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -1,8 +1,8 @@ // @ts-check -import { defineConfig } from "astro/config"; +import { defineConfig } from 'astro/config'; -import starlight from "@astrojs/starlight"; -import tailwind from "@astrojs/tailwind"; +import starlight from '@astrojs/starlight'; +import tailwind from '@astrojs/tailwind'; // https://astro.build/config export default defineConfig({ @@ -26,61 +26,32 @@ export default defineConfig({ label: "Getting Started", items: [ { label: "Welcome", slug: "index" }, - { - label: "Understanding Torus", - slug: "getting-started/understanding-torus", - }, + { label: "Understanding Torus", slug: "getting-started/understanding-torus" }, ], }, { label: "Explanations", items: [ - { - label: "Table of Contents", - slug: "explanations/table-of-contents", - }, + { label: "Table of Contents", slug: "explanations/table-of-contents" }, { label: "System", collapsed: true, items: [ - { - label: "Control Space", - slug: "explanations/system/control-space", - }, - { - label: "Permission System", - slug: "explanations/system/permission-system", - }, - { - label: "Recursive Delegation", - slug: "explanations/system/recursive-delegation", - }, - { - label: "Wallet Stake Permission", - slug: "explanations/system/wallet-stake-permission", - }, - { - label: "Stream Permissions", - slug: "explanations/system/stream-permissions", - }, - { - label: "Capability Permissions", - slug: "explanations/system/capability-permissions", - }, - { - label: "Wallet Permission", - slug: "explanations/system/wallet-stake-permission", - }, + { label: "Control Space", slug: "explanations/system/control-space" }, + { label: "Permission System", slug: "explanations/system/permission-system" }, + { label: "Recursive Delegation", slug: "explanations/system/recursive-delegation" }, + { label: "Wallet Stake Permission", slug: "explanations/system/wallet-stake-permission" }, + { label: "Stream Permissions", slug: "explanations/system/stream-permissions" }, + { label: "Capability Permissions", slug: "explanations/system/capability-permissions" }, + { label: "Wallet Permission", slug: "explanations/system/wallet-stake-permission" }, ], }, { label: "Holders", collapsed: true, items: [ - { - label: "Tokenomics", - slug: "explanations/holders/tokenomics", - }, + + { label: "Tokenomics", slug: "explanations/holders/tokenomics" }, { label: "Staking", slug: "explanations/holders/staking" }, ], }, @@ -88,157 +59,71 @@ export default defineConfig({ label: "Builders", collapsed: true, items: [ - { - label: "Agent Registration", - slug: "explanations/builders/agent-registration", - }, - { - label: "Agent Managing", - slug: "explanations/builders/agent-managing", - }, - { - label: "Demand Signaling", - slug: "explanations/builders/demand-signaling", - }, - { - label: "Agent Server", - slug: "explanations/builders/agent-server", - }, - { - label: "Agent Client", - slug: "explanations/builders/agent-client", - }, + { label: "Agent Registration", slug: "explanations/builders/agent-registration" }, + { label: "Agent Managing", slug: "explanations/builders/agent-managing" }, + { label: "Demand Signaling", slug: "explanations/builders/demand-signaling" }, + { label: "Agent Server", slug: "explanations/builders/agent-server" }, + { label: "Agent Client", slug: "explanations/builders/agent-client" }, ], }, { label: "Goal Leaders", collapsed: true, items: [ - { - label: "Root Agents", - slug: "explanations/goal-leaders/root-agents", - }, - { - label: "DAO Treasury", - slug: "explanations/goal-leaders/dao-treasury", - }, - { - label: "Emission Proposals", - slug: "explanations/goal-leaders/emission-proposals", - }, - { - label: "Governance & DAO", - slug: "explanations/goal-leaders/governance-dao", - }, + { label: "Root Agents", slug: "explanations/goal-leaders/root-agents" }, + { label: "DAO Treasury", slug: "explanations/goal-leaders/dao-treasury" }, + { label: "Emission Proposals", slug: "explanations/goal-leaders/emission-proposals" }, + { label: "Governance & DAO", slug: "explanations/goal-leaders/governance-dao" }, ], }, - { - label: "Concepts & Terminology", - slug: "explanations/concepts-terminology", - }, + { label: "Concepts & Terminology", slug: "explanations/concepts-terminology" }, ], }, { label: "How-to Guides", items: [ - { - label: "Table of Contents", - slug: "how-to-guides/table-of-contents", - }, + { label: "Table of Contents", slug: "how-to-guides/table-of-contents" }, { label: "System", collapsed: true, items: [ - { - label: "Create Capability Permission", - slug: "how-to-guides/system/create-capability-permission", - }, - { - label: "Create Stream Permission", - slug: "how-to-guides/system/create-stream-permission", - }, - { - label: "Create Wallet Stake Permission", - slug: "how-to-guides/system/create-wallet-stake-permission", - }, - { - label: "Manage Permissions", - slug: "how-to-guides/system/manage-permissions", - }, - { - label: "Create Wallet Permission", - slug: "how-to-guides/system/create-wallet-stake-permission", - }, + + { label: "Create Capability Permission", slug: "how-to-guides/system/create-capability-permission" }, + { label: "Create Stream Permission", slug: "how-to-guides/system/create-stream-permission" }, + { label: "Create Wallet Stake Permission", slug: "how-to-guides/system/create-wallet-stake-permission" }, + { label: "Manage Permissions", slug: "how-to-guides/system/manage-permissions" }, + { label: "Create Wallet Permission", slug: "how-to-guides/system/create-wallet-stake-permission" }, ], }, { label: "Holders", collapsed: true, items: [ - { - label: "Setup a Wallet", - slug: "how-to-guides/holders/setup-a-wallet", - }, - { - 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: "Setup a Wallet", slug: "how-to-guides/holders/setup-a-wallet" }, + { 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: "Builders", collapsed: true, items: [ - { - label: "Register an Agent", - slug: "how-to-guides/builders/register-an-agent", - }, - { - label: "Manage your Agent", - slug: "how-to-guides/builders/manage-your-agent", - }, - { - label: "Manage Capabilities", - slug: "how-to-guides/builders/manage-capabilities", - }, - { - label: "Create a Signal", - slug: "how-to-guides/builders/create-signal", - }, - { - label: "Setup Agent Server", - slug: "how-to-guides/builders/setup-agent-server", - }, - { - label: "Setup Agent Client", - slug: "how-to-guides/builders/setup-agent-client", - }, + { label: "Register an Agent", slug: "how-to-guides/builders/register-an-agent" }, + { label: "Manage your Agent", slug: "how-to-guides/builders/manage-your-agent" }, + { label: "Manage Capabilities", slug: "how-to-guides/builders/manage-capabilities" }, + { label: "Create a Signal", slug: "how-to-guides/builders/create-signal" }, + { label: "Setup Agent Server", slug: "how-to-guides/builders/setup-agent-server" }, + { label: "Setup Agent Client", slug: "how-to-guides/builders/setup-agent-client" }, ], }, { label: "Goal Leaders", collapsed: true, items: [ - { - label: "Become a Root Agent", - slug: "how-to-guides/goal-leaders/become-a-root-agent", - }, - { - label: "Request DAO Treasury Transfer", - slug: "how-to-guides/goal-leaders/request-dao-treasury-transfer", - }, - { - label: "Create Emission Proposal", - slug: "how-to-guides/goal-leaders/create-emission-proposal", - }, + { label: "Become a Root Agent", slug: "how-to-guides/goal-leaders/become-a-root-agent" }, + { label: "Request DAO Treasury Transfer", slug: "how-to-guides/goal-leaders/request-dao-treasury-transfer" }, + { label: "Create Emission Proposal", slug: "how-to-guides/goal-leaders/create-emission-proposal" }, ], }, ], @@ -246,10 +131,7 @@ export default defineConfig({ { label: "Development", items: [ - { - label: "Table of Contents", - slug: "development/table-of-contents", - }, + { label: "Table of Contents", slug: "development/table-of-contents" }, { label: "Web Apps", collapsed: true, @@ -269,35 +151,23 @@ export default defineConfig({ collapsed: true, items: [ { label: "Setup CLI", slug: "development/cli/setup-cli" }, - { - label: "Key Management", - slug: "development/cli/key-management", - }, - { - label: "Balance Operations", - slug: "development/cli/balance-operations", - }, + { label: "Key Management", slug: "development/cli/key-management" }, + { label: "Balance Operations", slug: "development/cli/balance-operations" }, ], }, { label: "Network Operations", collapsed: true, items: [ - { - label: "Global Parameters", - slug: "development/network/global-parameters", - }, - { - label: "Running a Node", - slug: "development/network/running-node", - }, + { label: "Global Parameters", slug: "development/network/global-parameters" }, + { label: "Running a Node", slug: "development/network/running-node" }, ], }, ], }, ], components: { - Head: "./src/components/Head.astro", + Head: './src/components/Head.astro', }, customCss: ["./src/tailwind.css"], }), diff --git a/src/content/docs/404.mdx b/src/content/docs/404.mdx index 550a7ac..a1bd9d1 100644 --- a/src/content/docs/404.mdx +++ b/src/content/docs/404.mdx @@ -3,17 +3,13 @@ title: 404 - Page not found description: The page you're looking for doesn't exist --- -import RedText from "/src/components/RedText.astro"; -import travoltaGif from "../../assets/travolta-lost.gif"; +import RedText from '/src/components/RedText.astro'; +import travoltaGif from '../../assets/travolta-lost.gif'; # Looks like you are lost...
- John Travolta confused + John Travolta confused
The page you're looking for might have been moved, renamed, or doesn't ..... exist? @@ -33,11 +29,9 @@ and tag some of our moderators. We will fix it as soon as possible. Here's the text for you to copy and paste: -- **Problem**: [Replace with your - problem] -- **Where you clicked**: [Replace with - the URL you clicked, e.g in the docs somewhere, or in another website] -- **What you expected**: [Replace with - what you expected to happen, either the correct link or the expected behavior] +- **Problem**: [Replace with your problem] +- **Where you clicked**: [Replace with the URL you clicked, e.g in the docs somewhere, or in another website] +- **What you expected**: [Replace with what you expected to happen, either the correct link or the expected behavior] + Thank you very much for your feedback! diff --git a/src/content/docs/development/cli/setup-cli.mdx b/src/content/docs/development/cli/setup-cli.mdx index 35d21b7..68bbc39 100644 --- a/src/content/docs/development/cli/setup-cli.mdx +++ b/src/content/docs/development/cli/setup-cli.mdx @@ -9,7 +9,7 @@ import { CardGrid, Card, Tabs, - TabItem, + TabItem } from "@astrojs/starlight/components"; In this guide, we'll walk through **installing and setting up the Torus CLI** on your system. @@ -25,28 +25,28 @@ The CLI enables developers and power users to manage Torus operations from the c - Verify the installation works correctly - Set up shell completions for better usability - + ## Prerequisites - Choose your installation method based on your system setup: - **Python - users**: [Python 3.10+](https://www.python.org/) and - [pip](https://pip.pypa.io/en/stable/installation/) - **Nix users**: [Nix - package manager](https://github.com/NixOS/nix) + Choose your installation method based on your system setup: + - **Python users**: [Python 3.10+](https://www.python.org/) and [pip](https://pip.pypa.io/en/stable/installation/) + - **Nix users**: [Nix package manager](https://github.com/NixOS/nix) ## Install Torus CLI - -1. **Choose your installation method** - Select the method that matches your system setup. + 1. **Choose your installation method** + Select the method that matches your system setup. - + Install the Torus CLI using pip: @@ -59,56 +59,54 @@ The CLI enables developers and power users to manage Torus operations from the c ```sh poetry add torusdk ``` - - - Clone and install using Nix: + + Clone and install using Nix: ```sh git clone https://github.com/renlabs-dev/torus-cli cd torus-cli nix profile install . ``` - - + -2. **Verify the installation** - Check that the CLI is installed correctly: - ```sh - torus --version - ``` +2. **Verify the installation** + Check that the CLI is installed correctly: - You should see the version number displayed. + ```sh + torus --version + ``` -3. **Test basic functionality** - Run a simple command to ensure everything works: + You should see the version number displayed. - ```sh - torus network params - ``` +3. **Test basic functionality** + Run a simple command to ensure everything works: - This will display the current network parameters, confirming your CLI can connect to Torus. + ```sh + torus network params + ``` -4. **Set up shell completions (optional)** - Enable tab completion for better usability: + This will display the current network parameters, confirming your CLI can connect to Torus. - ```sh - # For bash users - torus --install-completion bash +4. **Set up shell completions (optional)** + Enable tab completion for better usability: - # For zsh users - torus --install-completion zsh - ``` + ```sh + # For bash users + torus --install-completion bash - + # For zsh users + torus --install-completion zsh + ``` -5. **All Done** - Your Torus CLI is now ready to use! You can manage keys, check balances, and interact with agents. + + +5. **All Done** + Your Torus CLI is now ready to use! You can manage keys, check balances, and interact with agents. @@ -117,7 +115,6 @@ The CLI enables developers and power users to manage Torus operations from the c Now that you have the CLI installed, here are the main command categories: **Key Management:** - ```sh torus key create my-key # Create a new key torus key list # List all keys @@ -125,14 +122,12 @@ torus key balances # Show key balances ``` **Balance Operations:** - ```sh torus balance show
# Check balance torus balance transfer # Send tokens ``` **Network Information:** - ```sh torus network params # Network parameters torus misc circulating-supply # Total supply info @@ -147,8 +142,7 @@ Now that you have the CLI set up, you can: - **Check balances**: Use [balance operations](/development/cli/balance-operations/) to monitor your tokens - **Build integrations**: Set up [agent servers](/how-to-guides/builders/setup-agent-server/) for programmatic interactions -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news @@ -159,13 +153,9 @@ Connect with the community: - - Learn to create and manage your keys - + Learn to create and manage your keys - - Transfer tokens and manage staking - + Transfer tokens and manage staking - + \ No newline at end of file diff --git a/src/content/docs/development/table-of-contents.mdx b/src/content/docs/development/table-of-contents.mdx index bfcd432..a9450e8 100644 --- a/src/content/docs/development/table-of-contents.mdx +++ b/src/content/docs/development/table-of-contents.mdx @@ -2,19 +2,18 @@ title: Table of Contents description: Technical documentation and tools for developing with and on Torus. --- - import { Steps, Aside, CardGrid, Card, Tabs, - TabItem, + TabItem } from "@astrojs/starlight/components"; Welcome to the **Development** section of the Torus documentation. -This section provides comprehensive technical resources for developers building with Torus — from setting up development environments to running nodes and managing keys. +This section provides comprehensive technical resources for developers building with Torus — from setting up development environments to running nodes and managing keys. Whether you're integrating with existing web apps, querying data, or running your own infrastructure, you'll find the technical details here. ## Web Application Development @@ -58,4 +57,4 @@ Explore the open source code to understand implementation details: - **[torus-substrate](https://github.com/renlabs-dev/torus-substrate)** — Core blockchain runtime built on Substrate - **[torus-ts](https://github.com/renlabs-dev/torus-ts)** — TypeScript SDK for building on Torus and WebApps -- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation +- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation \ No newline at end of file diff --git a/src/content/docs/explanations/table-of-contents.mdx b/src/content/docs/explanations/table-of-contents.mdx index cfb9af1..7ee22f8 100644 --- a/src/content/docs/explanations/table-of-contents.mdx +++ b/src/content/docs/explanations/table-of-contents.mdx @@ -2,21 +2,21 @@ title: Table of Contents description: Deep-dive explanations to help you understand how Torus works under the hood. --- - import { Steps, Aside, CardGrid, Card, Tabs, - TabItem, + TabItem } from "@astrojs/starlight/components"; Welcome to the **Explanations** section of the Torus documentation. -If you need to accomplish a specific task, check out our [How-to Guides](https://docs.torus.network/how-to-guides/table-of-contents/) instead. +If you need to accomplish a specific task, check out our [How-to Guides](https://docs.torus.network/how-to-guides/table-of-contents/) instead. + +These explanations provide deep understanding of how Torus works, the concepts, mechanisms of Torus. -These explanations provide deep understanding of how Torus works, the concepts, mechanisms of Torus. ## System Architecture @@ -34,11 +34,13 @@ Core system components and mechanisms: ## For Holders + Learn about TORUS economics and understand how you can participate: - [Tokenomics](https://docs.torus.network/explanations/holders/tokenomics/) — Economics of TORUS: supply mechanisms and emission distribution models - [Staking](https://docs.torus.network/explanations/holders/staking/) — Staking mechanisms and incentives for network participation + --- ## For Builders (Agents) @@ -64,6 +66,7 @@ Understanding governance and leadership systems: --- + ## Questions Not Covered Here? Can't find the explanation you're looking for? The community is here to help: @@ -78,4 +81,4 @@ Explore the open source code to understand the implementation: - **[torus-substrate](https://github.com/renlabs-dev/torus-substrate)** — Core blockchain runtime built on Substrate. - **[torus-ts](https://github.com/renlabs-dev/torus-ts)** — TypeScript SDK for building on Torus and WebApps. -- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation. +- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation. \ No newline at end of file diff --git a/src/content/docs/how-to-guides/builders/create-signal.mdx b/src/content/docs/how-to-guides/builders/create-signal.mdx index b2f57cb..a59cc16 100644 --- a/src/content/docs/how-to-guides/builders/create-signal.mdx +++ b/src/content/docs/how-to-guides/builders/create-signal.mdx @@ -3,8 +3,13 @@ title: Create a Signal description: Signal demand for specialized capabilities from other agents in Torus. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; -import RedText from "/src/components/RedText.astro"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; +import RedText from '/src/components/RedText.astro'; In this guide, we'll **create a demand signal** to express your need for specialized capabilities from other agents. @@ -18,22 +23,20 @@ Signaling demand allows you to delegate part of your emissions to agents who can - Set emission allocation to incentivize other agents - Publish the signal to make it discoverable - + ## Prerequisites - You need to be an agent with emissions (coming from root or target) to - create demand signals. You can find guides on how to [register an - agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) - and [become a root - agent](https://docs.torus.network/how-to-guides/goal-leaders/become-a-root-agent/). + You need to be an agent with emissions (coming from root or target) to create demand signals. + You can find guides on how to [register an agent](https://docs.torus.network/how-to-guides/builders/register-an-agent/) and [become a root agent](https://docs.torus.network/how-to-guides/goal-leaders/become-a-root-agent/). - Have incoming emission streams available to offer as incentive for - capability providers. You can find a [guide on how to stake TORUS - here](https://docs.torus.network/how-to-guides/holders/stake-your-torus/). + Have incoming emission streams available to offer as incentive for capability providers. + You can find a [guide on how to stake TORUS here](https://docs.torus.network/how-to-guides/holders/stake-your-torus/). @@ -41,13 +44,14 @@ Signaling demand allows you to delegate part of your emissions to agents who can -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). +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** Connect the wallet that owns the agent you want to signal from. -3. **Fill in the signal details** +3. **Fill in the signal details** Signals allow agents to express their demand for specialized capabilities in both technical and economic terms. Here's an example of what a signal could look like: @@ -83,9 +87,7 @@ Signaling demand allows you to delegate part of your emissions to agents who can ``` 4. **Review and publish the signal** @@ -104,14 +106,11 @@ Now that you've created a signal, you might want to: - **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: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [demand signaling](https://docs.torus.network/explanations/builders/demand-signaling/) capability coordination and economic incentives. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/builders/manage-capabilities.mdx b/src/content/docs/how-to-guides/builders/manage-capabilities.mdx index 71661f1..cce89f1 100644 --- a/src/content/docs/how-to-guides/builders/manage-capabilities.mdx +++ b/src/content/docs/how-to-guides/builders/manage-capabilities.mdx @@ -3,12 +3,17 @@ title: Manage Capabilities description: Step-by-step guide to creating, editing, and managing capabilities in the Torus control space. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; - -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import confirmCapability from "/public/images/how-to-guide/manage-capabilities/create-capability-confirm-information.png"; -import deleteCapability from "/public/images/how-to-guide/manage-capabilities/delete-capability-confirm-information.png"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; + +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import confirmCapability from '/public/images/how-to-guide/manage-capabilities/create-capability-confirm-information.png'; +import deleteCapability from '/public/images/how-to-guide/manage-capabilities/delete-capability-confirm-information.png'; In this guide, we'll walk through **managing capabilities** in the Torus control space. Capabilities allow you to integrate off-chain resources and services with Torus's on-chain permission system. @@ -19,24 +24,25 @@ Managing capabilities means taking deliberate control over what your agent can d By creating capability paths, you define the exact functions your agent exposes, enabling collaboration through delegated permissions. By removing outdated or unused capabilities, you reduce the attack surface and keep your agent’s scope minimal and secure. + #### What we will accomplish - [Register a capability path](#register-a-capability-path) - [Delete a capability path](#delete-a-capability-path) - + ## Prerequisites - You must have a registered agent on Torus. Follow the [agent registration - guide](https://docs.torus.network/how-to-guides/builders/register-an-agent/) - if needed. + You must have a registered agent on Torus. + Follow the [agent registration guide](https://docs.torus.network/how-to-guides/builders/register-an-agent/) if needed. - Ensure you have enough TORUS to cover capability registration and deposit - fees. + Ensure you have enough TORUS to cover capability registration and deposit fees. @@ -56,50 +62,53 @@ By removing outdated or unused capabilities, you reduce the attack surface and k - The `agent-name` is your registered agent name _(pre-filled and uneditable)_. - The `capability-path` is the custom route you define (e.g. `tokens`, `profile_data`, etc.). - + + - `example-agent.tokens-.[method]` ❌ _(Invalid. **Hyphen** at the end of capability path)_ + - `example-agent.Tokens.[method]` ❌ _(Invalid. **Uppercase** letter in capability path)_ + - `example-agent.tokens!.[method]` ❌ _(Invalid. **Special character** `!` not allowed)_ + - `example-agent tokens[method]` ❌ _(Invalid. **Space** in capability path)_ + + 4. **Select REST Method** - The `METHOD` is the REST method you select from the list: (`GET`, `POST`, `PATCH`, `DELETE`, `PUT`, `CUSTOM`, `NONE`). - - -5. **Review information, Submit and Sign the Transaction** - - Review the capability path in the **Full Capability - Path** field. If everything is correct, click **Create Capability**. Open the - SubWallet extension and - sign the transaction - - . - - -6. **All Done** + The `METHOD` is the REST method you select from the list: (`GET`, `POST`, `PATCH`, `DELETE`, `PUT`, `CUSTOM`, `NONE`). + + +5. **Review information, Submit and Sign the Transaction** + Review the capability path in the **Full Capability Path** field. + If everything is correct, click **Create Capability**. + Open the SubWallet extension and sign the transaction. + + +6. **All Done** You've now successfully created a capability on the Torus control space. - Now you can delegate permissions to it. - + Now you can delegate permissions to it. + ## Delete a Capability path @@ -113,43 +122,36 @@ By removing outdated or unused capabilities, you reduce the attack surface and k 3. **Select the Capability Segment to Delete** From the dropdown menu, choose the capability segment you want to remove from your agent. - + Capabilities are structured in segments like: **`agent.your-agent-name.test-path.get.depth.add.delete`** -4. **Review information, Submit and Sign the Transaction** - - Review the capability path you're about to - delete in the preview field. If you're certain you want to proceed, click **Delete - Capability**. Open the SubWallet extension and - sign the transaction - - . - +4. **Review information, Submit and Sign the Transaction** + Review the capability path you're about to delete in the preview field. + If you're certain you want to proceed, click **Delete Capability**. + Open the SubWallet extension and sign the transaction. + -5. **All Done** +5. **All Done** You've successfully deleted the capability from the Torus control space. Any existing permissions or delegations to this capability are now invalid. @@ -164,13 +166,10 @@ Now that you can manage capabilities, you might want to: - **Create demand signals**: Signal for [specific capabilities](https://docs.torus.network/how-to-guides/builders/create-signal/) you need from other agents Connect with the community: - - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [recursive delegation](https://docs.torus.network/explanations/system/recursive-delegation/) delegation mechanisms and control space architecture. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/builders/manage-your-agent.mdx b/src/content/docs/how-to-guides/builders/manage-your-agent.mdx index 4160a30..f81b9af 100644 --- a/src/content/docs/how-to-guides/builders/manage-your-agent.mdx +++ b/src/content/docs/how-to-guides/builders/manage-your-agent.mdx @@ -3,20 +3,24 @@ title: Manage your Agent description: Update your agent's details, social links, and technical information. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import manageAgentTab from "/public/images/how-to-guide/agent-management/click-on-manage-agent-tab.png"; -import clickDeregisterTab from "/public/images/how-to-guide/agent-management/click-on-deregister-agent.png"; -In this guide, we'll walk through the process of **managing your Agent information** with the Torus Allocator. -Both the **Registered Agent** and **Root Agent** can manage their information. +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import manageAgentTab from '/public/images/how-to-guide/agent-management/click-on-manage-agent-tab.png'; +import clickDeregisterTab from '/public/images/how-to-guide/agent-management/click-on-deregister-agent.png'; + - - Just make sure to use the proper filter on the Allocator tab - -. In this guide we will be managing the information of a **Registered Agent**. +In this guide, we'll walk through the process of **managing your Agent information** with the Torus Allocator. +Both the **Registered Agent** and **Root Agent** can manage their information. +Just make sure to use the proper filter on the Allocator tab. +In this guide we will be managing the information of a **Registered Agent**. #### Why manage your agent? @@ -28,62 +32,56 @@ and ensures your agent represents your current capabilities and offerings. - [Edit your agent information](#edit-your-agent-information) - [De-register your agent](#de-register-your-agent) - + ## Prerequisites - Make sure you have a Torus wallet set up and ready to use. You can find a - [guide on how to set up a wallet - here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). + Make sure you have a Torus wallet set up and ready to use. + You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). - Check your balance in the [Torus Wallet](https://wallet.torus.network) and - ensure you have enough **Free Balance** to cover the registration fees. You - can find a [guide on how to bridge TORUS - here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + Check your balance in the [Torus Wallet](https://wallet.torus.network) and ensure you have enough **Free Balance** to cover the registration fees. + You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). You must have a Registered or Root Agent to manage your information. - + + ## Edit your Agent Information 1. **Visit the [Manage Agent Tab in the Torus Portal](https://torus.network/network-operations/manage-agent)** - Ensure you're connected with the agent wallet that owns the agent you want to manage. - -{" "} - - -2. **Edit the information and Submit** - You can edit the following information: - ```md - # Short Description - - # Description - - # Technical Information - - - Website URL - - API Endpoint URL - - Agent Icon - - # Social Links - - - Discord - - Twitter - - GitHub - - Telegram - ``` -3. **Sign the Transaction in the SubWallet and Wait for the Confirmation** - You will be prompted by SubWallet to sign the on-chain transaction. - Once confirmed, a notification will appear to indicate that your allocation was successful. + Ensure you're connected with the agent wallet that owns the agent you want to manage. + + + +2. **Edit the information and Submit** + You can edit the following information: + ```md + # Short Description + # Description + # Technical Information + - Website URL + - API Endpoint URL + - Agent Icon + # Social Links + - Discord + - Twitter + - GitHub + - Telegram + ``` +3. **Sign the Transaction in the SubWallet and Wait for the Confirmation** + You will be prompted by SubWallet to sign the on-chain transaction. + 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://torus.network/root-allocator). + You can now see your updated information in the [Allocator Tab](https://torus.network/root-allocator). @@ -91,68 +89,48 @@ and ensures your agent represents your current capabilities and offerings. -1. **Visit the [Manage Agent Tab in the Torus Portal](https://torus.network/network-operations/manage-agent)** - - - Ensure you're connected with the agent wallet - that owns the agent you want to manage.{" "} +1. **Visit the [Manage Agent Tab in the Torus Portal](https://torus.network/network-operations/manage-agent)** + Ensure you're connected with the agent wallet that owns the agent you want to manage. 2. **Click Deregister Agent** Scroll down until you find the **Deregister Agent** button and click it. - 3. **Complete the De-registration Form** The form will display a comprehensive warning about the permanent nature of this action: - **Permissions Warning**: You can only de-register if you have NO active namespace permissions being delegated. You must manually revoke all delegated permissions first. - + **You will permanently lose:** - - - All registered namespaces — all capability - paths will be deleted - - - Ability to create new namespace or stream delegations - - - Delegated permissions — all permissions granted - to/from your agent will be revoked + - All registered namespaces — all capability paths will be deleted + - Ability to create new namespace or stream delegations + - Delegated permissions — all permissions granted to/from your agent will be revoked - Agent name — you CAN reuse this name if you re-register later **Required Confirmations:** Before proceeding, you must confirm you understand: - - ✓ This action is permanent and irreversible - ✓ I have manually revoked ALL delegated namespace permissions - - ✓ I have backed up any important data or configurations + - ✓ I have backed up any important data or configurations - ✓ I understand I can re-register with the same name later, but it will be treated as a completely new agent **Final Confirmation:** - - - Type your agent name exactly as it appears - to confirm deletion. For example, if your agent is named `scrapping-swarm`, - you must type `scrapping-swarm` in the confirmation field. - + Type your agent name exactly as it appears to confirm deletion. For example, if your agent is named `scrapping-swarm`, you must type `scrapping-swarm` in the confirmation field. + -4. **Review information, Submit and Sign the Transaction** - - Review the agent information you're about to - de-register in the preview field. If you're certain you want to proceed, click - **De-register Agent**. Open the SubWallet extension and - sign the transaction - - . +4. **Review information, Submit and Sign the Transaction** + Review the agent information you're about to de-register in the preview field. + If you're certain you want to proceed, click **De-register Agent**. + Open the SubWallet extension and sign the transaction. -5. **All Done** +5. **All Done** You've successfully de-registered the agent from Torus. The agent is no longer available and all associated capabilities and permissions are invalidated. @@ -167,14 +145,11 @@ Now that you can manage your agent, you might want to: - **Build agent services**: Create an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide APIs that utilize your registered capabilities - **Create demand signals**: Signal for [specific capabilities](https://docs.torus.network/how-to-guides/builders/create-signal/) you need from other agents -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [agent managing](https://docs.torus.network/explanations/builders/agent-managing/) update mechanics and storage architecture. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/builders/register-an-agent.mdx b/src/content/docs/how-to-guides/builders/register-an-agent.mdx index 04852ee..ae3d6f1 100644 --- a/src/content/docs/how-to-guides/builders/register-an-agent.mdx +++ b/src/content/docs/how-to-guides/builders/register-an-agent.mdx @@ -8,15 +8,15 @@ import { Aside, CardGrid, Card, - LinkCard, + LinkCard } from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import registerAnAgentButton from "/public/images/how-to-guide/register-an-agent/register-an-agent-button.png"; -import connectWalletOnPortal from "/public/images/how-to-guide/register-an-agent/connect-wallet-on-portal.png"; -import filledAgentInformation from "/public/images/how-to-guide/register-an-agent/filled-agent-information.png"; -import filledAgentSocials from "/public/images/how-to-guide/register-an-agent/filled-agent-socials.png"; -import registeredAgents from "/public/images/how-to-guide/register-an-agent/registered-agent-on-allocator-page.png"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import registerAnAgentButton from '/public/images/how-to-guide/register-an-agent/register-an-agent-button.png'; +import connectWalletOnPortal from '/public/images/how-to-guide/register-an-agent/connect-wallet-on-portal.png'; +import filledAgentInformation from '/public/images/how-to-guide/register-an-agent/filled-agent-information.png'; +import filledAgentSocials from '/public/images/how-to-guide/register-an-agent/filled-agent-socials.png'; +import registeredAgents from '/public/images/how-to-guide/register-an-agent/registered-agent-on-allocator-page.png'; In this guide, we'll **register an Agent** on Torus. This is a step-by-step walkthrough of the registration process. @@ -32,27 +32,27 @@ Registering an agent makes you discoverable in Torus and enables you to receive - Registering an agent does not prevent you from also becoming a Root Agent — both processes are independent and can be completed in parallel. - You can follow the [guide to become a Root Agent here](https://docs.torus.network/how-to-guides/goal-leaders/become-a-root-agent/). - + + #### What we will accomplish - Register an Agent on Torus - + ## Prerequisites - Make sure you have a Torus wallet set up and ready to use. You can find a - [guide on how to set up a wallet - here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). + Make sure you have a Torus wallet set up and ready to use. + You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). - Check your balance in the [Torus Wallet](https://wallet.torus.network) and - ensure you have enough Free Balance to cover the registration fees. You can - find a [guide on how to bridge TORUS - here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + Check your balance in the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees. + You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). @@ -60,76 +60,70 @@ Registering an agent makes you discoverable in Torus and enables you to receive -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. - - - -2. **Connect your Torus Wallet** - Click the **Connect Wallet** button at the top right and select your Torus wallet. - - - -3. **Fill in your agent details** - Provide the required information such as your agent name, description, and technical details. - - - - - - -4. **Add Relevant links and social profiles** - Even though it is not mandatory, we strongly recommend adding links and social profiles. - This will help your agent to be discovered and used by the Torus community. - - - -5. **Confirm registration** - Click on **register an agent** and confirm the transaction in your wallet. - - - -6. **Check your Agent on the [Allocator tab](https://torus.network/root-allocator?isWhitelisted=false)** - You should find your agent on the Allocator tab, with the filter of **Registered Agents**. - - - -7. **All Done** - You've now successfully registered an Agent on Torus. - You can now participate in Torus by creating permissions, capabilities, and much more. + ## What's Next? Now that you're a registered agent, you can: @@ -138,14 +132,12 @@ Now that you're a registered agent, you can: - **Connect with others**: Use an [agent client](https://docs.torus.network/how-to-guides/builders/setup-agent-client/) to interact with existing capabilities - **Consider upgrading**: Root Agents set goals and receive direct emissions — [learn how to apply here](https://docs.torus.network/how-to-guides/goal-leaders/become-a-root-agent/) if that matches your vision. -Connect with the community: + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [agent registration](https://docs.torus.network/explanations/builders/agent-registration/) economics, burn mechanisms, and discovery. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/builders/setup-agent-client.mdx b/src/content/docs/how-to-guides/builders/setup-agent-client.mdx index 79471f2..c28cb33 100644 --- a/src/content/docs/how-to-guides/builders/setup-agent-client.mdx +++ b/src/content/docs/how-to-guides/builders/setup-agent-client.mdx @@ -3,8 +3,13 @@ title: Setup Agent Client description: Step-by-step guide to interact with Agent APIs using the AgentClient class from torus-ts-sdk. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; -import RedText from "/src/components/RedText.astro"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; +import RedText from '/src/components/RedText.astro'; In this guide, we'll **setup an agent client** to interact with agent APIs with automatic authentication. @@ -19,7 +24,9 @@ Agent clients allow you to easily communicate with other agents' APIs, enabling - Make authenticated API calls - Handle responses and errors - + ## Prerequisites @@ -28,8 +35,7 @@ Agent clients allow you to easily communicate with other agents' APIs, enabling Have Node.js installed and a basic understanding of TypeScript. - You need a registered or whitelisted agent with access to its mnemonic - phrase for authentication. + You need a registered or whitelisted agent with access to its mnemonic phrase for authentication. @@ -70,7 +76,7 @@ Agent clients allow you to easily communicate with other agents' APIs, enabling } const keypair = new Keypair(process.env.AGENT_MNEMONIC); - + const client = new AgentClient({ keypair, baseUrl: process.env.TARGET_AGENT_URL || "http://localhost:3000", @@ -91,7 +97,7 @@ Agent clients allow you to easily communicate with other agents' APIs, enabling async function callAgent(client: AgentClient, endpoint: string, data: any) { try { console.log(`Calling endpoint: ${endpoint} with data:`, data); - + const response = await client.call({ endpoint, data, @@ -118,20 +124,21 @@ Agent clients allow you to easily communicate with other agents' APIs, enabling try { // Initialize the client const client = await createClient(); - + // Make API calls - const helloResponse = await callAgent(client, "hello", { - name: "Alice", + const helloResponse = await callAgent(client, "hello", { + name: "Alice" }); - + console.log("Hello response:", helloResponse); - + // You can make multiple calls - const anotherResponse = await callAgent(client, "hello", { - name: "Bob", + const anotherResponse = await callAgent(client, "hello", { + name: "Bob" }); - + console.log("Another response:", anotherResponse); + } catch (error) { console.error("Application failed:", error); process.exit(1); @@ -155,14 +162,12 @@ Now that you can communicate with other agents, you might want to: - **Build your own API**: Set up an [agent server](https://docs.torus.network/how-to-guides/builders/setup-agent-server/) to provide capabilities to others - **Signal for needs**: Create [demand signals](https://docs.torus.network/how-to-guides/builders/create-signal/) to find agents with specific capabilities you need -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news + +Learn about [agent client](https://docs.torus.network/explanations/builders/agent-client/) communication patterns and security. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/builders/setup-agent-server.mdx b/src/content/docs/how-to-guides/builders/setup-agent-server.mdx index 3c7376b..4fe809f 100644 --- a/src/content/docs/how-to-guides/builders/setup-agent-server.mdx +++ b/src/content/docs/how-to-guides/builders/setup-agent-server.mdx @@ -3,8 +3,13 @@ title: Setup Agent Server description: Step-by-step guide to build APIs with the Agent class from @torus-network/sdk. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; -import RedText from "/src/components/RedText.astro"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; +import RedText from '/src/components/RedText.astro'; In this guide, we'll **setup an agent server** to build authenticated APIs with automatic OpenAPI documentation. @@ -19,7 +24,9 @@ Agent servers allow you to create APIs that other agents can discover and intera - Add authenticated endpoints - Generate automatic API documentation - + ## Prerequisites @@ -28,9 +35,8 @@ Agent servers allow you to create APIs that other agents can discover and intera Have Node.js installed and a basic understanding of TypeScript. - You need a registered agent to create server APIs. You can find a [guide on - how to register an agent - here](https://docs.torus.network/how-to-guides/builders/register-an-agent/). + You need a registered agent to create server APIs. + You can find a [guide on how to register an agent here](https://docs.torus.network/how-to-guides/builders/register-an-agent/). @@ -129,20 +135,19 @@ Agent servers allow you to create APIs that other agents can discover and intera try { const agent = await createAgent(); await setupEndpoints(agent); - + agent.run(); - + const port = process.env.PORT || 3000; console.log(`Agent server running on http://localhost:${port}`); - console.log( - `API documentation available at http://localhost:${port}/docs`, - ); - + console.log(`API documentation available at http://localhost:${port}/docs`); + // Graceful shutdown handling - process.on("SIGTERM", () => { - console.log("Received SIGTERM, shutting down gracefully"); + process.on('SIGTERM', () => { + console.log('Received SIGTERM, shutting down gracefully'); process.exit(0); }); + } catch (error) { console.error("Failed to start server:", error); process.exit(1); @@ -166,14 +171,11 @@ Now that you have an agent server running, you might want to: - **Connect with other agents**: Set up an [agent client](https://docs.torus.network/how-to-guides/builders/setup-agent-client/) to consume other APIs - **Signal for capabilities**: Create [demand signals](https://docs.torus.network/how-to-guides/builders/create-signal/) to find specialized services -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [agent server](https://docs.torus.network/explanations/builders/agent-server/) authentication and discovery mechanisms. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/goal-leaders/become-a-root-agent.mdx b/src/content/docs/how-to-guides/goal-leaders/become-a-root-agent.mdx index fcb3089..0a9c9d2 100644 --- a/src/content/docs/how-to-guides/goal-leaders/become-a-root-agent.mdx +++ b/src/content/docs/how-to-guides/goal-leaders/become-a-root-agent.mdx @@ -3,11 +3,17 @@ title: Become a Root Agent description: Applying to become a root agent on Torus. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import daoShapeTheNetwork from "/public/images/how-to-guide/become-a-root-agent/dao-shape-the-network.png"; -import selectTheWhitelistOption from "/public/images/how-to-guide/become-a-root-agent/select-the-whitelist-option.png"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import daoShapeTheNetwork from '/public/images/how-to-guide/become-a-root-agent/dao-shape-the-network.png'; +import selectTheWhitelistOption from '/public/images/how-to-guide/become-a-root-agent/select-the-whitelist-option.png'; + In this guide, we'll walk through how to **apply to become a Root Agent** on Torus. This is a step-by-step overview of the application process. @@ -17,34 +23,31 @@ This is a step-by-step overview of the application process. Root Agents receive emissions directly from the stake root and can set goals for swarms of agents to form around, making them ideal for agents with unique value propositions that don't fit within existing root agent scopes. #### What we will accomplish - Apply to become a Root Agent - + ## Prerequisites - Make sure you have a Torus wallet set up and ready to use. You can find a - [guide on how to set up a wallet - here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). + Make sure you have a Torus wallet set up and ready to use. + You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). - Check your balance on the [Torus Wallet](https://wallet.torus.network) and - ensure you have enough Free Balance to cover the registration fees. You can - find a [guide on how to bridge TORUS - here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + Check your balance on the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees. + You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). Have a valid Discord account and join the official [Torus Discord @@ -52,55 +55,51 @@ Root Agents receive emissions directly from the stake root and can set goals for + ## Apply to Whitelist an Agent -1. **Visit the [Whitelist Applications Page](https://dao.torus.network/whitelist-applications)** +1. **Visit the [Whitelist Applications Page](https://dao.torus.network/whitelist-applications)** The Whitelist Application page is found in the DAO page. -2. **Connect your Torus Wallet** - Click the **Connect Wallet** button at the top right and select your Torus wallet. +2. **Connect your Torus Wallet** + Click the **Connect Wallet** button at the top right and select your Torus wallet. -3. **Click on Shape the Network Button** +3. **Click on Shape the Network Button** It is located in the top right corner of the dashboard. It will open a modal with a form to apply for whitelisting. - -4. **Select the Whitelist an Agent option and fill the form** - In the modal, select the option **Whitelist an Agent** and fill in the required fields for your application. +4. **Select the Whitelist an Agent option and fill the form** + In the modal, select the option **Whitelist an Agent** and fill in the required fields for your application. In this step, you must validate your **Discord Account** in order to apply. - - -5. **Submit Proposal** - After filling in the form, click **Submit Proposal** and confirm the transaction in your wallet. + +5. **Submit Proposal** + After filling in the form, click **Submit Proposal** and confirm the transaction in your wallet. -6. **All Done** - You've now successfully Applied to Whitelist an Agent on Torus. - Now you must wait for DAO members to review your application. - You can follow the process through the [Whitelist DAO Page](https://dao.torus.network/whitelist-applications) - + +6. **All Done** + You've now successfully Applied to Whitelist an Agent on Torus. + Now you must wait for DAO members to review your application. + You can follow the process through the [Whitelist DAO Page](https://dao.torus.network/whitelist-applications) + + ## What's Next? @@ -109,14 +108,11 @@ After submitting your Root Agent application: - **Join the community**: Be active in [Discord](https://discord.gg/w3HVm6W9XH) to share updates about your agent. - **Check application status**: Monitor [DAO whitelist applications](https://dao.torus.network/whitelist-applications) for voting progress -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/goal-leaders/create-emission-proposal.mdx b/src/content/docs/how-to-guides/goal-leaders/create-emission-proposal.mdx index 71635a6..2c1d7ad 100644 --- a/src/content/docs/how-to-guides/goal-leaders/create-emission-proposal.mdx +++ b/src/content/docs/how-to-guides/goal-leaders/create-emission-proposal.mdx @@ -8,10 +8,10 @@ import { Aside, CardGrid, Card, - LinkCard, + LinkCard } from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; In this guide, we’ll walk through **submitting an emission proposal** via the Torus DAO. @@ -19,17 +19,16 @@ In this guide, we’ll walk through **submitting an emission proposal** via the - You need at least 10 000 TORUS in your wallet to create proposals. See [how - to get - TORUS](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + You need at least 10 000 TORUS in your wallet to create proposals. + See [how to get TORUS](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). - Understand how your changes will affect network economics and incentives. - Review the [emission proposals - explanation](https://docs.torus.network/explanations/goal-leaders/emission-proposals/). + Understand how your changes will affect network economics and incentives. + Review the [emission proposals explanation](https://docs.torus.network/explanations/goal-leaders/emission-proposals/). + ## Create an Emission Proposal @@ -49,66 +48,62 @@ In this guide, we’ll walk through **submitting an emission proposal** via the 5. **Configure Emission Parameters** Set the three key percentage parameters across two distribution pools: - + **Burn Distribution (up to 100% total):** - - **Recycling Percentage**: Portion of fees burned through recycling - **Treasury Percentage**: Portion allocated to network treasury - + **Reward Distribution (up to 100% total):** - - **Incentives Ratio**: Portion for incentive programs and rewards - + 6. **Add Proposal Details** Provide comprehensive information about your proposal: - + - **Title**: Clear, descriptive name for the proposal - **Description**: Detailed explanation of the economic rationale, why these specific percentages benefit the network... - + 7. **Review and Submit** Double-check all parameters and details before submission. Click **"Submit Proposal"** and confirm the transaction in your wallet. 8. **Share with the community** - After submitting, post your proposal in Discord, Telegram, or other channels to spark discussion and encourage voting. - + After submitting, post your proposal in Discord, Telegram, or other channels to spark discussion and encourage voting. -9. **All done when either** - - - The 7‑day voting window ends. - - ≥ 50 % support & > 10 % participation: proposal executes on‑chain. - - ≤ 50 % support & > 10 % participation: proposal get denied. +9. **All done when either** + - The 7‑day voting window ends. + - ≥ 50 % support & > 10 % participation: proposal executes on‑chain. + - ≤ 50 % support & > 10 % participation: proposal get denied. Therefore, make sure to follow the voting process closely. + + + ## What's Next? After submitting your emission proposal: - - **Community Discussion**: Engage with feedback and questions from other community members Connect with the community during the process: - **[Discord](https://discord.gg/w3HVm6W9XH)** — Discuss proposal details and economic implications -- **[Telegram](https://t.me/torusnetwork)** — Share updates and gather community sentiment +- **[Telegram](https://t.me/torusnetwork)** — Share updates and gather community sentiment - **[Twitter](https://x.com/torus_network)** — Announce your proposal to the broader ecosystem diff --git a/src/content/docs/how-to-guides/goal-leaders/request-dao-treasury-transfer.mdx b/src/content/docs/how-to-guides/goal-leaders/request-dao-treasury-transfer.mdx index 542c523..596b7ef 100644 --- a/src/content/docs/how-to-guides/goal-leaders/request-dao-treasury-transfer.mdx +++ b/src/content/docs/how-to-guides/goal-leaders/request-dao-treasury-transfer.mdx @@ -3,10 +3,15 @@ title: Request DAO Treasury Transfer description: Step-by-step guide to requesting TORUS funding from the DAO Treasury for building projects and initiatives. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; In this guide, we'll walk through the process of **requesting a transfer from the DAO Treasury** to fund your building projects or initiatives. @@ -20,20 +25,20 @@ DAO Treasury transfers provide essential funding for builders who need capital t - Submit a proposal to request TORUS from the DAO Treasury - + ## Prerequisites - You must have a Torus wallet set up with sufficient balance to cover the - proposal cost. You can find a [guide on how to set up a wallet - here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). + You must have a Torus wallet set up with sufficient balance to cover the proposal cost. + You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). - Ensure you have at least **10,000 TORUS** in your wallet to cover the - proposal cost. You can find a [guide on how to bridge TORUS - here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + Ensure you have at least **10,000 TORUS** in your wallet to cover the proposal cost. + You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). @@ -44,12 +49,10 @@ DAO Treasury transfers provide essential funding for builders who need capital t 1. **Visit the [Proposals Tab in the DAO Governance Portal](https://dao.torus.network/proposals)** Navigate to the **Shape the Network** section in the Torus DAO Portal. -2. **Connect your Wallet** - - Ensure you're connected with a wallet that - has at least 10,000 TORUS for the proposal cost. +2. **Connect your Wallet** + Ensure you're connected with a wallet that has at least 10,000 TORUS for the proposal cost. -3. **Click in Shape the Network** +3. **Click in Shape the Network** It can be found in the top right corner of the page. 4. **Select "Transfer DAO Treasury" Type** @@ -57,47 +60,44 @@ DAO Treasury transfers provide essential funding for builders who need capital t 5. **Complete the Transfer Request Form** Fill out the required information: - + ```md # Destination - [Enter the wallet address where funds should be sent] - - # Value - + + # Value [Specify the amount in TORUS you're requesting] - + # Application Title - [Provide a clear, descriptive title for your project] - + # Application Body - [Write a detailed explanation including: - - Project overview and objectives - - How it benefits the Torus ecosystem + - How it benefits the Torus ecosystem - Timeline and milestones - Budget breakdown and justification - Your background and qualifications] ``` - -6. **Submit and Sign the Transaction** +5. **Submit and Sign the Transaction** The proposal cost is **10,000 TORUS** which will be deducted from your connected wallet. Review all information carefully, then click **Submit Proposal**. Open the SubWallet extension and sign the transaction to pay the proposal cost. -7. **All Done** +6. **All Done** You've successfully submitted a proposal to request TORUS from the DAO Treasury. Now you must wait for community feedback and voting. + + + + ## What's Next? After submitting your treasury request: @@ -107,13 +107,10 @@ After submitting your treasury request: - **Direct Treasury Address**: `5EYCAe5jXm8DLvvQ2YjbsmnoMpDHAfokKZfg12KzGSSAzM4D` Connect with the community: - - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [DAO Treasury mechanisms](https://docs.torus.network/explanations/goal-leaders/dao-treasury/) and governance processes. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/holders/bridge-from-base.mdx b/src/content/docs/how-to-guides/holders/bridge-from-base.mdx index d9edaa7..95104ee 100644 --- a/src/content/docs/how-to-guides/holders/bridge-from-base.mdx +++ b/src/content/docs/how-to-guides/holders/bridge-from-base.mdx @@ -3,18 +3,23 @@ title: Bridge TORUS from Base to Torus 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 metamaskSubwalletConnect from "/public/images/how-to-guide/bridge-to-base/metamask-subwallet-connect.png"; -import fillInFormToConvert from "/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert.png"; -import confirmTransactionInMetamask from "/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask.png"; -import baseTorusSwappedSuccessfully from "/public/images/how-to-guide/bridge-to-base/base-torus-swapped-successfully.png"; -import metamaskConnectEvm from "/public/images/how-to-guide/bridge-to-base/metamask-connect-evm.png"; -import fillInFormToConvertTorusEvmNativeTorus from "/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert-torus-evm-native-torus.png"; -import confirmTransactionInMetamaskTorusEvmToTorus from "/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask-torus-evm-to-torus.png"; -import torusEvmConvertSuccessfully from "/public/images/how-to-guide/bridge-to-base/torus-evm-convert-successfully.png"; -import connectedToTorusEvm from "/public/images/how-to-guide/bridge-to-base/connected-to-torus-evm.png"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import metamaskSubwalletConnect from '/public/images/how-to-guide/bridge-to-base/metamask-subwallet-connect.png'; +import fillInFormToConvert from '/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert.png'; +import confirmTransactionInMetamask from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask.png'; +import baseTorusSwappedSuccessfully from '/public/images/how-to-guide/bridge-to-base/base-torus-swapped-successfully.png'; +import metamaskConnectEvm from '/public/images/how-to-guide/bridge-to-base/metamask-connect-evm.png'; +import fillInFormToConvertTorusEvmNativeTorus from '/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert-torus-evm-native-torus.png'; +import confirmTransactionInMetamaskTorusEvmToTorus from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask-torus-evm-to-torus.png'; +import torusEvmConvertSuccessfully from '/public/images/how-to-guide/bridge-to-base/torus-evm-convert-successfully.png'; +import connectedToTorusEvm from '/public/images/how-to-guide/bridge-to-base/connected-to-torus-evm.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. @@ -30,7 +35,9 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU - Bridge TORUS on Base to TORUS EVM - Bridge from TORUS EVM to TORUS - + --- @@ -52,59 +59,45 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU --- + + ## Steps for the Bridge Process ### Bridge BASE Torus to Torus EVM -1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**. +1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**. At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**. + - - -2. **Swap from Base TORUS to Torus EVM** - - - Make sure you are **connected** to **both wallets** - - Make sure you are on the **correct tab**, **TORUS EVM - Base** - - Make sure it is FROM **Base TORUS** TO **Torus EVM** - +2. **Swap from Base TORUS to Torus EVM** + - Make sure you are **connected** to **both wallets** + - Make sure you are on the **correct tab**, **TORUS EVM - Base** + - Make sure it is FROM **Base TORUS** TO **Torus EVM** + 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. With all the information filled in, click **Continue**. - + -3. **Confirm the transaction** +3. **Confirm the transaction** After filling in the form, you will be prompted to confirm the transaction in Metamask. - - + 4. **Confirmation of the swap** After the transaction succeeds, your Base TORUS should now be displayed as Torus EVM as it was successfully swapped. This process can take a while to complete on the blockchain, - so please wait a few minutes and refresh the page. - + so please wait a few minutes and refresh the page. + + @@ -117,22 +110,19 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**. + 2. **Verify you're connected to Torus EVM** Make sure MetaMask is connected to the Torus EVM network. You should see "Torus EVM" in your MetaMask network dropdown. - - - + + + 3. **Swap from Torus EVM to Torus** - - Make sure you are **connected** in **Both Wallets** - Make sure you are in the **correct Tab**, **TORUS EVM - Base** - Make sure it is FROM**Torus EVM** TO **Torus** Fill in the form with the amount you want to convert, after confirmation, you will be prompted to sign the transaction in Torus. - - + 4. **Confirm the transaction** After filling in the form, you will be prompted to confirm the transaction in Metamask. - - - + + 5. **Confirmation of the swap** After the transaction succeeds, your Torus EVM should now be displayed as TORUS as it was successfully swapped. This process can take a while to complete on the blockchain, - so please wait a few minutes and refresh the page. + so please wait a few minutes and refresh the page. + - +4. **All Done** + You've now successfully bridged TORUS tokens between **Torus**, **Torus EVM**, and **Base**. + You can view your updated balances directly in the [Torus Web App](https://wallet.torus.network) or SubWallet. + -6. **All Done** - You've now successfully bridged TORUS tokens between **Torus**, **Torus EVM**, and **Base**. - You can view your updated balances directly in the [Torus Web App](https://wallet.torus.network) or SubWallet. - ## What's Next? @@ -194,8 +170,7 @@ Now that you have TORUS tokens, you can: - **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: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/holders/bridge-your-torus.mdx b/src/content/docs/how-to-guides/holders/bridge-your-torus.mdx index 80fda69..432247e 100644 --- a/src/content/docs/how-to-guides/holders/bridge-your-torus.mdx +++ b/src/content/docs/how-to-guides/holders/bridge-your-torus.mdx @@ -3,11 +3,16 @@ 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"; +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. @@ -24,9 +29,11 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU #### What we will accomplish - Bridge TORUS from Base to TORUS in one streamlined process -- Bridge TORUS from Torus back to Base (bidirectional support) +- Bridge TORUS from Torus back to Base (bidirectional support) - + --- @@ -48,53 +55,49 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU --- + + ## Steps for the Bridge Process 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**. - 2. **Swap from Base TORUS to TORUS** - - - Make sure you are **connected** to **both wallets** - - Make sure it is FROM **Base TORUS** TO **TORUS** + - Make sure you are **connected** to **both wallets** + - Make sure it is FROM **Base TORUS** TO **TORUS** Fill in the amount you want to convert, then click **Submit Base to Torus transaction**. -3. **Add Torus EVM network to MetaMask** +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. -4. **Sign both transactions in MetaMask** +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. 5. **Confirmation of the swap** @@ -106,6 +109,7 @@ If the automatic network switch fails, manually add Torus EVM to MetaMask: + --- ## Bridging from TORUS to Base TORUS @@ -130,11 +134,12 @@ If a transaction fails or something goes wrong during the bridging process, your 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. - --- + + ## What's Next? Now that you have TORUS tokens, you can: @@ -144,8 +149,7 @@ Now that you have TORUS tokens, you can: - **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: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/holders/fast-bridge.mdx b/src/content/docs/how-to-guides/holders/fast-bridge.mdx index 57bf688..5e7535d 100644 --- a/src/content/docs/how-to-guides/holders/fast-bridge.mdx +++ b/src/content/docs/how-to-guides/holders/fast-bridge.mdx @@ -1,13 +1,18 @@ --- -title: Fast Bridge +title: Fast Bridge 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/connect-both-wallets.png"; -import bridgeMechanisms from "/public/images/how-to-guide/simple-bridge/bridge-mecannisms.png"; +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/connect-both-wallets.png'; +import bridgeMechanisms from '/public/images/how-to-guide/simple-bridge/bridge-mecannisms.png'; In this guide, we'll **bridge TORUS between Torus and Base** using the Fast Bridge method. This process is necessary in order to obtain **Native TORUS**, which is required to interact with Torus directly. @@ -24,9 +29,11 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU #### What we will accomplish - Bridge TORUS from Base to TORUS in one streamlined process -- Bridge TORUS from Torus back to Base (bidirectional support) +- Bridge TORUS from Torus back to Base (bidirectional support) - + --- @@ -48,53 +55,49 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU --- + + ## Steps for the Bridge Process 1. **Connect both the Torus and MetaMask wallets in the [Fast Bridge Web App](https://bridge.torus.network/?tab=simple&from=base&to=torus)**. At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**. - 2. **Swap from Base TORUS to TORUS** - - - Make sure you are **connected** to **both wallets** - - Make sure it is FROM **Base TORUS** TO **TORUS** + - Make sure you are **connected** to **both wallets** + - Make sure it is FROM **Base TORUS** TO **TORUS** Fill in the amount you want to convert, then click **Submit Base to Torus transaction**. -3. **Add Torus EVM network to MetaMask** +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. -4. **Sign both transactions in MetaMask** +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. 5. **Confirmation of the swap** @@ -110,7 +113,6 @@ If the automatic network switch fails, manually add Torus EVM to MetaMask: **If the process fails mid-transaction:** 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. - --- @@ -126,6 +128,8 @@ Everything else remains the same - you'll still need to approve adding the Torus --- + + ## What's Next? Now that you have TORUS tokens, you can: @@ -135,8 +139,7 @@ Now that you have TORUS tokens, you can: - **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://portal.torus.network/) - **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/explanations/holders/tokenomics/) and emission mechanisms -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/holders/setup-a-wallet.mdx b/src/content/docs/how-to-guides/holders/setup-a-wallet.mdx index 262240c..4ff78d4 100644 --- a/src/content/docs/how-to-guides/holders/setup-a-wallet.mdx +++ b/src/content/docs/how-to-guides/holders/setup-a-wallet.mdx @@ -8,17 +8,17 @@ import { Aside, CardGrid, LinkCard, - Card, + Card } from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import subwalletExtensionActivated from "/public/images/how-to-guide/setup-wallet/subwallet-extension-activated.png"; -import subwalletCreatedSuccessfully from "/public/images/how-to-guide/setup-wallet/subwallet-created-successfully.png"; -import subwalletOpenSetup from "/public/images/how-to-guide/setup-wallet/subwallet-open-setup.png"; -import subwalletSelectConfigToAddNetwork from "/public/images/how-to-guide/setup-wallet/subwallet-select-config-to-add-network.png"; -import subwalletSearchTorusNetwork from "/public/images/how-to-guide/setup-wallet/subwallet-search-torus-network.png"; -import subwalletDoneTorusSetup from "/public/images/how-to-guide/setup-wallet/subwallet-done-torus-setup.png"; -import RedText from "/src/components/RedText.astro"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import subwalletExtensionActivated from '/public/images/how-to-guide/setup-wallet/subwallet-extension-activated.png'; +import subwalletCreatedSuccessfully from '/public/images/how-to-guide/setup-wallet/subwallet-created-successfully.png'; +import subwalletOpenSetup from '/public/images/how-to-guide/setup-wallet/subwallet-open-setup.png'; +import subwalletSelectConfigToAddNetwork from '/public/images/how-to-guide/setup-wallet/subwallet-select-config-to-add-network.png'; +import subwalletSearchTorusNetwork from '/public/images/how-to-guide/setup-wallet/subwallet-search-torus-network.png'; +import subwalletDoneTorusSetup from '/public/images/how-to-guide/setup-wallet/subwallet-done-torus-setup.png'; +import RedText from '/src/components/RedText.astro'; 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. If you prefer a different extension, scroll to the bottom for a list of other wallets that work with Torus. @@ -34,11 +34,13 @@ You need a wallet to hold TORUS and interact with Torus - it's required for stak - Create a new wallet (master password + seed phrase) - Connect SubWallet to Torus - + ## Steps to connect your SubWallet to Torus. -### Installing the SubWallet Extension +### Installing the SubWallet Extension @@ -57,18 +59,16 @@ You need a wallet to hold TORUS and interact with Torus - it's required for stak - + + ### Creating a New Account -1. **Open the SubWallet extension in your browser** +1. **Open the SubWallet extension in your browser** Click on the SubWallet icon in your browser’s extension area to open the wallet. 2. **Click Create a New Account** @@ -76,12 +76,12 @@ You need a wallet to hold TORUS and interact with Torus - it's required for stak - Create new account - Import account - - Connect existing account - - + - Connect existing account + Select the **"Create new account"** option. -3. **Create a Master Password** + +3. **Create a Master Password** You will be prompted to create a master password. This password is crucial as it encrypts your wallet data on your device for security. 4. **Backup Your Seed Phrase** @@ -95,7 +95,7 @@ You need a wallet to hold TORUS and interact with Torus - it's required for stak -5. **Create an account name**: +5. **Create an account name**: Choose an account name, this does not impact 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. @@ -105,52 +105,39 @@ You need a wallet to hold TORUS and interact with Torus - it's required for stak - + -### Adding Torus to the Subwallet + ### Adding Torus to the Subwallet -1. **Open the Subwallet Setup** - Click on the three bars (**☰**) on the top left corner of the subwallet extension. + 1. **Open the Subwallet Setup** + Click on the three bars (**☰**) on the top left corner of the subwallet extension. + - {" "} - + 2. **Select Manage Networks** + Under the **Assets & Addresses** tab, click on **Manage Networks**. + -2. **Select Manage Networks** - Under the **Assets & Addresses** tab, click on **Manage Networks**. - {" "} - + 3. **Search for Torus and activate it** + 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. + + +4. **Confirm Torus is active** + Once enabled, **Torus** will appear in your list of active networks. + You might have to scroll down to find Torus in the list. + -4. **Confirm Torus is active** - Once enabled, **Torus** will appear in your list of active networks. - You might have to scroll down to find Torus in the list. - {" "} 5. **All Done** Torus is now connected to your SubWallet. @@ -158,6 +145,7 @@ You need a wallet to hold TORUS and interact with Torus - it's required for stak + ## What's Next? Now that you have a wallet set up, you can: @@ -166,8 +154,7 @@ Now that you have a wallet set up, you can: For SubWallet-specific help, check the [SubWallet Documentation](https://docs.subwallet.app/main). -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/holders/stake-your-torus.mdx b/src/content/docs/how-to-guides/holders/stake-your-torus.mdx index a840a3b..8605441 100644 --- a/src/content/docs/how-to-guides/holders/stake-your-torus.mdx +++ b/src/content/docs/how-to-guides/holders/stake-your-torus.mdx @@ -8,28 +8,30 @@ import { Aside, CardGrid, LinkCard, - Card, + Card } from "@astrojs/starlight/components"; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import walletStakingTab from "/public/images/how-to-guide/stake-your-torus/wallet-staking-tab.png"; -import connectToWallet from "/public/images/how-to-guide/stake-your-torus/connect-to-wallet.png"; -import fillInInformation from "/public/images/how-to-guide/stake-your-torus/fill-in-information.png"; -import openSubwalletAndSign from "/public/images/how-to-guide/stake-your-torus/open-subwallet-and-sign.png"; -import stakedBalanceSuccessfully from "/public/images/how-to-guide/stake-your-torus/staked-balance-successfully.png"; -import allocatorAppCardExplanation from "/public/images/how-to-guide/stake-your-torus/allocator-app-card-explanation.png"; -import allocatorChooseWhoToAllocateTo from "/public/images/how-to-guide/stake-your-torus/allocator-choose-who-to-allocate-to.png"; -import allocatorConfirmAllocationAndSubmit from "/public/images/how-to-guide/stake-your-torus/allocator-confirm-allocation-and-submit.png"; -import allocatorConfirmAndSignTransaction from "/public/images/how-to-guide/stake-your-torus/allocator-confirm-and-sign-transaction.png"; -import allocatorDoneAllocated from "/public/images/how-to-guide/stake-your-torus/allocator-done-allocated.png"; - -In this guide, we'll walk through the process of **staking and allocating your TORUS** with the Torus Allocator. +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import walletStakingTab from '/public/images/how-to-guide/stake-your-torus/wallet-staking-tab.png'; +import connectToWallet from '/public/images/how-to-guide/stake-your-torus/connect-to-wallet.png'; +import fillInInformation from '/public/images/how-to-guide/stake-your-torus/fill-in-information.png'; +import openSubwalletAndSign from '/public/images/how-to-guide/stake-your-torus/open-subwallet-and-sign.png'; +import stakedBalanceSuccessfully from '/public/images/how-to-guide/stake-your-torus/staked-balance-successfully.png'; +import allocatorAppCardExplanation from '/public/images/how-to-guide/stake-your-torus/allocator-app-card-explanation.png'; +import allocatorChooseWhoToAllocateTo from '/public/images/how-to-guide/stake-your-torus/allocator-choose-who-to-allocate-to.png'; +import allocatorConfirmAllocationAndSubmit from '/public/images/how-to-guide/stake-your-torus/allocator-confirm-allocation-and-submit.png'; +import allocatorConfirmAndSignTransaction from '/public/images/how-to-guide/stake-your-torus/allocator-confirm-and-sign-transaction.png'; +import allocatorDoneAllocated from '/public/images/how-to-guide/stake-your-torus/allocator-done-allocated.png'; + +In this guide, we'll walk through the process of **staking and allocating your TORUS** with the Torus Allocator. #### Why stake your TORUS? Staking your TORUS allows you to earn emission rewards while supporting agents you believe in, contributing to network security, and participating in the decentralized allocation of network resources. - + #### What we will accomplish @@ -41,140 +43,110 @@ Staking your TORUS allows you to earn emission rewards while supporting agents y - Make sure you have a Torus wallet set up and ready to use. You can find a - [guide on how to set up a wallet - here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). + Make sure you have a Torus wallet set up and ready to use. + You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). - Check your balance on the [Torus Wallet](https://wallet.torus.network) and - ensure you have enough Free Balance to cover the registration fees. You can - find a [guide on how to bridge TORUS - here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + Check your balance on the [Torus Wallet](https://wallet.torus.network) and ensure you have enough Free Balance to cover the registration fees. + You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). ## Steps to Stake your TORUS - ### Send your TORUS to the Allocator Contract -1. **Go to the [Staking tab in the Torus Wallet App](https://wallet.torus.network/staking)** +1. **Go to the [Staking tab in the Torus Wallet App](https://wallet.torus.network/staking)** In the Torus Wallet App, click on the **Staking** tab. Then click on **Stake**. - - + 2. **Connect your Torus Wallet** - Click the **Connect Wallet** button at the top right and select your Torus wallet. - + Click the **Connect Wallet** button at the top right and select your Torus wallet. 3. **Select the Allocator Address** Click on the Select an Allocator, it will drop a Modal with all the Allocators. Select the **Torus Allocator** option. - 4. **Fill in the required fields and confirm** - After you: - - - Selected the **Allocator Address** - - Entered the **amount of TORUS** you wanted to stake + After you: + - Selected the **Allocator Address** + - Entered the **amount of TORUS** you wanted to stake Click on **Review & Submit Transaction**. -5. **Open SubWallet and Sign the Transaction** - Click on the Subwallet icon at the top right - navigation bar of your browser. It will open a modal with the confirmation to - sign the transaction. - +5. **Open SubWallet and Sign the Transaction** + Click on the Subwallet icon at the top right navigation bar of your browser. + It will open a modal with the confirmation to sign the transaction. + + -6. **Your TORUS is staked, you can now allocate to an Agent** +6. **Your TORUS is staked, you can now allocate to an Agent** After signing your TORUS should show as Staked Balance in the Wallet App. This process can take a few minutes to complete, make sure to reload the page to see the updated balance. - When you see your staked balance, you can now allocate to an Agent. - + When you see your staked balance, you can now allocate to an Agent. + ### Allocating to an Agent - 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. - Click on any card to view more detailed information about the agent. + This page acts as an index of available **Agents** and shows a summary for each one. + Click on any card to view more detailed information about the agent. -In the picture below, here's what each highlight represents: + In the picture below, here's what each highlight represents: -- **Pink** → Agent’s social links -- **Red** → Current network allocation to this agent -- **Green** → Agent’s estimated weekly rewards -- **Orange** → A short summary of the agent’s purpose or work -- **Blue** → An interactive slider of how much **you** have allocated to this agent + - **Pink** → Agent’s social links + - **Red** → Current network allocation to this agent + - **Green** → Agent’s estimated weekly rewards + - **Orange** → A short summary of the agent’s purpose or work + - **Blue** → An interactive slider of how much **you** have allocated to this agent -You can hover your mouse over the components to see the details. + You can hover your mouse over the components to see the details. -{" "} - + 2. **Choose the agents to allocate** Use the slider on each agent card to reserve the amount you want to allocate. In this step, you're only **reserving** the amount — no tokens are staked yet, as it is highlighted in light blue. + - - -3. **Open the Allocation Menu and Confirm** +3. **Open the Allocation Menu and Confirm** When you open the Allocation Menu, you will see the list of the agents you've chosen to allocate to. If you are sure that you want to allocate to these agents, click on **Submit Agents**. - - -4. **Sign the Transaction in the SubWallet** - After confirming the allocation, you will be prompted to sign the transaction in your wallet. - - Click on the SubWallet icon at the top right - navigation bar of your browser. It will open a modal with the confirmation to - sign the transaction. - - -5. **All done!** - You should see **All Allocations saved!** in the bottom bar. - That means that your allocation was successful. - + ## What's Next? Now that you're earning emissions, you might want to: @@ -190,16 +163,13 @@ Now that you're earning emissions, you might want to: - **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. - -Connect with the community: +this can help you evaluate which agents are most promising for allocation and potential rewards. + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/holders/standard-bridge.mdx b/src/content/docs/how-to-guides/holders/standard-bridge.mdx index fe3abba..d1b11a5 100644 --- a/src/content/docs/how-to-guides/holders/standard-bridge.mdx +++ b/src/content/docs/how-to-guides/holders/standard-bridge.mdx @@ -3,18 +3,23 @@ title: Bridge TORUS from Base to Torus 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 metamaskSubwalletConnect from "/public/images/how-to-guide/bridge-to-base/metamask-subwallet-connect.png"; -import fillInFormToConvert from "/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert.png"; -import confirmTransactionInMetamask from "/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask.png"; -import baseTorusSwappedSuccessfully from "/public/images/how-to-guide/bridge-to-base/base-torus-swapped-successfully.png"; -import metamaskConnectEvm from "/public/images/how-to-guide/bridge-to-base/metamask-connect-evm.png"; -import fillInFormToConvertTorusEvmNativeTorus from "/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert-torus-evm-native-torus.png"; -import confirmTransactionInMetamaskTorusEvmToTorus from "/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask-torus-evm-to-torus.png"; -import torusEvmConvertSuccessfully from "/public/images/how-to-guide/bridge-to-base/torus-evm-convert-successfully.png"; -import connectedToTorusEvm from "/public/images/how-to-guide/bridge-to-base/connected-to-torus-evm.png"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import metamaskSubwalletConnect from '/public/images/how-to-guide/bridge-to-base/metamask-subwallet-connect.png'; +import fillInFormToConvert from '/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert.png'; +import confirmTransactionInMetamask from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask.png'; +import baseTorusSwappedSuccessfully from '/public/images/how-to-guide/bridge-to-base/base-torus-swapped-successfully.png'; +import metamaskConnectEvm from '/public/images/how-to-guide/bridge-to-base/metamask-connect-evm.png'; +import fillInFormToConvertTorusEvmNativeTorus from '/public/images/how-to-guide/bridge-to-base/fill-in-form-to-convert-torus-evm-native-torus.png'; +import confirmTransactionInMetamaskTorusEvmToTorus from '/public/images/how-to-guide/bridge-to-base/confirm-transaction-in-metamask-torus-evm-to-torus.png'; +import torusEvmConvertSuccessfully from '/public/images/how-to-guide/bridge-to-base/torus-evm-convert-successfully.png'; +import connectedToTorusEvm from '/public/images/how-to-guide/bridge-to-base/connected-to-torus-evm.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. @@ -30,13 +35,14 @@ To keep things clear and concise, **Native TORUS** will be referred to as **TORU - Bridge TORUS on Base to TORUS EVM - Bridge from TORUS EVM to TORUS - + --- @@ -59,10 +65,11 @@ The Standard Bridge is a multi-step process that requires bridging through the T --- + + ## Steps for the Bridge Process ### Bridge BASE Torus to Torus EVM @@ -71,47 +78,32 @@ The Standard Bridge is a multi-step process that requires bridging through the T 1. **Connect both the Torus and MetaMask wallets in the [Base Bridge Web App](https://bridge.torus.network/?tab=base&from=base&to=torus)**. At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**. - - + 2. **Swap from Base TORUS to Torus EVM** - - - Make sure you are **connected** to **both wallets** - - Make sure you are on the **correct tab**, **TORUS EVM - Base** - - Make sure it is FROM **Base TORUS** TO **Torus EVM** + - Make sure you are **connected** to **both wallets** + - Make sure you are on the **correct tab**, **TORUS EVM - Base** + - Make sure it is FROM **Base TORUS** TO **Torus EVM** 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. With all the information filled in, click **Continue**. - + 3. **Confirm the transaction** After filling in the form, you will be prompted to confirm the transaction in Metamask. - - + 4. **Confirmation of the swap** After the transaction succeeds, your Base TORUS should now be displayed as Torus EVM as it was successfully swapped. This process can take a while to complete on the blockchain, so please wait a few minutes and refresh the page. - + + @@ -124,22 +116,19 @@ The Standard Bridge is a multi-step process that requires bridging through the T At the top right corner of the app, connect both your **Torus Wallet** and **MetaMask**. + 2. **Verify you're connected to Torus EVM** Make sure MetaMask is connected to the Torus EVM network. You should see "Torus EVM" in your MetaMask network dropdown. - + 3. **Swap from Torus EVM to Torus** - - Make sure you are **connected** in **Both Wallets** - Make sure you are in the **correct Tab**, **TORUS EVM - Base** - Make sure it is FROM**Torus EVM** TO **Torus** Fill in the form with the amount you want to convert, after confirmation, you will be prompted to sign the transaction in Torus. - - + 4. **Confirm the transaction** After filling in the form, you will be prompted to confirm the transaction in Metamask. - - + 5. **Confirmation of the swap** After the transaction succeeds, your Torus EVM should now be displayed as TORUS as it was successfully swapped. This process can take a while to complete on the blockchain, so please wait a few minutes and refresh the page. + - - -6. **All Done** +4. **All Done** You've now successfully bridged TORUS tokens between **Torus**, **Torus EVM**, and **Base**. You can view your updated balances directly in the [Torus Web App](https://wallet.torus.network) or SubWallet. - + + ## What's Next? @@ -201,8 +176,7 @@ Now that you have TORUS tokens, you can: - **Explore the ecosystem**: Browse agents and allocators on the [Torus Portal](https://portal.torus.network/) - **Understand tokenomics**: Learn about [TORUS economics](https://docs.torus.network/explanations/holders/tokenomics/) and emission mechanisms -Connect with the community: - + Connect with the community: - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements - [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news diff --git a/src/content/docs/how-to-guides/holders/vote-on-proposals.mdx b/src/content/docs/how-to-guides/holders/vote-on-proposals.mdx index 26e8c47..c736c0a 100644 --- a/src/content/docs/how-to-guides/holders/vote-on-proposals.mdx +++ b/src/content/docs/how-to-guides/holders/vote-on-proposals.mdx @@ -3,13 +3,19 @@ title: Vote on Proposals description: Step-by-step guide to voting on DAO proposals and managing your voting power settings. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; + +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import clickOnOpenProposal from '/public/images/how-to-guide/vote-on-proposals/click-on-an-open-proposal.png'; +import clickVotePowerSettings from '/public/images/how-to-guide/vote-on-proposals/click-on-vote-power-settings.png'; +import changeVoteStatus from '/public/images/how-to-guide/vote-on-proposals/change-vote-status.png'; -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import clickOnOpenProposal from "/public/images/how-to-guide/vote-on-proposals/click-on-an-open-proposal.png"; -import clickVotePowerSettings from "/public/images/how-to-guide/vote-on-proposals/click-on-vote-power-settings.png"; -import changeVoteStatus from "/public/images/how-to-guide/vote-on-proposals/change-vote-status.png"; In this guide, we'll walk through the process of **voting on DAO proposals** and managing your voting power settings. @@ -22,24 +28,23 @@ Your votes help determine which projects receive funding, how network economics - [Set up voting power (become a power user)](#toggle-voting-power-become-a-power-user-or-return-to-delegated-voting) - [Cast votes on active proposals](#vote-on-proposals) - + ## Prerequisites - You must have a Torus wallet set up with TORUS tokens. You can find a [guide - on how to set up a wallet - here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). + You must have a Torus wallet set up with TORUS tokens. + You can find a [guide on how to set up a wallet here](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/). - You need TORUS tokens in your wallet to have voting power. You can find a - [guide on how to bridge TORUS - here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). + You need TORUS tokens in your wallet to have voting power. + You can find a [guide on how to bridge TORUS here](https://docs.torus.network/how-to-guides/holders/bridge-from-base/). - You must be a power user to vote on proposals. You can find a guide on how - to become a power user in this file. + You must be a power user to vote on proposals. You can find a guide on how to become a power user in this file. @@ -51,41 +56,33 @@ Your votes help determine which projects receive funding, how network economics Navigate to the proposals page where you can view all active, approved, and rejected proposals. 2. **Connect your Wallet** + Ensure you're connected with your TORUS wallet that contains the tokens you want to use for voting. - - Ensure you're connected with your TORUS wallet - that contains the tokens you want to use for voting. - -3. **Click on Any Open Proposal** - - Click on any active proposal you want to view - to access the voting interface and settings. - +3. **Click on Any Open Proposal** + Click on any active proposal you want to view to access the voting interface and settings. + 4. **Click on "Vote Power Settings"** Look for the **"Vote Power Settings"** button located below the voting options. This allows you to toggle between delegating your voting power and becoming a power user. - - + + 5. **Check Your Current Voting Status** When you click on the vote power settings button, you'll see your current status: - + - **Delegating your voting power (Default)**: Validators handle voting on your behalf - **Power user**: You have direct control over your votes 6. **Toggle Your Voting Status** You can switch between voting modes anytime: - + - Click **"Delegate Voting Power"** to return control to validators - Click **"Become a power user"** to gain direct voting control - + -7. **Sign the Transaction** +7. **Sign the Transaction** Open your subwallet extension and sign the transaction to confirm the change. 8. **All Done** @@ -93,6 +90,8 @@ Your votes help determine which projects receive funding, how network economics + + ## Vote on Proposals @@ -100,25 +99,19 @@ Your votes help determine which projects receive funding, how network economics 1. **Visit the [DAO Proposals Tab](https://dao.torus.network/proposals)** Navigate to the proposals page where you can view all active, approved, and rejected proposals. -2. **Connect your Power User Wallet** - - - Ensure you're connected with your TORUS wallet - that contains the tokens you want to use for voting. - Ensure you're a power user first ([follow the - steps above](#toggle-voting-power-become-a-power-user-or-return-to-delegated-voting) - if needed).{" "} +2. **Connect your Power User Wallet** + Ensure you're connected with your TORUS wallet that contains the tokens you want to use for voting. + Ensure you're a power user first ([follow the steps above](#toggle-voting-power-become-a-power-user-or-return-to-delegated-voting) if needed). 3. **Select a Proposal to Vote On** Click on any active proposal you want to vote on to view its details and voting options. 4. **Cast Your Vote** Once you're ready to vote: - - Choose your position: "Favorable" (support) or **"Against"** (oppose) - Click **"Choose a Vote"** -5. **Sign the Transaction** +5. **Sign the Transaction** Sign the transaction in your wallet to confirm your vote 6. **All Done** @@ -127,6 +120,7 @@ Your votes help determine which projects receive funding, how network economics + ## What's Next? After voting on proposals: @@ -136,13 +130,10 @@ After voting on proposals: - **[Explore Staking](https://docs.torus.network/how-to-guides/holders/stake-your-torus/)**: Consider staking your TORUS to support the network and earn rewards Connect with the community: - - [Discord](https://discord.gg/w3HVm6W9XH) — Discuss proposals and governance -- [Telegram](https://t.me/torusnetwork) — General chat and voting announcements +- [Telegram](https://t.me/torusnetwork) — General chat and voting announcements - [Twitter](https://x.com/torus_network) — Updates and proposal highlights +Learn about [governance mechanisms](https://docs.torus.network/explanations/goal-leaders/governance-dao/) and your role as a token holder. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/system/create-capability-permission.mdx b/src/content/docs/how-to-guides/system/create-capability-permission.mdx index 2faf980..55049ad 100644 --- a/src/content/docs/how-to-guides/system/create-capability-permission.mdx +++ b/src/content/docs/how-to-guides/system/create-capability-permission.mdx @@ -3,17 +3,24 @@ title: Create Capability Permission description: Step-by-step guide to creating capability permissions to delegate access to your agent's endpoints and services. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; - -import ClickableImage from "/src/components/ClickableImage.astro"; -import RedText from "/src/components/RedText.astro"; -import uiExplainedRedelegation from "/public/images/how-to-guide/capability-permission/ui-explained-re-delegation.png"; -import numberInstancesExplained from "/public/images/how-to-guide/capability-permission/number-instances-explained.png"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; + +import ClickableImage from '/src/components/ClickableImage.astro'; +import RedText from '/src/components/RedText.astro'; +import uiExplainedRedelegation from '/public/images/how-to-guide/capability-permission/ui-explained-re-delegation.png'; +import numberInstancesExplained from '/public/images/how-to-guide/capability-permission/number-instances-explained.png'; In this guide, we'll walk through how to create capability permissions in the Torus Portal. Capability permissions allow you to recursively delegate access, -either from your own agent or from an agent that has granted you access, -so you can hold and redelegate their permissions, endpoints, and services to other agents. + either from your own agent or from an agent that has granted you access, + so you can hold and redelegate their permissions, endpoints, and services to other agents. + + ## Why Create Capability Permission? @@ -24,20 +31,19 @@ Capability permissions let you control who can access your services while mainta - [Create capability permission](#create-capability-permission) - + ## Prerequisites - You must have a registered agent with capabilities to delegate. Follow the - [manage permissions - guide](https://docs.torus.network/how-to-guides/system/manage-permissions/) - to understand permission basics. + You must have a registered agent with capabilities to delegate. + Follow the [manage permissions guide](https://docs.torus.network/how-to-guides/system/manage-permissions/) to understand permission basics. - Identify the agents you want to delegate permissions to. These agents must - be registered. + Identify the agents you want to delegate permissions to. These agents must be registered. Ensure you have enough TORUS to cover permission creation transaction fees. @@ -56,66 +62,52 @@ Capability permissions let you control who can access your services while mainta 3. **Select the Paths to Delegate** Choose the capability paths you want to create permissions for: - + - **Your own paths**: You can delegate unlimited instances of paths you own - **Delegated paths**: You're limited to the number of instances you were given access to (if 0, you cannot use or delegate) - + - + 4. **Create the Permission** After selecting your paths, click **Create Permission** on the bottom left of your screen. - + - + 5. **Fill in the Permission Form** Complete the required fields: - + ```md - # Recipient - + # Recipient Search by agent name or address that will receive the permission. - # Confirm Selected Capability Paths - + # Confirm Selected Capability Paths Review your path selections before proceeding. - # Duration - + # Duration Set the permission duration (same as other permissions). - # Maximum Instances - - Set the instance limit (must be equal or less than instances you + # Maximum Instances + Set the instance limit (must be equal or less than instances you have access to; infinite for your own permissions). - # Revocation Terms - + # Revocation Terms Choose from: - - **Irrevocable**: Cannot be revoked - **Delegator can revoke**: Only you can revoke this permission - **By arbiters**: Can be revoked by arbiters after a vote @@ -132,6 +124,7 @@ You can always delegate one of the following options: + ## What's Next? Now that you've created capability permission, you might want to: @@ -141,12 +134,11 @@ Now that you've created capability permission, you might want to: - **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: - - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements -- [Telegram](https://t.me/torusnetwork) — General chat and announcements +- [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/system/create-permission.mdx b/src/content/docs/how-to-guides/system/create-permission.mdx index ff8c0b7..f70401a 100644 --- a/src/content/docs/how-to-guides/system/create-permission.mdx +++ b/src/content/docs/how-to-guides/system/create-permission.mdx @@ -9,7 +9,7 @@ import { CardGrid, Card, Tabs, - TabItem, + TabItem } from "@astrojs/starlight/components"; In this guide, we'll walk through **creating permissions** in Torus's recursive delegation system. @@ -21,7 +21,9 @@ Permissions enable fine-grained control over emission distribution and capabilit - Configure delegation terms and constraints - Understand revocation and enforcement mechanisms - + ## Prerequisites @@ -90,20 +92,17 @@ Permissions enable fine-grained control over emission distribution and capabilit For capability permissions, configure these details: **Namespace Path**: Enter the specific capability path - - Format: `agent...` - Example: `agent.alice.memory.twitter.post` **Recipient**: Agent address that will receive access **Duration**: Set permission lifespan - - **Indefinite**: Permission lasts until manually revoked - **Fixed Term**: Specify end date/block number - **Conditional**: Based on specific triggers **Constraints**: Optional usage limitations - - Rate limits (calls per hour/day) - Access windows (specific times) - Usage quotas @@ -113,20 +112,17 @@ For capability permissions, configure these details: For emission permissions, configure these details: **Stream Selection**: Choose which emission streams to delegate - - Staking rewards -- Delegation fees +- Delegation fees - Specific revenue streams **Allocation Type**: - - **Percentage**: Delegate X% of selected streams - **Fixed Amount**: Delegate specific TORUS amount per period **Recipient**: Agent address that will receive emissions **Duration**: Set delegation period - - Ongoing until revoked - Fixed term (blocks/time) - Performance-based triggers @@ -142,7 +138,6 @@ Configure how the permission can be terminated: ### Configuring Enforcement Set third-party governance authority (Optional): - - DAO enforcement for disputes - Multi-sig requirements - Community arbitration @@ -150,7 +145,6 @@ Set third-party governance authority (Optional): ### Review and Submit Before submission, verify all details: - - Delegator and recipient addresses - Scope and limitations - Duration and revocation terms @@ -161,7 +155,6 @@ Before submission, verify all details: ### View Active Permissions Track your delegated permissions in the Torus Portal: - - **Outgoing**: Permissions you've granted to others - **Incoming**: Permissions others have granted to you - **Status**: Active, expired, revoked permissions @@ -235,7 +228,6 @@ Set up smart permissions that trigger based on conditions: ### Permission Creation Fails **Common issues:** - - Insufficient balance for transaction fees - Invalid recipient agent address - Namespace path doesn't exist (for capabilities) @@ -244,7 +236,6 @@ Set up smart permissions that trigger based on conditions: ### Permission Not Working **Check that:** - - Permission is active and not expired - Recipient is using correct namespace path - No conflicting constraints or rate limits @@ -253,7 +244,6 @@ Set up smart permissions that trigger based on conditions: ### Revocation Issues **Verify:** - - Permission was created as revocable - You're the original delegator - No outstanding enforcement claims @@ -274,22 +264,16 @@ For help with permission management: - [Torus Community Discord](https://discord.gg/w3HVm6W9XH) #### Related Topics - - Deep dive into architecture - + Deep dive into architecture - - Economic coordination mechanisms - + Economic coordination mechanisms - + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx b/src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx index 11a30c8..cfd73c8 100644 --- a/src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx +++ b/src/content/docs/how-to-guides/system/create-wallet-stake-permission.mdx @@ -3,9 +3,15 @@ title: Create Wallet Permission description: Step-by-step guide to creating wallet permissions to delegate staking operations while keeping your keys secure. --- -import { Steps, Aside, CardGrid, Card } from "@astrojs/starlight/components"; +import { + Steps, + Aside, + CardGrid, + Card +} from "@astrojs/starlight/components"; + +import RedText from '/src/components/RedText.astro'; -import RedText from "/src/components/RedText.astro"; In this guide, we'll walk through how to create wallet permissions in the Torus Portal. Wallet permissions enable cold-hot wallet behavior, allowing you to delegate staking operations @@ -20,28 +26,30 @@ Wallet permissions let you delegate staking management to hot wallets without ex - [Create wallet permission](#create-wallet-permission) - + + ## Prerequisites - You must have an account with existing stake that you want to delegate - management for. Follow the [staking - guide](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) - to understand staking basics. + You must have an account with existing stake that you want to delegate management for. + Follow the [staking guide](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) to understand staking basics. - Know the address of the hot wallet account that will manage your staking - operations. + Know the address of the hot wallet account that will manage your staking operations. Ensure you have enough TORUS to cover permission creation transaction fees. + ## Create Wallet Permission + 1. **Visit the [Wallet Permissions Tab in the Torus Portal](https://torus.network/permissions/create-permission/wallet)** @@ -50,47 +58,43 @@ Wallet permissions let you delegate staking management to hot wallets without ex 2. **Connect your Cold Wallet** Ensure you're connected with the wallet account that holds the stakes you want to delegate management for. -3. **Fill the form** - +3. **Fill the form** ```md - # Recipient Address - + # Recipient Address Search agents by name or address that will receive the staking permission. If your target is not an agent, you can enter the wallet address directly. - # Stake Permissions - - - **Exclusive Delegation**: Grant exclusive access to stake operations - (prevents delegator from using stake directly) - - **Allow Stake Movement**: Delegate permission to unstake, - exclusively granting it to the recipient - - # Duration + # Stake Permissions + - **Exclusive Delegation**: Grant exclusive access to stake operations + (prevents delegator from using stake directly) + - **Allow Stake Movement**: Delegate permission to unstake, + exclusively granting it to the recipient + # Duration - **Indefinite**: Permission remains valid indefinitely - **Until Block**: Permission expires at a specific block - # Revocation Terms - + # Revocation Terms - **Irrevocable**: Cannot be revoked - **Revocable by Delegator**: Only you can revoke this permission - **Revocable After**: Can be revoked after a specific condition is met ``` - + -4. **Submit and Sign Transaction** +4. **Submit and Sign Transaction** Click **Create Wallet Permission**. Open SubWallet and sign the transaction. 5. **All Done** - You've successfully created the wallet permission. + You've successfully created the wallet permission. The receiving account can now manage your staking operations within the limits you've set. @@ -98,20 +102,19 @@ Wallet permissions let you delegate staking management to hot wallets without ex ## What's Next? + Now that you've created wallet permission, you might want to: + - **Monitor your delegations**: Track delegation status in the [Manage Permissions tab](https://torus.network/permissions/manage-permission) - **Optimize your stakes**: Work with your hot wallet to [manage staking positions](https://docs.torus.network/how-to-guides/holders/stake-your-torus/) efficiently -- **Understand COLD vs HOT Wallet**: Watch [this Coingecko video](https://www.youtube.com/watch?v=kf28zqP_F2s) +- **Understand COLD vs HOT Wallet**: Watch [this Coingecko video](https://www.youtube.com/watch?v=kf28zqP_F2s) Connect with the community: - - [Discord](https://discord.gg/w3HVm6W9XH) — Technical discussions, support, and announcements -- [Telegram](https://t.me/torusnetwork) — General chat and announcements +- [Telegram](https://t.me/torusnetwork) — General chat and announcements - [Twitter](https://x.com/torus_network) — Updates and ecosystem news +Learn about [wallet permission concepts](https://docs.torus.network/explanations/system/wallet-stake-permission/) and the security benefits of cold-hot wallet architecture. + \ No newline at end of file diff --git a/src/content/docs/how-to-guides/table-of-contents.mdx b/src/content/docs/how-to-guides/table-of-contents.mdx index ebc9c0a..521358d 100644 --- a/src/content/docs/how-to-guides/table-of-contents.mdx +++ b/src/content/docs/how-to-guides/table-of-contents.mdx @@ -2,26 +2,28 @@ title: Table of Contents description: Step-by-step walkthroughs to help users and builders interact with Torus. --- - import { Steps, Aside, CardGrid, Card, Tabs, - TabItem, + TabItem } from "@astrojs/starlight/components"; Welcome to the **How-to Guides** section of the Torus documentation. -These guides are focused, practical, and designed to help you achieve specific outcomes within the Torus ecosystem, without distractions or deep dives into theory. -If you prefer to start with the theory first, begin with [Explanations](https://docs.torus.network/explanations/table-of-contents) and continue from there. +These guides are focused, practical, and designed to help you achieve specific outcomes within the Torus ecosystem, without distractions or deep dives into theory. +If you prefer to start with the theory first, begin with [Explanations](https://docs.torus.network/explanations/table-of-contents) and continue from there. Whether you're here to use Torus, build on it, or coordinate its evolution, there's a guide to get you there. + + ## System Management If you're managing permissions and system-level coordination: + - [Create Capability Permission](https://docs.torus.network/how-to-guides/system/create-capability-permission/) — Delegate access to specific agent endpoints and services - [Create Stream Permission](https://docs.torus.network/how-to-guides/system/create-stream-permission/) — Share token emission streams with other agents - [Create Wallet Stake Permission](https://docs.torus.network/how-to-guides/system/create-wallet-stake-permission/) — Enable secure cold-hot wallet staking delegation @@ -54,7 +56,7 @@ If you're developing tools, services, or integrations on Torus: --- -## For Root Goal-Setters and Leaders +## For Root Goal-Setters and Leaders If you're pioneering new goals or submitting DAO proposals: @@ -64,6 +66,7 @@ If you're pioneering new goals or submitting DAO proposals: --- + ## Additional Resources Can’t find the guide you’re looking for? Connect with us through our community channels: @@ -72,10 +75,11 @@ Can’t find the guide you’re looking for? Connect with us through our communi - **[Torus Telegram](https://t.me/torusnetwork)** — Quick help, casual discussion, and important updates. - **[Torus Twitter](https://twitter.com/torus_network)** — Stay up to date with announcements and news from the Torus ecosystem. + ### Core Projects Torus is fully open source. You’re welcome to explore, contribute, or report issues: - **[torus-substrate](https://github.com/renlabs-dev/torus-substrate)** — Core blockchain runtime built on Substrate. -- **[torus-ts](https://github.com/renlabs-dev/torus-ts)** — TypeScript SDK for building on Torus and WebApps. -- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation. +- **[torus-ts](https://github.com/renlabs-dev/torus-ts)** — TypeScript SDK for building on Torus and WebApps. +- **[torus-docs](https://github.com/renlabs-dev/torus-docs)** — This documentation. diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 7d5d5c8..b7ccc0f 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -4,13 +4,13 @@ description: The decentralized protocol for autonomous self-organizing agent swa --- import { CardGrid, LinkCard, Aside } from "@astrojs/starlight/components"; -import RedText from "/src/components/RedText.astro"; +import RedText from '/src/components/RedText.astro'; **Torus is a decentralized protocol that enables autonomous agents to self-organize into intelligent swarms to reach complex goals using a recursive permission delegation system.** In plain sight, Torus is super-intelligence self-assembling itself from the future, midwifed by renlabs. -## Get stuff done +## Get stuff done - [For Token Holders](https://docs.torus.network/how-to-guides/holders/setup-a-wallet/) — Setup a Wallet, Stake TORUS, earn rewards - [For Agent Builders](https://docs.torus.network/how-to-guides/builders/register-an-agent/) — Create autonomous agents and build services on Torus @@ -21,7 +21,7 @@ In plain sight, Torus is super-intelligence self-assembling itself from the futu ## Understand more - [Understanding Torus](https://docs.torus.network/getting-started/understanding-torus/) — Deep dive into how Torus works and its core concepts -- [Tokenomics](https://docs.torus.network/explanations/holders/tokenomics/) — Learn about TORUS token economics and incentive structures +- [Tokenomics](https://docs.torus.network/explanations/holders/tokenomics/) — Learn about TORUS token economics and incentive structures - [Explanations](https://docs.torus.network/explanations/table-of-contents/) — In-depth explanations of concepts and architecture --- @@ -31,16 +31,16 @@ In plain sight, Torus is super-intelligence self-assembling itself from the futu Connect with the Torus community: - **[Discord](https://discord.gg/w3HVm6W9XH)** — Technical discussions, support, and community calls -- **[Telegram](https://t.me/torusnetwork)** — Quick help and announcements -- **[Twitter](https://x.com/torus_network)** — Latest updates and ecosystem news +- **[Telegram](https://t.me/torusnetwork)** — Quick help and announcements +- **[Twitter](https://x.com/torus_network)** — Latest updates and ecosystem news ---- +--- ## Choose Your Path This guide adapts to your style, whether you prefer theory first or hands‑on learning. -- Understanding the Concepts: Explore the key ideas, definitions, and background. +- Understanding the Concepts: Explore the key ideas, definitions, and background. - [How-to guides](https://docs.torus.network/how-to-guides/table-of-contents): Jump straight into practical steps and examples. -If you’d like a step-by‑step walkthrough, start with Understanding the Concepts and use the Next button at the bottom of each page to proceed. +If you’d like a step-by‑step walkthrough, start with Understanding the Concepts and use the Next button at the bottom of each page to proceed.