Skip to content

feat(docs): add getCollateralTypes function to IAssetManager documentation and update operational parameters references #922

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fassko merged 1 commit into from
Sep 17, 2025
Merged

feat(docs): add getCollateralTypes function to IAssetManager documentation and update operational parameters references #922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/fassets/reference/IAssetManager.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ function getAgentInfo(address _agentVault)
returns (AgentInfo.Info memory);
```

### `getCollateralTypes`

Returns the list of all available and deprecated tokens used for collateral types in the FAssets system.

Returns:

- [`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.

```solidity
function getCollateralTypes()
external view
returns (CollateralType.Data[] memory);
```

### `collateralReservationFee`

Returns the collateral reservation fee amount.
Expand Down
32 changes: 8 additions & 24 deletions src/components/FAssets/operational-parameters.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,7 +258,8 @@ export const operationalParameters = [
},
{
name: "Vault Minimal CR",
settingName: "minimalCR",
functionName: "getCollateralTypes",
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
description:
"The minimum collateral ratio required to avoid liquidation.",
link: "/fassets/collateral#minimal-cr",
Expand All @@ -278,7 +279,8 @@ export const operationalParameters = [
},
{
name: "Vault Collateral Safety CR",
settingName: "safetyCR",
functionName: "getCollateralTypes",
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
description: "The collateral ratio required to exit liquidation mode.",
link: "/fassets/collateral#safety-cr",
values: {
Expand Down Expand Up @@ -314,7 +316,8 @@ export const operationalParameters = [
},
{
name: "Pool Collateral Pool Minimal CR",
settingName: "minimalCR",
functionName: "getCollateralTypes",
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
description:
"The minimum collateral ratio required to avoid liquidation.",
link: "/fassets/collateral#minimal-cr",
Expand All @@ -332,29 +335,10 @@ export const operationalParameters = [
},
},
},
{
name: "Pool Collateral Call Band CR",
settingName: "ccbCR",
description:
"The threshold at which collateral is considered unhealthy but liquidation is delayed.",
link: "/fassets/collateral#liquidation-cr",
values: {
coston2: {
xrp: "1.4",
},
songbird: {
xrp: "1.4",
},
coston: {
xrp: "1.9",
btc: "1.9",
doge: "1.9",
},
},
},
{
name: "Pool Collateral Safety CR",
settingName: "safetyCR",
functionName: "getCollateralTypes",
interfaceLink: "/fassets/reference/IAssetManager#getcollateraltypes",
description: "The collateral ratio required to exit liquidation mode.",
link: "/fassets/collateral#safety-cr",
values: {
Expand Down