Skip to content

Commit 11470db

Browse files
committed
Update permission terminology in docs from "emission" to "stream" for consistency across the system and user guides
1 parent 99d997c commit 11470db

File tree

12 files changed

+77
-112
lines changed

12 files changed

+77
-112
lines changed

astro.config.mjs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export default defineConfig({
4040
{ label: "Control Space", slug: "explanations/system/control-space" },
4141
{ label: "Permission System", slug: "explanations/system/permission-system" },
4242
{ label: "Recursive Delegation", slug: "explanations/system/recursive-delegation" },
43-
{ label: "Emission Permissions", slug: "explanations/system/emission-permissions" },
43+
{ label: "Stream Permissions", slug: "explanations/system/stream-permissions" },
4444
{ label: "Capability Permissions", slug: "explanations/system/capability-permissions" },
4545
],
4646
},
@@ -87,7 +87,7 @@ export default defineConfig({
8787
items: [
8888
{ label: "Create Permission", slug: "how-to-guides/system/create-permission" },
8989
{ label: "Create Capability Permission", slug: "how-to-guides/system/create-capability-permission" },
90-
{ label: "Create Emission Permission", slug: "how-to-guides/system/create-emission-permission" },
90+
{ label: "Create Stream Permission", slug: "how-to-guides/system/create-stream-permission" },
9191
{ label: "Manage Permissions", slug: "how-to-guides/system/manage-permissions" },
9292
],
9393
},

src/content/docs/explanations/builders/agent-managing.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Before de-registering an agent, you must:
4848

4949
De-registration results in permanent loss of:
5050
- **All registered namespaces** — all capability paths will be deleted
51-
- **Ability to create new delegations** — namespace and emission delegation capabilities are revoked
51+
- **Ability to create new delegations** — namespace and stream delegation capabilities are revoked
5252
- **Delegated permissions** — all permissions granted to/from your agent will be revoked
5353
- **Agent identity** — the agent is completely removed from the network
5454

src/content/docs/explanations/builders/demand-signaling.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Demand Signaling
3-
description: Understanding how agents coordinate specialization through demand signals and emission delegation.
3+
description: Understanding how agents coordinate specialization through demand signals and stream delegation.
44
---
55

66
import {
@@ -13,7 +13,7 @@ import {
1313
The [Create Signal feature on the Portal](https://portal.torus.network/signals/create-signal) allows agents to express in a technical and economical way
1414
their demand for specialized capabilities from other agents.
1515

16-
Standard agents are looking for opportunities to receive emission delegations by providing specialized capabilities.
16+
Standard agents are looking for opportunities to receive stream delegations by providing specialized capabilities.
1717
This means, you can define a problem and increase interest in solving it by proposing an allocation of your own emissions.
1818

1919
For example, if you have an agent specializing on finding predictions for the swarm memory and your accuracy and rewards suffer by failing to filter out irony,

src/content/docs/explanations/system/permission-system.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Permission System Architecture
3-
description: Comprehensive guide to Torus's recursive delegation system, emission permissions, and control distribution mechanisms.
3+
description: Comprehensive guide to Torus's recursive delegation system, stream permissions, and control distribution mechanisms.
44
---
55

66
import { CardGrid, LinkCard, Aside, Tabs, TabItem } from "@astrojs/starlight/components";
@@ -35,7 +35,7 @@ The system supports three fundamental permission types that enable comprehensive
3535

3636
```rust
3737
pub enum PermissionScope {
38-
Emission(EmissionScope), // Token delegation permissions
38+
Emission(EmissionScope), // Stream delegation permissions
3939
Curator(CuratorScope), // Governance function delegation
4040
Capability(CapabilityScope), // Off-chain service access control
4141
}

src/content/docs/explanations/system/recursive-delegation.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ At each delegation step, permission's can be
2121
- granularly partitioned into smaller permissions until reaching the atomic level
2222
- paired with a new constraint, accumulating a constraint stack throughout the delegation path.
2323

24-
This applies to the capability, emission and curator permission type.
24+
This applies to the capability, stream and curator permission type.
2525

2626
### Core Functions
2727

src/content/docs/explanations/system/emission-permissions.mdx renamed to src/content/docs/explanations/system/stream-permissions.mdx

Lines changed: 20 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
11
---
2-
title: Emission Permissions
3-
description: Complete guide to emission permissions, stream delegation, and economic coordination mechanisms in Torus.
2+
title: Stream Permissions
3+
description: Complete guide to stream permissions, stream delegation, and economic coordination mechanisms in Torus.
44
---
55

66
<Aside type="note" title="Version notice">
7-
This version is based on the Torus v0.5 and is expected to change with the Torus v1.
7+
This version is based on the Torus v0.6 and is expected to change with the Torus v1.
88
</Aside>
99

10-
import { CardGrid, LinkCard, Aside, Tabs, TabItem } from "@astrojs/starlight/components";
10+
import { CardGrid, LinkCard, Aside } from "@astrojs/starlight/components";
1111

12-
Emission permissions are the core tool and mechanism for economic incentives on Torus, enabling agents to compose and delegate portions of their incoming emission streams (token flows) to other agents with flexible control. This enables agents to hire other agents and form economic group structures.
12+
Stream permissions are the core tool and mechanism for economic incentives on Torus, enabling agents to compose and delegate portions of
13+
their incoming emission streams (token flows) to other agents with flexible control.
14+
This enables agents to hire other agents and form economic group structures.
1315

14-
## Emission Permission System
15-
16-
Emission permissions are core tool and mechanism for economic incentives on Torus, enabling agents to compose and delegate portions of their incoming emission streams (token flows) to other agents with flexible control. This enables agents to hire other agents and form economic group structures.
16+
## Stream Permission System
1717

1818
### Stream-Based Emission Model
1919

20-
The emission system preserves **stream identity** through delegation chains via unique `StreamId` identifiers. Each stream represents a distinct emission source (staking returns, delegation fees), enabling complete traceability of token flow from source to final recipients.
20+
The emission system preserves **stream identity** through delegation chains via unique `StreamId` identifiers.
21+
Each stream represents a distinct emission source (staking returns, delegation fees),
22+
enabling complete traceability of token flow from source to final recipients.
2123

2224
### Allocation Mechanisms
2325

24-
Emission permissions support two distinct allocation paradigms:
26+
Stream permissions support two distinct allocation paradigms:
2527

2628
#### Stream Allocations (Percentage-Based)
2729

@@ -36,80 +38,45 @@ Stream allocations enable agents to delegate specific percentages of incoming em
3638

3739
#### Fixed Amount Allocations
3840

39-
Fixed amount allocations reserve specific token quantities from the delegator's account at permission creation:
40-
41-
```rust
42-
FixedAmount(1000) // Reserve 1000 TORUS
43-
```
41+
Fixed amount allocations allow you to set aside specific token quantities for delegation:
4442

4543
**Fixed Amount Characteristics:**
46-
- **Upfront Reservation**: Tokens are reserved using the Currency trait's reserve mechanism
44+
- **Upfront Reservation**: Tokens are reserved from your account at permission creation
4745
- **One-time Distribution**: Can only be executed once (manually or at a specific block)
48-
- **Distribution Constraints**: Limited to `Manual` or `AtBlock` distribution controls
49-
- **Safety Guarantee**: Uses the reserve/unreserve pattern to prevent double-spending
46+
- **Distribution Constraints**: Limited to manual trigger or specific block execution
47+
- **Safety Guarantee**: Reserved tokens cannot be double-spent or allocated elsewhere
5048

5149
### Distribution Control Mechanisms
5250

5351
The system provides four distribution control patterns that determine when and how delegated tokens are transferred:
5452

55-
```rust
56-
pub enum DistributionControl {
57-
Manual, // Recipient triggers distribution
58-
Automatic(Balance), // Auto-trigger at threshold
59-
AtBlock(BlockNumber), // Execute at specific block
60-
Interval(BlockNumber), // Execute every N blocks
61-
}
62-
```
63-
64-
<Tabs>
65-
<TabItem label="Manual Distribution">
53+
##### Manual Distribution
6654
**Manual Distribution** requires explicit execution by the recipient:
6755

68-
```rust
69-
DistributionControl::Manual
70-
```
71-
7256
- **Recipient Control**: Recipient determines when to claim accumulated tokens
7357
- **Flexibility**: Allows strategic timing of token distribution
7458
- **Gas Efficiency**: Batches multiple accumulations into single distribution
75-
</TabItem>
7659

77-
<TabItem label="Automatic Distribution">
60+
##### Automatic Distribution
7861
**Automatic Distribution** triggers when accumulated amounts reach a threshold:
7962

80-
```rust
81-
DistributionControl::Automatic(5000) // Auto-distribute at 5000 TORUS
82-
```
83-
8463
- **Threshold-Based**: Automatically executes when accumulated amount exceeds threshold
8564
- **Predictable**: Ensures regular distribution without manual intervention
8665
- **Efficient**: Reduces the need for manual monitoring
87-
</TabItem>
8866

89-
<TabItem label="Block-Based Distribution">
67+
##### Block-Based Distribution
9068
**AtBlock Distribution** executes once at a specific block:
9169

92-
```rust
93-
DistributionControl::AtBlock(1_000_000) // Execute at block 1,000,000
94-
```
95-
9670
- **Scheduled**: Executes at predetermined block height
9771
- **One-time**: Single execution at specified block
9872
- **Predictable**: Known execution timing
99-
</TabItem>
10073

101-
<TabItem label="Interval Distribution">
74+
##### Interval Distribution
10275
**Interval Distribution** executes periodically at fixed intervals:
10376

104-
```rust
105-
DistributionControl::Interval(10_800) // Execute every 10,800 blocks (~24 hours)
106-
```
107-
10877
- **Periodic**: Regular execution at specified block intervals
10978
- **Automated**: No manual intervention required
11079
- **Consistent**: Predictable distribution schedule
111-
</TabItem>
112-
</Tabs>
11380

11481
---
11582
### Emission Accumulation Process

src/content/docs/explanations/table-of-contents.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Core system components and mechanisms:
2525
- [Control Space](https://docs.torus.network/explanations/system/control-space/) — Foundational permission and capability framework
2626
- [Permission System](https://docs.torus.network/explanations/system/permission-system/) — How agents interact and delegate authority
2727
- [Recursive Delegation](https://docs.torus.network/explanations/system/recursive-delegation/) — Specific capability delegation mechanisms
28-
- [Emission Permissions](https://docs.torus.network/explanations/system/emission-permissions/) — How emissions are allocated and controlled
28+
- [Stream Permissions](https://docs.torus.network/explanations/system/emission-permissions/) — How emissions are allocated and controlled
2929
- [Capability Permissions](https://docs.torus.network/explanations/system/capability-permissions/) — Fine-grained access control for agent endpoints
3030

3131
---

src/content/docs/how-to-guides/builders/manage-your-agent.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ and ensures your agent represents your current capabilities and offerings.
103103

104104
**You will permanently lose:**
105105
- <RedText variant="light">All registered namespaces</RedText> — all capability paths will be deleted
106-
- <RedText variant="light">Ability to create new namespace or emission delegations</RedText>
106+
- <RedText variant="light">Ability to create new namespace or stream delegations</RedText>
107107
- <RedText variant="light">Delegated permissions</RedText> — all permissions granted to/from your agent will be revoked
108108
- Agent name — you CAN reuse this name if you <RedText variant="light">re-register</RedText> later
109109

src/content/docs/how-to-guides/system/create-permission.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Permissions enable fine-grained control over emission distribution and capabilit
1717

1818
#### What we will accomplish
1919

20-
- Create capability and emission permissions
20+
- Create capability and stream permissions
2121
- Configure delegation terms and constraints
2222
- Understand revocation and enforcement mechanisms
2323

@@ -50,7 +50,7 @@ Permissions enable fine-grained control over emission distribution and capabilit
5050
**Example**: Allow Agent B to access Agent A's memory storage API
5151

5252
</TabItem>
53-
<TabItem label="Emission Permissions">
53+
<TabItem label="Stream Permissions">
5454

5555
**Purpose**: Delegate portions of emission streams (token flows)
5656
**Use Cases**: Hiring agents, revenue sharing, economic coordination
@@ -71,7 +71,7 @@ Permissions enable fine-grained control over emission distribution and capabilit
7171
Ensure you're connected as the delegating agent.
7272

7373
3. **Choose permission type**
74-
Select either **Capability** or **Emission** permission from the dropdown.
74+
Select either **Capability** or **Stream** permission from the dropdown.
7575

7676
4. **Configure permission details based on type**
7777

@@ -107,9 +107,9 @@ For capability permissions, configure these details:
107107
- Access windows (specific times)
108108
- Usage quotas
109109

110-
### Configuring Emission Permissions
110+
### Configuring Stream Permissions
111111

112-
For emission permissions, configure these details:
112+
For stream permissions, configure these details:
113113

114114
**Stream Selection**: Choose which emission streams to delegate
115115
- Staking rewards
@@ -209,12 +209,12 @@ Set up smart permissions that trigger based on conditions:
209209

210210
- **Principle of least privilege**: Grant minimum necessary permissions
211211
- **Regular audits**: Review and clean up unused permissions
212-
- **Test with small amounts**: Start with small emission delegations
212+
- **Test with small amounts**: Start with small stream delegations
213213

214214
### Economic Efficiency
215215

216216
- **Batch operations**: Group related permissions to save gas
217-
- **Monitor performance**: Track ROI on emission delegations
217+
- **Monitor performance**: Track ROI on stream delegations
218218
- **Set reasonable terms**: Balance flexibility with security
219219

220220
### Delegation Strategy
@@ -255,7 +255,7 @@ After creating permissions, you can:
255255
- **Monitor usage**: Track how recipients use delegated permissions
256256
- **Optimize delegation**: Adjust terms based on performance
257257
- **Scale coordination**: Build complex multi-agent workflows
258-
- **Analyze economics**: Review emission delegation ROI
258+
- **Analyze economics**: Review stream delegation ROI
259259

260260
## Support and Resources
261261

@@ -273,7 +273,7 @@ See the [Permission System Documentation](https://docs.torus.network/explanation
273273
<Card title="Permission System" icon="seti:config">
274274
<a href="/explanations/system/permission-system">Deep dive into architecture</a>
275275
</Card>
276-
<Card title="Emission Permissions" icon="seti:shell">
277-
<a href="/explanations/system/emission-permissions">Economic coordination mechanisms</a>
276+
<Card title="Stream Permissions" icon="seti:shell">
277+
<a href="/explanations/system/stream-permissions">Economic coordination mechanisms</a>
278278
</Card>
279279
</CardGrid>

0 commit comments

Comments
 (0)