Skip to content

Commit b8fa7e7

Browse files
committed
feat(docs): enhance IAssetManager documentation with direct minting functions and operational parameters
1 parent 7edf2a5 commit b8fa7e7

2 files changed

Lines changed: 134 additions & 10 deletions

File tree

docs/fassets/reference/IAssetManager.mdx

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ function fAsset()
9898
returns (IERC20);
9999
```
100100

101+
## Direct Minting Settings
102+
101103
### `directMintingPaymentAddress`
102104

103105
Gets the payment address to which the underlying assets must be sent for direct minting.
@@ -108,6 +110,108 @@ function directMintingPaymentAddress()
108110
returns (string memory);
109111
```
110112

113+
### `getDirectMintingMinimumFeeUBA`
114+
115+
Returns the minimum direct minting fee in UBA.
116+
117+
```solidity
118+
function getDirectMintingMinimumFeeUBA()
119+
external view
120+
returns (uint256);
121+
```
122+
123+
### `getDirectMintingFeeBIPS`
124+
125+
Returns the direct minting fee in BIPS.
126+
127+
```solidity
128+
function getDirectMintingFeeBIPS()
129+
external view
130+
returns (uint256);
131+
```
132+
133+
### `getDirectMintingExecutorFeeUBA`
134+
135+
Returns the direct minting executor fee in UBA.
136+
137+
```solidity
138+
function getDirectMintingExecutorFeeUBA()
139+
external view
140+
returns (uint256);
141+
```
142+
143+
### `getDirectMintingOthersCanExecuteAfterSeconds`
144+
145+
Returns the time in seconds after which anyone can execute a direct minting request.
146+
147+
```solidity
148+
function getDirectMintingOthersCanExecuteAfterSeconds()
149+
external view
150+
returns (uint256);
151+
```
152+
153+
### `getDirectMintingHourlyLimitUBA`
154+
155+
Returns the hourly direct minting limit in UBA.
156+
157+
```solidity
158+
function getDirectMintingHourlyLimitUBA()
159+
external view
160+
returns (uint256);
161+
```
162+
163+
### `getDirectMintingDailyLimitUBA`
164+
165+
Returns the daily direct minting limit in UBA.
166+
167+
```solidity
168+
function getDirectMintingDailyLimitUBA()
169+
external view
170+
returns (uint256);
171+
```
172+
173+
### `getDirectMintingLargeMintingThresholdUBA`
174+
175+
Returns the threshold above which direct minting is considered large, in UBA.
176+
177+
```solidity
178+
function getDirectMintingLargeMintingThresholdUBA()
179+
external view
180+
returns (uint256);
181+
```
182+
183+
### `getDirectMintingLargeMintingDelaySeconds`
184+
185+
Returns the delay in seconds applied to large direct mintings.
186+
187+
```solidity
188+
function getDirectMintingLargeMintingDelaySeconds()
189+
external view
190+
returns (uint256);
191+
```
192+
193+
### `getDirectMintingFeeReceiver`
194+
195+
Returns the address that receives direct minting fees.
196+
197+
```solidity
198+
function getDirectMintingFeeReceiver()
199+
external view
200+
returns (address);
201+
```
202+
203+
## Redeem With Tag Settings
204+
205+
### `minimumRedeemAmountUBA`
206+
207+
Returns the minimum redeem amount in UBA for redeem with tag.
208+
209+
```solidity
210+
function minimumRedeemAmountUBA()
211+
external view
212+
returns (uint256);
213+
```
214+
111215
### `getMintingTagManager`
112216

113217
Returns the minting tag manager contract address.

