Skip to content

Commit 1a476c5

Browse files
fasskofassko
committed
fix(docs): enhance formatting and clarity in Flare Smart Accounts overview
1 parent a318742 commit 1a476c5

1 file changed

Lines changed: 21 additions & 21 deletions

File tree

‎docs/smart-accounts/1-overview.mdx‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ authors: [nikerzetic]
66
description: The Flare Smart Accounts is an account abstraction that performs actions on behalf of XRPL users.
77
tags: [quickstart, ethereum, flare-smart-accounts]
88
keywords:
9-
[
9+
[
1010
flare-fdc,
1111
ethereum,
1212
flare-smart-accounts,
1313
evm,
1414
flare-network,
1515
account-abstraction,
16-
]
16+
]
1717
unlisted: false
1818
---
1919

@@ -41,12 +41,12 @@ Flare Smart Accounts support two complementary flows for turning an XRPL `Paymen
4141
sources={{
4242
light: useBaseUrl("img/docs/smart-accounts/fsa-workflow-light.png"),
4343
dark: useBaseUrl("img/docs/smart-accounts/fsa-workflow-dark.png"),
44-
}}
44+
}}
4545
/>
4646

4747
<p style={{ textAlign: "center", fontStyle: "italic" }}>
48-
Proof-based flow: XRPL `Payment` (1) → operator backend (2) → FDC attestation
49-
(3, 4) → `MasterAccountController` (5) → `PersonalAccount` (6).
48+
Proof-based flow: XRPL `Payment` (1) → operator backend (2) → FDC attestation
49+
(3, 4) → `MasterAccountController` (5) → `PersonalAccount` (6).
5050
</p>
5151

5252
### Direct-minting (memo) flow
@@ -81,10 +81,10 @@ graph TB
8181
```
8282

8383
<p style={{ textAlign: "center", fontStyle: "italic" }}>
84-
Direct-minting flow: XRPL `Payment` carrying a memo (1) → FAssets agent (2) →
85-
executor calls `AssetManager.executeDirectMinting` (3) → `AssetManager` mints
86-
FXRP and calls back into `mintedFAssets` (4) → `MasterAccountController`
87-
forwards FXRP and dispatches the memo to the user's `PersonalAccount` (5).
84+
Direct-minting flow: XRPL `Payment` carrying a memo (1) → FAssets agent (2) →
85+
executor calls `AssetManager.executeDirectMinting` (3) → `AssetManager` mints
86+
FXRP and calls back into `mintedFAssets` (4) → `MasterAccountController`
87+
forwards FXRP and dispatches the memo to the user's `PersonalAccount` (5).
8888
</p>
8989

9090
## Instructions on XRPL
@@ -119,9 +119,9 @@ Instructions for interacting with the `FXRP` token.
119119

120120
| Command ID | Action | Description |
121121
| ---------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
122-
| `00` | `collateralReservation` | Reserve a `value` of lots of collateral in the agent vault, registered with the `agentVaultId` with the `MasterAccountController` contract. |
123-
| `01` | `transfer` | Transfer a `value` (in drops) of FXRP to the `recipientAddress`. |
124-
| `02` | `redeem` | Redeem a `value` of lots of FXRP. |
122+
| `00` | `collateralReservation` | Reserve a `value` of lots of collateral in the agent vault, registered with the `agentVaultId` with the `MasterAccountController` contract. |
123+
| `01` | `transfer` | Transfer a `value` (in drops) of FXRP to the `recipientAddress`. |
124+
| `02` | `redeem` | Redeem a `value` of lots of FXRP. |
125125

126126
### Firelight
127127

@@ -131,10 +131,10 @@ Instructions for interacting with a Firelight-type vault.
131131

