You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/smart-accounts/reference/IMasterAccountController.mdx
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ sidebar_position: 1
6
6
---
7
7
8
8
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.
10
10
11
11
Sourced from `IMasterAccountController.sol` and its facets on [GitHub](https://github.com/flare-foundation/flare-smart-accounts/tree/main/contracts/userInterfaces).
12
12
@@ -15,7 +15,8 @@ Sourced from `IMasterAccountController.sol` and its facets on [GitHub](https://g
15
15
### `getPersonalAccount`
16
16
17
17
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.
19
20
20
21
```solidity
21
22
function getPersonalAccount(
@@ -37,7 +38,7 @@ Returns:
37
38
38
39
### `executeInstruction`
39
40
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.
41
42
42
43
```solidity
43
44
function executeInstruction(
@@ -125,7 +126,7 @@ function getTransactionIdForCollateralReservation(
125
126
### `getDefaultInstructionFee`
126
127
127
128
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).
129
130
130
131
```solidity
131
132
function getDefaultInstructionFee()
@@ -135,7 +136,7 @@ function getDefaultInstructionFee()
135
136
136
137
### `getInstructionFee`
137
138
138
-
Returns the fee for a specific instruction ID.
139
+
Returns the fee for a specific instruction ID (first byte on an encoded instruction).
139
140
140
141
```solidity
141
142
function getInstructionFee(
@@ -170,7 +171,7 @@ Returns:
170
171
171
172
### `getVaults`
172
173
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).
174
175
175
176
```solidity
176
177
function getVaults()
@@ -186,7 +187,7 @@ Returns:
186
187
187
188
-`_vaultIds`: The list of registered vault IDs.
188
189
-`_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).
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.
9
9
10
10
Sourced from `IPersonalAccount.sol` on [GitHub](https://github.com/flare-foundation/flare-smart-accounts/blob/main/contracts/userInterfaces/IPersonalAccount.sol).
11
11
@@ -61,6 +61,11 @@ Parameters:
61
61
-`executorFee`: The fee paid to the executor.
62
62
-`collateralReservationId`: The ID of the collateral reservation.
63
63
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
+
64
69
### `FXrpTransferred`
65
70
66
71
Emitted when a transfer of FXRP is made from the personal account.
0 commit comments