Skip to content

Commit 6ede034

Browse files
authored
feat(docs): add getCollateralTypes function to IAssetManager documentation and update operational parameters references (#922)
1 parent 11dd935 commit 6ede034

File tree

2 files changed

+22
-24
lines changed

2 files changed

+22
-24
lines changed

docs/fassets/reference/IAssetManager.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,20 @@ function getAgentInfo(address _agentVault)
3939
returns (AgentInfo.Info memory);
4040
```
4141

42+
### `getCollateralTypes`
43+
44+
Returns the list of all available and deprecated tokens used for collateral types in the FAssets system.
45+
46+
Returns:
47+
48+
- [`CollateralType.Data`](https://github.com/flare-foundation/fassets/blob/main/contracts/userInterfaces/data/CollateralType.sol): Array of collateral type data structures containing information about each supported collateral token.
49+
50+
```solidity
51+
function getCollateralTypes()
52+
external view
53+
returns (CollateralType.Data[] memory);
54+
```
55+
4256
### `collateralReservationFee`
4357

4458
Returns the collateral reservation fee amount.

src/components/FAssets/operational-parameters.ts

Lines changed: 8 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,8 @@ export const operationalParameters = [
258258
},
259259
{
260260
name: "Vault Minimal CR",
261-
settingName: "minimalCR",
261+
functionName: "getCollateralTypes",
262+
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
262263
description:
263264
"The minimum collateral ratio required to avoid liquidation.",
264265
link: "/fassets/collateral#minimal-cr",
@@ -278,7 +279,8 @@ export const operationalParameters = [
278279
},
279280
{
280281
name: "Vault Collateral Safety CR",
281-
settingName: "safetyCR",
282+
functionName: "getCollateralTypes",
283+
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
282284
description: "The collateral ratio required to exit liquidation mode.",
283285
link: "/fassets/collateral#safety-cr",
284286
values: {
@@ -314,7 +316,8 @@ export const operationalParameters = [
314316
},
315317
{
316318
name: "Pool Collateral Pool Minimal CR",
317-
settingName: "minimalCR",
319+
functionName: "getCollateralTypes",
320+
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
318321
description:
319322
"The minimum collateral ratio required to avoid liquidation.",
320323
link: "/fassets/collateral#minimal-cr",
@@ -332,29 +335,10 @@ export const operationalParameters = [
332335
},
333336
},
334337
},
335-
{
336-
name: "Pool Collateral Call Band CR",
337-
settingName: "ccbCR",
338-
description:
339-
"The threshold at which collateral is considered unhealthy but liquidation is delayed.",
340-
link: "/fassets/collateral#liquidation-cr",
341-
values: {
342-
coston2: {
343-
xrp: "1.4",
344-
},
345-
songbird: {
346-
xrp: "1.4",
347-
},
348-
coston: {
349-
xrp: "1.9",
350-
btc: "1.9",
351-
doge: "1.9",
352-
},
353-
},
354-
},
355338
{
356339
name: "Pool Collateral Safety CR",
357-
settingName: "safetyCR",
340+
functionName: "getCollateralTypes",
341+
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
358342
description: "The collateral ratio required to exit liquidation mode.",
359343
link: "/fassets/collateral#safety-cr",
360344
values: {

0 commit comments

Comments
 (0)