Skip to content

Commit d04a381

Browse files
committed
fix(docs): clarify minting and redemption requirements to specify positive integers of lots
1 parent 0617a49 commit d04a381

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

docs/fassets/3-minting.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ The choice is based on the minting fee or the amount of free collateral, which m
3030
The minter sends to the Asset Manager contract a collateral reservation transaction (CRT). The CRT includes:
3131

3232
- The address of the chosen agent.
33-
- The amount to mint, which must be a whole number of [lots](/fassets/minting#lots).
33+
- The amount to mint, which must be a positive integer of [lots](/fassets/minting#lots).
3434
- The [collateral reservation fee (CRF)](#fees) to compensate for the locked collateral.
3535
- The executor's address, if the minter is not the executor.
3636
- The executor's fee, if the minter is not the executor.
@@ -265,7 +265,7 @@ The following example shows how the redemption queue works.
265265

266266
## Lots
267267

268-
Every minting and redemption must be made in a whole number of lots.
268+
Every minting and redemption must be made in a positive integer of lots.
269269
Lots serve the following purposes:
270270

271271
- They prevent underlying transaction fees from exceeding minting or redemption fees.
@@ -284,9 +284,9 @@ Some processes generate a fractional number of lots:
284284

285285
- On minting, part of the minting fee is minted as the FAsset fee to the collateral pool.
286286
This value is usually less than 1 lot.
287-
- When the lot size is changed, redemptions close only a whole number of lots of each redemption ticket, which leaves the remainder unredeemed.
287+
- When the lot size is changed, redemptions close only a positive integer of lots of each redemption ticket, which leaves the remainder unredeemed.
288288

289-
These amounts, known as dust, cannot be redeemed directly because redemption requires a whole number of lots.
289+
These amounts, known as dust, cannot be redeemed directly because redemption requires a positive integer of lots.
290290

291291
In such cases, the generated dust is not included in any redemption ticket.
292292
Instead, each agent's dust is accumulated until the dust amounts to a whole lot.

docs/fassets/4-redemption.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To do so, these holders, known as redeemers, send FAssets to the Asset Manager s
1111

1212
This is the summary of the redemption process:
1313

14-
1. The redeemer starts the redemption for a whole number of lots by issuing a request to the Asset Manager smart contract.
14+
1. The redeemer starts the redemption for a positive integer of lots by issuing a request to the Asset Manager smart contract.
1515

1616
The FAssets system chooses one or more redemption tickets from the front of the [FIFO redemption queue](/fassets/minting#redemption-tickets-and-the-redemption-queue).
1717
The number of chosen redemption tickets is capped to avoid high gas consumption.
@@ -135,4 +135,4 @@ As shown in the following process, agents can self-redeem for any reason, includ
135135
3. The collateral that was backing those assets is released.
136136
4. The underlying collateral is released and can be withdrawn from the underlying address later.
137137

138-
The self-redeemed amount is not limited to a whole number of lots and can be less than 1 lot, which makes self-closing ideal for redeeming an agent's dust.
138+
The self-redeemed amount is not limited to a positive integer of lots and can be less than 1 lot, which makes self-closing ideal for redeeming an agent's dust.

0 commit comments

Comments
 (0)