Skip to content

Commit 43a5a0a

Browse files
refactor: change wording for FSA reference
1 parent bcd1b21 commit 43a5a0a

2 files changed

Lines changed: 14 additions & 8 deletions

File tree

docs/smart-accounts/reference/IMasterAccountController.mdx

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
66
---
77

88
Interface for the `MasterAccountController` contract, which manages personal accounts and executes XRPL instructions on Flare.
9-
Uses the [Diamond pattern](https://eips.ethereum.org/EIPS/eip-2535) to compose all functionality into a single deployed contract.
9+
It uses the [Diamond pattern](https://eips.ethereum.org/EIPS/eip-2535) to compose all functionality into a single deployed contract.
1010

1111
Sourced from `IMasterAccountController.sol` and its facets on [GitHub](https://github.com/flare-foundation/flare-smart-accounts/tree/main/contracts/userInterfaces).
1212

@@ -15,7 +15,8 @@ Sourced from `IMasterAccountController.sol` and its facets on [GitHub](https://g
1515
### `getPersonalAccount`
1616

1717
Returns the [`PersonalAccount`](/smart-accounts/reference/IPersonalAccount) contract address for a given XRPL owner.
18-
If the account has not been deployed yet, it returns the precomputed deterministic address.
18+
A `PersonalAccount` is deployed only once the first instruction has been sent from its owner XRPL address.
19+
If the account has not yet been deployed, it returns the precomputed deterministic address.
1920

2021
```solidity
2122
function getPersonalAccount(
@@ -37,7 +38,7 @@ Returns:
3738

3839
### `executeInstruction`
3940

40-
Executes an XRPL instruction for a given XRPL address using an [Flare Data Connector](/fdc/overview) payment proof.
41+
Executes an XRPL instruction for a given XRPL address using a [Flare Data Connector](/fdc/overview) payment proof.
4142

4243
```solidity
4344
function executeInstruction(
@@ -125,7 +126,7 @@ function getTransactionIdForCollateralReservation(
125126
### `getDefaultInstructionFee`
126127

127128
Returns the default fee applied to instructions without a specific per-instruction fee configured.
128-
Denominated in the underlying asset's smallest unit (e.g., XRP drops).
129+
Denominated in the underlying asset's smallest unit (i.e., XRP drops).
129130

130131
```solidity
131132
function getDefaultInstructionFee()
@@ -135,7 +136,7 @@ function getDefaultInstructionFee()
135136

136137
### `getInstructionFee`
137138

138-
Returns the fee for a specific instruction ID.
139+
Returns the fee for a specific instruction ID (first byte on an encoded instruction).
139140

140141
```solidity
141142
function getInstructionFee(
@@ -170,7 +171,7 @@ Returns:
170171

171172
### `getVaults`
172173

173-
Returns the list of registered vaults (e.g., Firelight, Upshift) with their IDs, addresses, and types.
174+
Returns the list of registered vaults as arrays of their IDs, addresses, and types (Firelight or Upshift).
174175

175176
```solidity
176177
function getVaults()
@@ -186,7 +187,7 @@ Returns:
186187

187188
- `_vaultIds`: The list of registered vault IDs.
188189
- `_vaultAddresses`: The list of vault addresses.
189-
- `_vaultTypes`: The list of vault types (e.g., `1` = Firelight, `2` = Upshift).
190+
- `_vaultTypes`: The list of vault types (`1` = Firelight, `2` = Upshift).
190191

191192
## Executor
192193

docs/smart-accounts/reference/IPersonalAccount.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ keywords: [smart-accounts, xrpl, flare-network, solidity]
55
sidebar_position: 2
66
---
77

8-
Interface for the `PersonalAccount` contract — the per-user smart account on Flare controlled by an XRPL address.
8+
Interface for the `PersonalAccount` contract — Flare account abstraction for an XRPL address, controller entirely by that address.
99

1010
Sourced from `IPersonalAccount.sol` on [GitHub](https://github.com/flare-foundation/flare-smart-accounts/blob/main/contracts/userInterfaces/IPersonalAccount.sol).
1111

@@ -61,6 +61,11 @@ Parameters:
6161
- `executorFee`: The fee paid to the executor.
6262
- `collateralReservationId`: The ID of the collateral reservation.
6363

64+
:::info
65+
This event does not include the necessary information to complete the minting process.
66+
When performing minting, the [`CollateralReserved`](/fassets/reference/IAssetManagerEvents#collateralreserved) event emitted by the `IAssetManager` contract should be observed instead.
67+
:::
68+
6469
### `FXrpTransferred`
6570

6671
Emitted when a transfer of FXRP is made from the personal account.

0 commit comments

Comments
 (0)