feat(docs): add guide for listing FAssets agents and update IAssetManager reference#962
Merged
feat(docs): add guide for listing FAssets agents and update IAssetManager reference#962
Conversation
fassko
force-pushed
the
feat/fassets-list-agents
branch
from
ed8b44a to
0b0c6ad
Compare
nikerzetic-aflabs
requested changes
Oct 15, 2025
|
|
||
| And return two values: | ||
|
|
||
| - `_agents`: Array of agent information structures. |
Collaborator
There was a problem hiding this comment.
structures or structs?
|
|
||
| Returns: | ||
|
|
||
| - `_agents`: The list of all agents. |
Collaborator
There was a problem hiding this comment.
It doesn't return a list of all agents though, right?
| - `_start`: First index to return from the available agent's list | ||
| - `_end`: End index (one above last) to return from the available agent's list | ||
| - `_start`: First index to return from the available agent's list. | ||
| - `_end`: End index (one above last) to return from the available agent's list. |
Collaborator
There was a problem hiding this comment.
End index (exclusive)...
|
|
||
| - `_start`: First index to return from the available agent's list | ||
| - `_end`: End index (one above last) to return from the available agent's list | ||
| - `_start`: First index to return from the available agent's list. |
Collaborator
There was a problem hiding this comment.
Start index (inclusive)...
|
|
||
| - `_agents`: The list of available agents | ||
| - `_totalLength`: The total length of the available agents list | ||
| - `_agents`: The list of available agents. |
|
|
||
| - `_start`: First index to return from the available agent's list | ||
| - `_end`: End index (one above last) to return from the available agent's list | ||
| - `_start`: First index to return from the available agent's list. |
|
|
||
| - `_queue`: the (part of) the redemption queue; maximum length is \_pageSize | ||
| - `_nextRedemptionTicketId`: works as a cursor - if the `_pageSize` is reached and there are more tickets, it is the first ticket id not returned; if the end is reached, it is 0 | ||
| - `_queue`: the (part of) the redemption queue; maximum length is \_pageSize. |
Collaborator
There was a problem hiding this comment.
the (part of) redemption queue
|
|
||
| - `_firstRedemptionTicketId`: the ticket id to start listing from; if `0`, starts from the beginning | ||
| - `_pageSize`: the maximum number of redemption tickets to return | ||
| - `_firstRedemptionTicketId`: the ticket id to start listing from; if `0`, starts from the beginning. |
Collaborator
There was a problem hiding this comment.
Above you start with a capital letter after the :, here with the lowercase letter.
| - `_agentVault`: the agent vault address of the queried agent | ||
| - `_firstRedemptionTicketId`: the ticket id to start listing from; if `0`, starts from the beginning | ||
| - `_pageSize`: the maximum number of redemption tickets to return | ||
| - `_agentVault`: the agent vault address of the queried agent. |
|
|
||
| - `_queue`: the (part of) the redemption queue; maximum length is \_pageSize | ||
| - `_nextRedemptionTicketId`: works as a cursor - if the` _pageSize` is reached and there are more tickets, it is the first ticket id not returned; if the end is reached, it is 0 | ||
| - `_queue`: the (part of) the redemption queue; maximum length is \_pageSize. |
fassko
force-pushed
the
feat/fassets-list-agents
branch
from
0b0c6ad to
631523e
Compare
nikerzetic-aflabs
requested changes
Oct 16, 2025
| - `_start`: First index to return from the available agent's list. | ||
| - `_end`: End index (one above last) to return from the available agent's list. | ||
| - `_start`: First index to return from the available agent's list (inclusive). | ||
| - `_end`: End index (one above last) to return from the available agent's list (exclusive). |
Collaborator
There was a problem hiding this comment.
What I tried to point out is that I don't like the combination of words first and end. It's either first and last or starting/start and end. Also, (one above last) should be replaced with (exclusive).
… in IAssetManager reference
fassko
force-pushed
the
feat/fassets-list-agents
branch
from
29850c0 to
7b5ac49
Compare
nikerzetic-aflabs
approved these changes
Oct 17, 2025
dineshpinto
approved these changes
Oct 17, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.