132132
| Command ID | Action | Description |
133133
| ---------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
134-
| `00` | `collateralReservationAndDeposit` | Reserve a `value` of lots of collateral in the agent vault, registered with the `agentVaultId` with the `MasterAccountController` contract. After successful minting, deposit the FXRP into the Firelight type vault, registered with the `vaultId` with the `MasterAccountController` contract. Equivalent to sending a `collateralReservation` instruction and a Firelight `deposit` instruction. |
135-
| `01` | `deposit` | Deposit a `value` of FXRP into the Firelight type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
136-
| `02` | `redeem` | Start the withdrawal process for a `value` of vault shares (in drops) from the Firelight type vault, registered with the `vaultId`, with the `MasterAccountController` contract. |
137-
| `03` | `claimWithdraw` | Withdraw the `FXRP`, requested in the `value` period, from the Firelight type vault, registered with the `vaultId`, with the `MasterAccountController` contract. |
134+
| `00` | `collateralReservationAndDeposit` | Reserve a `value` of lots of collateral in the agent vault, registered with the `agentVaultId` with the `MasterAccountController` contract. After successful minting, deposit the FXRP into the Firelight type vault, registered with the `vaultId` with the `MasterAccountController` contract. Equivalent to sending a `collateralReservation` instruction and a Firelight `deposit` instruction. |
135+
| `01` | `deposit` | Deposit a `value` of FXRP into the Firelight type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
136+
| `02` | `redeem` | Start the withdrawal process for a `value` of vault shares (in drops) from the Firelight type vault, registered with the `vaultId`, with the `MasterAccountController` contract. |
137+
| `03` | `claimWithdraw` | Withdraw the `FXRP`, requested in the `value` period, from the Firelight type vault, registered with the `vaultId`, with the `MasterAccountController` contract. |
138138

139139
### Upshift
140140

@@ -144,10 +144,10 @@ Instructions for interacting with an Upshift-type vault.
144144

145145
| Command ID | Action | Description |
146146
| ---------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
147-
| `00` | `collateralReservationAndDeposit` | Reserve a `value` of lots of collateral in the agent vault, registered with the `agentVaultId` with the `MasterAccountController` contract. After successful minting, deposit the FXRP into the Upshift type vault, registered with the `vaultId`, with the `MasterAccountController` contract. Equivalent to sending a `collateralReservation` instruction and a Upshift `deposit` instruction. |
148-
| `01` | `deposit` | Deposit a `value` of FXRP into the Upshift type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
149-
| `02` | `requestRedeem` | Start the withdrawal process for a `value` of vault shares (in drops) from the Upshift type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
150-
| `03` | `claim` | Withdraw the `FXRP` requested for the `value` date (encoded as `yyyymmdd`) from the Upshift type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
147+
| `00` | `collateralReservationAndDeposit` | Reserve a `value` of lots of collateral in the agent vault, registered with the `agentVaultId` with the `MasterAccountController` contract. After successful minting, deposit the FXRP into the Upshift type vault, registered with the `vaultId`, with the `MasterAccountController` contract. Equivalent to sending a `collateralReservation` instruction and a Upshift `deposit` instruction. |
148+
| `01` | `deposit` | Deposit a `value` of FXRP into the Upshift type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
149+
| `02` | `requestRedeem` | Start the withdrawal process for a `value` of vault shares (in drops) from the Upshift type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
150+
| `03` | `claim` | Withdraw the `FXRP` requested for the `value` date (encoded as `yyyymmdd`) from the Upshift type vault, registered with the `vaultId` with the `MasterAccountController` contract. |
151151

152152
</details>
153153

@@ -159,7 +159,7 @@ The operator monitors incoming transactions to the specified XRPL address.
159159
Upon receiving a payment, it requests a [`Payment` attestation](/fdc/attestation-types/payment) from the FDC and submits the proof together with the user's XRPL address to the appropriate facet on the `MasterAccountController`:
160160

161161
- [`reserveCollateral`](/smart-accounts/reference/IMasterAccountController#reservecollateral) — for command `00` of any instruction type.
162-
Takes the payment reference and XRPL transaction ID (no FDC proof needed at this stage, the user has only committed to mint).
162+
Takes the payment reference and XRPL transaction ID (no FDC proof needed at this stage, the user has only committed to mint).
163163
- [`executeDepositAfterMinting`](/smart-accounts/reference/IMasterAccountController#executedepositafterminting) — second leg of the Firelight/Upshift collateral-reservation-and-deposit instructions, after FAssets minting completes.
164164
- [`executeInstruction`](/smart-accounts/reference/IMasterAccountController#executeinstruction) — for all other reference-encoded instructions.
165165

0 commit comments

Comments
 (0)