Skip to content

Commit cf9c1c7

Browse files
authored
docs(user-bot): enhance redemption status documentation (#565)
2 parents a0e22ec + 35ca51e commit cf9c1c7

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

docs/fassets/reference/user-bot.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,12 +155,24 @@ Additionally the custom flag can be specified:
155155

156156
### Redemption Status
157157

158-
The `redemptionStatus` function provides information about the current state of a redemption request in the FAsset system.
158+
The `redemptionStatus` function provides information about the current state of a redemption request in the FAsset system. It lists all open redemptions and their statuses.
159+
160+
Status can be one of the following:
161+
162+
- `PENDING`
163+
- `SUCCESS`
164+
- `DEFAULT`
165+
- `EXPIRED`
159166

160167
```bash
161168
yarn user-bot redemptionStatus
162169
```
163170

171+
Additionally, the custom flag can be specified:
172+
173+
- **`--request-id <requestId>`**
174+
Specifies the request ID of the redemption.
175+
164176
### Update Redemptions
165177

166178
The `updateRedemptions` function updates the status of one or more open redemption requests. It ensures that these requests are processed efficiently and appropriately addresses any unresolved or overdue requests. This function is essential for automating the entire redemption lifecycle.

0 commit comments

Comments
 (0)