Skip to content

Commit 17e6228

Browse files
committed
feat(docs): enhance Firelight vault documentation with withdrawal and redemption guides
1 parent d7dfb3a commit 17e6228

File tree

8 files changed

+19
-12
lines changed

8 files changed

+19
-12
lines changed

docs/fassets/firelight/deposit.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,8 @@ To continue your Firelight development journey, you can:
148148

149149
- Learn how to [get Firelight vault status](/fassets/firelight/status) to monitor your position.
150150
- Learn how to [mint Firelight vault shares](/fassets/firelight/mint) by specifying the number of shares.
151+
- Learn how to [withdraw assets from a Firelight vault](/fassets/firelight/withdraw).
152+
- Learn how to [redeem assets from a Firelight vault](/fassets/firelight/redeem).
151153
- Explore the [FAssets system overview](/fassets/overview) to understand the broader ecosystem.
152154

153155
:::

docs/fassets/firelight/mint.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,8 @@ To continue your Firelight development journey, you can:
159159

160160
- Learn how to [get Firelight vault status](/fassets/firelight/status) to monitor your position.
161161
- Learn how to [deposit assets into a Firelight vault](/fassets/firelight/deposit) by specifying the amount of assets to deposit.
162+
- Learn how to [withdraw assets from a Firelight vault](/fassets/firelight/withdraw).
163+
- Learn how to [redeem assets from a Firelight vault](/fassets/firelight/redeem).
162164
- Explore the [FAssets system overview](/fassets/overview) to understand the broader ecosystem.
163165

164166
:::

docs/fassets/firelight/redeem.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 5
88
---
99

1010
import CodeBlock from "@theme/CodeBlock";
11-
import FirelightRedeem from "!!raw-loader!/examples/developer-hub-javascript/firevault-redeem.ts";
11+
import FirelightRedeem from "!!raw-loader!/examples/developer-hub-javascript/firelight-redeem.ts";
1212

1313
## Overview
1414

docs/fassets/firelight/status.mdx

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -84,17 +84,17 @@ For the connected account, the script displays:
8484
- **Max withdraw**: Maximum amount of assets the user can withdraw.
8585
- **Max redeem**: Maximum number of shares the user can redeem.
8686

87-
### 6. User Withdrawals
87+
### 6. User Withdrawals and Redemptions
8888

89-
The script checks withdrawal information for:
89+
The script checks withdrawal and redemption information for:
9090

91-
- **Current period**: Withdrawals requested in the current period.
92-
- **Previous period**: Withdrawals from the previous period.
91+
- **Current period**: Withdrawals and redemptions requested in the current period.
92+
- **Previous period**: Withdrawals and redemptions from the previous period.
9393

94-
For each period with pending withdrawals, the script displays:
94+
For each period with pending withdrawals or redemptions, the script displays:
9595

9696
- Period number.
97-
- Withdrawal amount in both raw units and formatted token units.
97+
- Withdrawal or redemption amount in both raw units and formatted token units.
9898

9999
## Running the Script
100100

@@ -153,8 +153,10 @@ This information is essential for building applications that interact with Firel
153153
154154
To continue your Firelight development journey, you can:
155155
156-
- Learn how to [deposit assets into a Firelight vault](/smart-accounts/fasset-instructions#01-firelight) using Smart Accounts
157-
- Understand how to [redeem from a Firelight vault](/smart-accounts/fasset-instructions#01-firelight) using Smart Accounts
158-
- Explore the [FAssets system overview](/fassets/overview) to understand the broader ecosystem
156+
- Learn how to [deposit assets into a Firelight vault](/fassets/firelight/deposit).
157+
- Learn how to [mint Firelight vault shares](/fassets/firelight/mint) by specifying the number of shares.
158+
- Learn how to [withdraw assets from a Firelight vault](/fassets/firelight/withdraw).
159+
- Learn how to [redeem assets from a Firelight vault](/fassets/firelight/redeem).
160+
- Explore the [FAssets system overview](/fassets/overview) to understand the broader ecosystem.
159161
160162
:::

docs/fassets/firelight/withdraw.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_position: 4
88
---
99

1010
import CodeBlock from "@theme/CodeBlock";
11-
import FirelightWithdraw from "!!raw-loader!/examples/developer-hub-javascript/firevault-withdraw.ts";
11+
import FirelightWithdraw from "!!raw-loader!/examples/developer-hub-javascript/firelight-withdraw.ts";
1212

1313
## Overview
1414

@@ -163,6 +163,7 @@ Remember that withdrawals are delayed and must be claimed after the current peri
163163
To continue your Firelight development journey, you can:
164164

165165
- Learn how to [get Firelight vault status](/fassets/firelight/status) to monitor your withdrawal requests.
166+
- Learn how to [redeem assets from a Firelight vault](/fassets/firelight/redeem) by specifying the number of shares.
166167
- Learn how to [deposit assets into a Firelight vault](/fassets/firelight/deposit).
167168
- Learn how to [mint Firelight vault shares](/fassets/firelight/mint) by specifying the number of shares.
168169
- Explore the [FAssets system overview](/fassets/overview) to understand the broader ecosystem.
File renamed without changes.

examples/developer-hub-javascript/firelight-status.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ async function main() {
132132
console.log("Max withdraw:", userMaxWithdraw.toString());
133133
console.log("Max redeem:", userMaxRedeem.toString());
134134

135-
// 6. User Withdrawals
135+
// 6. User Withdrawals and Redemptions
136136
// Check withdrawals for current and previous periods
137137
console.log("\n=== User Withdrawals ===");
138138
const currentPeriodBN = web3.utils.toBN(currentPeriod.toString());

examples/developer-hub-javascript/firevault-withdraw.ts renamed to examples/developer-hub-javascript/firelight-withdraw.ts

File renamed without changes.

0 commit comments

Comments
 (0)