Skip to content

Commit 0df0087

Browse files
authored
feat(docs): add agent listing functions to IAssetManager documentation (#856)
1 parent 462a50a commit 0df0087

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

docs/fassets/reference/IAssetManager.mdx

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,48 @@ function fAsset()
8686
returns (IERC20);
8787
```
8888

89+
## Agents
90+
91+
### `getAvailableAgentsList`
92+
93+
Returns the list of available agents.
94+
95+
Parameters:
96+
97+
- `_start`: First index to return from the available agent's list
98+
- `_end`: End index (one above last) to return from the available agent's list
99+
100+
Returns:
101+
102+
- `_agents`: The list of available agents
103+
- `_totalLength`: The total length of the available agents list
104+
105+
```solidity
106+
function getAvailableAgentsList(uint256 _start, uint256 _end)
107+
external view
108+
returns (address[] memory _agents, uint256 _totalLength);
109+
```
110+
111+
### `getAvailableAgentsDetailedList`
112+
113+
Returns the list of available agents with extra information about agents like fee, minimum collateral ratio and available collateral (in lots).
114+
115+
Parameters:
116+
117+
- `_start`: First index to return from the available agent's list
118+
- `_end`: End index (one above last) to return from the available agent's list
119+
120+
Returns:
121+
122+
- `_agents`: The list of available agents with extra information
123+
- `_totalLength`: The total length of the available agents list
124+
125+
```solidity
126+
function getAvailableAgentsDetailedList(uint256 _start, uint256 _end)
127+
external view
128+
returns (AvailableAgentInfo.Data[] memory _agents, uint256 _totalLength);
129+
```
130+
89131
## Redemption Queue
90132

91133
### `redemptionQueue`

0 commit comments

Comments
 (0)