src/features/FAssets/OperationalParameters/operational-parameters.ts

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1253,7 +1253,9 @@ export const operationalParameters = [
12531253
parameters: [
12541254
{
12551255
name: "Direct Minting Minimum Fee",
1256-
settingName: "directMintingMinimumFee",
1256+
functionName: "getDirectMintingMinimumFeeUBA",
1257+
interfaceLink:
1258+
"/fassets/reference/IAssetManager#getdirectmintingminimumfeeuba",
12571259
description:
12581260
"Minimum fee charged for direct minting, in base unit of the underlying asset (UBA).",
12591261
values: {
@@ -1273,7 +1275,9 @@ export const operationalParameters = [
12731275
},
12741276
{
12751277
name: "Direct Minting Fee",
1276-
settingName: "directMintingFeeBIPS",
1278+
functionName: "getDirectMintingFeeBIPS",
1279+
interfaceLink:
1280+
"/fassets/reference/IAssetManager#getdirectmintingfeebips",
12771281
description:
12781282
"Direct minting fee as a percentage of the minting amount, in BIPS.",
12791283
values: {
@@ -1293,7 +1297,9 @@ export const operationalParameters = [
12931297
},
12941298
{
12951299
name: "Direct Minting Executor Fee",
1296-
settingName: "directMintingExecutorFeeUBA",
1300+
functionName: "getDirectMintingExecutorFeeUBA",
1301+
interfaceLink:
1302+
"/fassets/reference/IAssetManager#getdirectmintingexecutorfeeuba",
12971303
description:
12981304
"Fee paid to the executor of a direct minting request, in base unit of the underlying asset (UBA). This only applies to direct mintings to address, for direct minting to smart account the executor fee is calculated and paid by the smart account manager.",
12991305
values: {
@@ -1313,7 +1319,9 @@ export const operationalParameters = [
13131319
},
13141320
{
13151321
name: "Direct Minting Others Can Execute After",
1316-
settingName: "directMintingOthersCanExecuteAfterSeconds",
1322+
functionName: "getDirectMintingOthersCanExecuteAfterSeconds",
1323+
interfaceLink:
1324+
"/fassets/reference/IAssetManager#getdirectmintingotherscanexecuteafterseconds",
13171325
description:
13181326
"Time in seconds after which anyone can execute a direct minting request (not just the executor set by the minter).",
13191327
values: {
@@ -1333,7 +1341,9 @@ export const operationalParameters = [
13331341
},
13341342
{
13351343
name: "Direct Minting Hourly Limit",
1336-
settingName: "directMintingHourlyLimitUBA",
1344+
functionName: "getDirectMintingHourlyLimitUBA",
1345+
interfaceLink:
1346+
"/fassets/reference/IAssetManager#getdirectmintinghourlylimituba",
13371347
description:
13381348
"Maximum amount that can be directly minted per hour, in base unit of the underlying asset (UBA). After that the mintings are delayed.",
13391349
values: {
@@ -1353,7 +1363,9 @@ export const operationalParameters = [
13531363
},
13541364
{
13551365
name: "Direct Minting Daily Limit",
1356-
settingName: "directMintingDailyLimitUBA",
1366+
functionName: "getDirectMintingDailyLimitUBA",
1367+
interfaceLink:
1368+
"/fassets/reference/IAssetManager#getdirectmintingdailylimituba",
13571369
description:
13581370
"Maximum amount that can be directly minted per day, in base unit of the underlying asset (UBA). After that the mintings are delayed.",
13591371
values: {
@@ -1373,7 +1385,9 @@ export const operationalParameters = [
13731385
},
13741386
{
13751387
name: "Direct Minting Large Minting Threshold",
1376-
settingName: "directMintingLargeMintingThresholdUBA",
1388+
functionName: "getDirectMintingLargeMintingThresholdUBA",
1389+
interfaceLink:
1390+
"/fassets/reference/IAssetManager#getdirectmintinglargemintingthresholduba",
13771391
description:
13781392
"Threshold above which a direct minting is considered large, in base unit of the underlying asset (UBA). Large mintings are always delayed.",
13791393
values: {
@@ -1393,7 +1407,9 @@ export const operationalParameters = [
13931407
},
13941408
{
13951409
name: "Direct Minting Large Minting Delay",
1396-
settingName: "directMintingLargeMintingDelaySeconds",
1410+
functionName: "getDirectMintingLargeMintingDelaySeconds",
1411+
interfaceLink:
1412+
"/fassets/reference/IAssetManager#getdirectmintinglargemintingdelayseconds",
13971413
description:
13981414
"Delay in seconds imposed on large direct mintings before they can be executed.",
13991415
values: {
@@ -1413,7 +1429,9 @@ export const operationalParameters = [
14131429
},
14141430
{
14151431
name: "Direct Minting Fee Receiver",
1416-
settingName: "directMintingFeeReceiver",
1432+
functionName: "getDirectMintingFeeReceiver",
1433+
interfaceLink:
1434+
"/fassets/reference/IAssetManager#getdirectmintingfeereceiver",
14171435
description: "Address that receives the direct minting fee.",
14181436
values: {
14191437
flare: {
@@ -1437,7 +1455,9 @@ export const operationalParameters = [
14371455
parameters: [
14381456
{
14391457
name: "Minimum Redeem Amount",
1440-
settingName: "minimumRedeemAmount",
1458+
functionName: "minimumRedeemAmountUBA",
1459+
interfaceLink:
1460+
"/fassets/reference/IAssetManager#minimumredeemamountuba",
14411461
description:
14421462
"Minimum amount that can be redeemed, in base unit of the underlying asset (UBA).",
14431463
values: {

0 commit comments

Comments
 (0)