Skip to content

Commit 22febce

Browse files
authored
feat(docs): add IAgentOwnerRegistry reference and update sidebar positions for agent and user bot (#822)
1 parent bd49efe commit 22febce

File tree

3 files changed

+130
-0
lines changed

3 files changed

+130
-0
lines changed
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
title: IAgentOwnerRegistry
3+
description: FAssets IAgentOwnerRegistry interface reference.
4+
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
5+
sidebar_position: 5
6+
---
7+
8+
Command line reference for interacting with FAssets `AgentOwnerRegistry` contract.
9+
10+
Sourced from `IAgentOwnerRegistry.sol` on [GitHub](https://github.com/flare-foundation/fassets/blob/main/contracts/userInterfaces/IAgentOwnerRegistry.sol).
11+
12+
---
13+
14+
## Overview
15+
16+
The `IAgentOwnerRegistry` interface manages agent owner information and work address mappings in the FAssets system.
17+
18+
## Agent Information Functions
19+
20+
### `getAgentName`
21+
22+
Returns the agent owner's name.
23+
24+
Parameters:
25+
26+
- `_managementAddress`: The agent owner's management address
27+
28+
Returns:
29+
30+
- `string memory`: The agent owner's name
31+
32+
```solidity
33+
function getAgentName(address _managementAddress)
34+
external view
35+
returns (string memory);
36+
```
37+
38+
### `getAgentDescription`
39+
40+
Returns the agent owner's description.
41+
42+
Parameters:
43+
44+
- `_managementAddress`: The agent owner's management address
45+
46+
Returns:
47+
48+
- `string memory`: The agent owner's description
49+
50+
```solidity
51+
function getAgentDescription(address _managementAddress)
52+
external view
53+
returns (string memory);
54+
```
55+
56+
### `getAgentIconUrl`
57+
58+
Returns the URL of the agent owner's icon.
59+
60+
Parameters:
61+
62+
- `_managementAddress`: The agent owner's management address
63+
64+
Returns:
65+
66+
- `string memory`: The URL of the agent owner's icon
67+
68+
```solidity
69+
function getAgentIconUrl(address _managementAddress)
70+
external view
71+
returns (string memory);
72+
```
73+
74+
### `getAgentTermsOfUseUrl`
75+
76+
Returns the URL of the agent's page with terms of use.
77+
78+
Parameters:
79+
80+
- `_managementAddress`: The agent owner's management address
81+
82+
Returns:
83+
84+
- `string memory`: The URL of the agent's terms of use page
85+
86+
```solidity
87+
function getAgentTermsOfUseUrl(address _managementAddress)
88+
external view
89+
returns (string memory);
90+
```
91+
92+
## Address Mapping Functions
93+
94+
### `getWorkAddress`
95+
96+
Gets the unique work address for the given management address.
97+
98+
Parameters:
99+
100+
- `_managementAddress`: The agent owner's management address
101+
102+
Returns:
103+
104+
- `address`: The corresponding work address
105+
106+
```solidity
107+
function getWorkAddress(address _managementAddress)
108+
external view
109+
returns (address);
110+
```
111+
112+
### `getManagementAddress`
113+
114+
Gets the unique management address for the given work address.
115+
116+
Parameters:
117+
118+
- `_workAddress`: The agent owner's work address
119+
120+
Returns:
121+
122+
- `address`: The corresponding management address
123+
124+
```solidity
125+
function getManagementAddress(address _workAddress)
126+
external view
127+
returns (address);
128+
```

docs/fassets/reference/agent-bot.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Agent Bot CLI Reference
33
description: FAssets Agent Bot command line interface reference.
44
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
5+
sidebar_position: 7
56
---
67

78
Command line reference for managing and interacting with FAssets agent bots.

docs/fassets/reference/user-bot.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: User Bot CLI Reference
33
description: FAssets User Bot command line interface reference.
44
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
5+
sidebar_position: 6
56
---
67

78
Command line reference for managing and interacting with FAssets user bot. It allows users to mint and redeem FAssets, manage collateral pools, and query system information.

0 commit comments

Comments
 (0)