Skip to content

Commit 12ba3e6

Browse files
committed
refactor(docs): remove redundant collateral reservation methods and clarify redemption process
1 parent 287ffa8 commit 12ba3e6

File tree

2 files changed

+0
-62
lines changed

2 files changed

+0
-62
lines changed

docs/fassets/developer-guides/7-fassets-redeem.mdx

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,9 +309,6 @@ The FAssets agent should perform the redemption, and the user must retrieve the
309309
If the agent is unable to redeem the assets on the underlying chain in the specified time.
310310
In that case, the user can execute the [`redemptionPaymentDefault`](/fassets/reference/IAssetManager#redemptionpaymentdefault) function to receive compensation from the agent's collateral.
311311

312-
If the agent rejects the redemption request and no other agent takes over the redemption, the redeemer or appointed executor calls [`rejectedRedemptionPaymentDefault`](/fassets/reference/IAssetManager#rejectedredemptionpaymentdefault) method and receives payment in collateral.
313-
The agent can also call default if the redeemer is unresponsive to payout the redeemer and free the remaining collateral.
314-
315312
## Next Steps
316313

317314
:::tip

docs/fassets/reference/IAssetManager.mdx

Lines changed: 0 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -157,50 +157,6 @@ function reserveCollateral(
157157
) external payable;
158158
```
159159

160-
### `approveCollateralReservation`
161-
162-
Agent approves the collateral reservation request after checking the minter's identity.
163-
164-
Parameters:
165-
166-
- `_collateralReservationId`: Collateral reservation ID
167-
168-
```solidity
169-
function approveCollateralReservation(
170-
uint256 _collateralReservationId
171-
) external notEmergencyPaused;
172-
```
173-
174-
### `rejectCollateralReservation`
175-
176-
Agent rejects the collateral reservation request after checking the minter's identity.
177-
The collateral reservation fee is returned to the minter.
178-
179-
Parameters:
180-
181-
- `_collateralReservationId`: Collateral reservation ID
182-
183-
```solidity
184-
function rejectCollateralReservation(
185-
uint256 _collateralReservationId
186-
) external nonReentrant;
187-
```
188-
189-
### `cancelCollateralReservation`
190-
191-
Minter cancels the collateral reservation request if the agent didn't respond in time.
192-
The collateral reservation fee is returned to the minter.
193-
194-
Parameters:
195-
196-
- `_collateralReservationId`: Collateral reservation ID
197-
198-
```solidity
199-
function cancelCollateralReservation(
200-
uint256 _collateralReservationId
201-
) external nonReentrant;
202-
```
203-
204160
## Execute Minting
205161

206162
### `executeMinting`
@@ -265,21 +221,6 @@ function redemptionPaymentDefault(
265221
) external;
266222
```
267223

268-
### `rejectedRedemptionPaymentDefault`
269-
270-
If the agent rejected the redemption request and no other agent took over the redemption, the redeemer or appointed executor calls this method and receives payment in collateral.
271-
The agent can also call default if the redeemer is unresponsive, to payout the redeemer and free the remaining collateral.
272-
273-
Parameters:
274-
275-
- `_redemptionRequestId`: ID of an existing redemption request
276-
277-
```solidity
278-
function rejectedRedemptionPaymentDefault(
279-
uint256 _redemptionRequestId
280-
) external;
281-
```
282-
283224
## Core Vault Settings
284225

285226
Reference for managing and interacting with FAssets `ICoreVaultSettings` contract which is inherited by the `IAssetManager` contract.

0 commit comments

Comments
 (0)