Skip to content

Commit b50d5b8

Browse files
feat(docs): add FSA visual resources (#1205)
2 parents 9661a92 + c60dff1 commit b50d5b8

File tree

7 files changed

+32
-0
lines changed

7 files changed

+32
-0
lines changed

docs/smart-accounts/1-overview.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ unlisted: false
1919

2020
import ThemedImage from "@theme/ThemedImage";
2121
import useBaseUrl from "@docusaurus/useBaseUrl";
22+
import YouTubeEmbed from "@site/src/components/YouTubeEmbed";
2223

2324
The Flare Smart Accounts is an account abstraction that allows XRPL users to perform actions on the Flare chain without owning any FLR token.
2425
Each XRPL address is assigned a unique **smart account** on the Flare chain, which only it can control.
@@ -34,6 +35,14 @@ The workflow for Flare Smart Accounts is comprised of the following steps.
3435
It then calls the `executeTransaction` function on the `MasterAccountController` contract, with the `Payment` proof and the XRPL address that made the transaction.
3536
3. The XRPL user's smart account performs the actions given in the instructions.
3637

38+
<ThemedImage
39+
alt="Flare smart accounts workflow"
40+
sources={{
41+
light: useBaseUrl("img/docs/smart-accounts/fsa-workflow-light.png"),
42+
dark: useBaseUrl("img/docs/smart-accounts/fsa-workflow-dark.png"),
43+
}}
44+
/>
45+
3746
## 1. Instructions on XRPL
3847

3948
The Flare Smart Accounts allow XRPL users to perform actions on the Flare chain through instructions on the XRPL.
@@ -235,3 +244,11 @@ Depending on the value of the leading byte, a different function on the smart ac
235244
## 3. Actions on Flare
236245

237246
The XRPL user's smart account performs the actions in the instructions.
247+
This can be any of the instructions listed above, reserving collateral for minting FXRP, transferring FXRP to another address, redeeming FXRP, depositing it into a vault ...
248+
Furthermore, custom instructions can be executed - instructions for making any function call on Flare -, thought that requires an additional step for it to work (see the [Custom Instruction guide](/smart-accounts/3-custom-instruction.mdx))
249+
250+
## Video Tutorials
251+
252+
<YouTubeEmbed videoId="LZ6WI9Zvrn4"></YouTubeEmbed>
253+
254+
<YouTubeEmbed videoId="txYLJV9cHzg"></YouTubeEmbed>

docs/smart-accounts/3-custom-instruction.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,3 +132,13 @@ To obtain the instruction that can be sent as the memo of an XRPL Payment transa
132132
First, we remove the initial two bytes from this hash.
133133
Next, we prepend the hexadecimal value `ff` followed by the `walletId`.
134134
This is the encoded custom instruction.
135+
136+
<ThemedImage
137+
alt="Flare smart accounts custom instruction workflow"
138+
sources={{
139+
light: useBaseUrl(
140+
"img/docs/smart-accounts/fsa-developer-workflow-light.png",
141+
),
142+
dark: useBaseUrl("img/docs/smart-accounts/fsa-developer-workflow-dark.png"),
143+
}}
144+
/>

docs/smart-accounts/guides/typescript-viem/01-state-lookup.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ keywords:
1818

1919
import CodeBlock from "@theme/CodeBlock";
2020
import StateLookupScript from "!!raw-loader!/examples/developer-hub-javascript/smart-accounts/state-lookup.ts";
21+
import YouTubeEmbed from "@site/src/components/YouTubeEmbed";
2122

2223
In this guide, you will learn how to get the following using the Viem TypeScript library:
2324

@@ -293,3 +294,7 @@ export async function getAgentVaults(): Promise<AgentVault[]> {
293294
return vaults;
294295
}
295296
```
297+
298+
## Video Tutorial
299+
300+
<YouTubeEmbed videoId="txYLJV9cHzg"></YouTubeEmbed>
206 KB
Loading
209 KB
Loading
173 KB
Loading
174 KB
Loading

0 commit comments

Comments
 (0)