Skip to content

Commit

Permalink
feat(docs): add vault operations section and related images to FAsset…
Browse files Browse the repository at this point in the history
…s Agent UI guide
  • Loading branch information
fassko committed Dec 9, 2024
1 parent 9e28518 commit 09f984d
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions docs/fassets/guides/2-create-fasset-agent-ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ keywords: [fassets, xrp, btc, doge flare-network, flare-network]
import FAssetsAgentInterface from "/static/img/fassets/fassets-agent.png";
import FAssetsAgentInterfaceAddVault from "/static/img/fassets/fassets-agent-add-vault.png";
import FAssetsAgentInterfaceAddVaultForm from "/static/img/fassets/fassets-agent-add-vault-form.png";
import FAssetsAgentInterfaceVaultOperations from "/static/img/fassets/fassets-agent-vault-operations.png";

The FAssets Agent user interface (UI) is designed to provide a seamless and intuitive experience for users managing the FAssets agent. It allows users to monitor the agent bot and create and manage FAssets agent vaults.

Expand All @@ -30,6 +31,59 @@ You will be prompted to enter the required information for the vault.

Once you have saved the information and initiated the process, please allow some time for the Flare Data Connector (FDC) to verify the details and create the vault. This can take up to five minutes. You can monitor the status of the vault creation in the Agent Bots list.

## Changing Agent Vault Settings

1. In the **Vaults** section on the dashboard, locate the agent vault you want to modify, and click the three dots icon in the **Actions** column.
The **Vault options** menu is displayed.

<img src={FAssetsAgentInterfaceVaultOperations} />

2. In the **Vaults** section on the dashboard, locate the agent vault you want to modify, and click the three dots icon in the **Actions** column.
The **Vault options** menu is displayed.

3. Click **Edit** at the top of the page.

4. Update your settings.
These settings always have [time locks](/fassets/operational-parameters#time-locks) to minimize abuse.
During the Open Beta, the time-locks are further reduced so that you can try different configurations.
Before you save your updates, ensure you understand the time-locks associated with settings you are changing.

5. Click **Save and execute**.

## Depositing Vault Collateral

1. In the **Vaults** section on the dashboard, locate the vault you want to update, and click the three dots icon in the **Actions** column.
The **Vault options** menu is displayed.

2. In the **Agent Vault Operations** section you have three options:

- **Deposit Collateral (Lots)**: Deposit collateral into the vault in lots.
- **Deposit Vault Collateral**: Deposit collateral into the agent vault.
- **Deposit Pool Collateral**: Deposit collateral into the agent pool.

## Activating Vault

Activating a vault makes it publicly available for minting FAssets.
To be activated, a vault must contain at least 1 [lot](/fassets/minting#lots) for minting.

To activate a vault: 1. On the dashboard, locate the vault you want to activate, and click the three dots icon in the **Actions** column.
The **Vault options** menu is displayed. 2. In the **Agent Vault Operations** section, click **Activate Vault (Enter)**.
The **Activate Vault** window is displayed. 3. Read the message in the **Activate Vault** window about minting requirements, ensure your vault contains at least 1 lot to meet the requirement, and then click **Confirm** to activate the vault.
A confirmation message is displayed.

## Closing Vaults

Closing a vault makes it unavailable for minting FAssets.

To close a vault:

1. On the dashboard, locate the vault you want to close, and click the three dots icon in the **Actions** column.
The **Vault options** menu is displayed.
2. In the **Agent Vault Operations** section, click **Close Vault (Exit)**.
The **Deactivate Vault** window is displayed.
3. Ensure you want to close the vault, and click **Confirm** to close it.
A confirmation message is displayed.

:::tip[What's next]

You can use the FAssets Agent UI to manage your agent vaults, monitor the agent bot, and perform various actions related to the FAssets agent.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 09f984d

Please sign in to comment.