Skip to content

Commit addf312

Browse files
committed
docs(fassets): add IAssetManager reference and update operational parameters page
1 parent 8e0f92e commit addf312

File tree

2 files changed

+50
-10
lines changed

2 files changed

+50
-10
lines changed

docs/fassets/6-operational-parameters.mdx

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,46 +12,52 @@ import OperationalParameters from "/src/components/FAssets/OperationalParameters
1212

1313
This page lists the current values for the most important parameters of the FAssets system on **Songbird Canary-Network** and **Songbird Testnet Coston**. These values are subject to change as the system is further developed and tested.
1414

15-
## Minting and Redeeming
15+
## Asset Manager Operational Parameters
16+
17+
To get the default agent settings, you need to call the `getSettings` function on the `IAssetManager` interface. Read more about the `IAssetManager` interface [here](/fassets/reference/IAssetManager).
18+
19+
### Minting and Redeeming
1620

1721
<OperationalParameters sectionTitle="Minting and Redeeming" />
1822

19-
## Payment Times
23+
### Payment Times
2024

2125
<OperationalParameters sectionTitle="Payment Times" />
2226

23-
## Collateral Ratios
27+
### Collateral Ratios
2428

2529
<OperationalParameters sectionTitle="Collateral Ratios" />
2630

27-
## Liquidation
31+
### Liquidation
2832

2933
<OperationalParameters sectionTitle="Liquidation" />
3034

31-
## Rewarding
35+
### Rewarding
3236

3337
<OperationalParameters sectionTitle="Rewarding" />
3438

35-
## Time Locks
39+
### Time Locks
3640

3741
<OperationalParameters sectionTitle="Time Locks" />
3842

39-
## Emergency Pause
43+
### Emergency Pause
4044

4145
<OperationalParameters sectionTitle="Emergency Pause" />
4246

43-
## FAssets Upgrade
47+
### FAssets Upgrade
4448

4549
<OperationalParameters sectionTitle="FAssets Upgrade" />
4650

47-
## Transfer Fees
51+
### Transfer Fees
4852

4953
<OperationalParameters sectionTitle="Transfer Fees" />
5054

51-
## Handshake
55+
### Handshake
5256

5357
<OperationalParameters sectionTitle="Handshake" />
5458

5559
## Default Agent Settings
5660

61+
To get the default agent settings, you need to call the `getAgentInfo` function on the `IAssetManager` interface. Read more about the `IAssetManager` interface [here](/fassets/reference/IAssetManager).
62+
5763
<OperationalParameters sectionTitle="Default Agent Settings" />
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: IAssetManager
3+
description: FAssets IAssetManager interface reference.
4+
keywords: [fassets, xrp, bitcoin, dogecoin, flare-network]
5+
---
6+
7+
Command line reference for managing and interacting with FAssets `IAssetManager`.
8+
9+
Sourced from `IAssetManager.sol` on [GitHub](https://github.com/flare-labs-ltd/fassets/blob/main/contracts/userInterfaces/IAssetManager.sol).
10+
11+
## Functions
12+
13+
### `getSettings`
14+
15+
Returns the complete asset manager settings.
16+
Returns the [`AssetManagerSettings`](https://github.com/flare-labs-ltd/fassets/blob/main/contracts/userInterfaces/data/AssetManagerSettings.sol) struct.
17+
18+
```solidity
19+
function getSettings()
20+
external view
21+
returns (AssetManagerSettings.Data memory);
22+
```
23+
24+
### `getAgentInfo`
25+
26+
Return detailed info about an agent.
27+
Returns the [`AgentInfo`](https://github.com/flare-labs-ltd/fassets/blob/main/contracts/userInterfaces/data/AgentInfo.sol) struct.
28+
Need to provide the agent vault address.
29+
30+
```solidity
31+
function getAgentInfo(address _agentVault)
32+
external view
33+
returns (AgentInfo.Info memory);
34+
```

0 commit comments

Comments
 (0)