Skip to content

Commit 584d34d

Browse files
committed
feat(docs): rename guide
1 parent 0651456 commit 584d34d

6 files changed

Lines changed: 16 additions & 16 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ If `executeDirectMintingWithData` reverts and the XRPL payment is still unminted
228228
The skip flag causes the controller to mint FXRP to the personal account **without** dispatching the original user operation.
229229
3. The user can then move the FXRP through standard [FAssets instructions](/smart-accounts/fasset-instructions) or submit a new user operation with the **current** [`getNonce`](/smart-accounts/reference/IMasterAccountController#getnonce) value.
230230

231-
For a step-by-step TypeScript implementation, see the [Recover Stuck Direct Mint guide](/smart-accounts/guides/typescript-viem/recover-stuck-direct-mint-ts).
231+
For a step-by-step TypeScript implementation, see the [Recover Stuck Mint Transaction guide](/smart-accounts/guides/typescript-viem/recover-stuck-mint-transaction-ts).
232232

233233
Related recovery opcodes:
234234

docs/smart-accounts/guides/typescript-viem/02-custom-instruction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -573,7 +573,7 @@ When `executeDirectMintingWithData` reverts and the XRPL payment is still unmint
573573
3. FXRP is minted to the personal account without running the original user operation; the user can then move funds via [FAssets instructions](/smart-accounts/fasset-instructions) or submit a new user operation.
574574

575575
Full protocol details are in [Recovery after a failed mint](/smart-accounts/custom-instruction#recovery-after-a-failed-mint).
576-
For a step-by-step TypeScript walkthrough, see the [Recover Stuck Direct Mint guide](/smart-accounts/guides/typescript-viem/recover-stuck-direct-mint-ts).
576+
For a step-by-step TypeScript walkthrough, see the [Recover Stuck Mint Transaction guide](/smart-accounts/guides/typescript-viem/recover-stuck-mint-transaction-ts).
577577

578578
## Full Script
579579

docs/smart-accounts/guides/typescript-viem/07-recover-stuck-direct-mint.mdx renamed to docs/smart-accounts/guides/typescript-viem/07-recover-stuck-mint-transaction.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
sidebar_position: 7
3-
slug: recover-stuck-direct-mint-ts
4-
title: Recover Stuck Direct Mint
3+
slug: recover-stuck-mint-transaction-ts
4+
title: Recover Stuck Mint Transaction
55
authors: [fassko]
66
description: Recover FXRP when a smart-account direct mint reverted or was never finalized, using the 0xE0 skip-memo flow with Viem.
77
tags: [intermediate, ethereum, flare-smart-accounts]
@@ -20,15 +20,15 @@ unlisted: false
2020
---
2121

2222
import CodeBlock from "@theme/CodeBlock";
23-
import RecoverStuckDirectMintScript from "!!raw-loader!/examples/developer-hub-javascript/smart-accounts/recover-stuck-direct-mint.ts";
23+
import RecoverDirectMintTransactionScript from "!!raw-loader!/examples/developer-hub-javascript/smart-accounts/recover-direct-mint-transaction.ts";
2424

2525
This guide walks through recovering FXRP when a smart-account [direct mint](/fassets/direct-minting) payment is stuck at the [Core Vault](/fassets/core-vault) — typically because [`executeDirectMintingWithData`](/fassets/reference/IAssetManager#executedirectmintingwithdata) reverted on Flare or the executor never submitted the [FDC](/fdc/overview) proof.
2626

2727
The recovery path uses the memo opcode **`0xE0` (Skip memo)** to mark the stuck XRPL transaction ID, then resubmits the original payment so FXRP is minted to the personal account **without** running the original custom instruction.
2828

2929
Read the [Custom Instruction TypeScript guide](/smart-accounts/guides/typescript-viem/custom-instruction-ts) first if you are not familiar with the `0xFE` hash-commitment flow.
3030

31-
The full code is available on [GitHub](https://github.com/flare-foundation/flare-viem-starter/blob/main/src/recover-stuck-direct-mint.ts).
31+
The full code is available on [GitHub](https://github.com/flare-foundation/flare-viem-starter/blob/main/src/recover-direct-mint-transaction.ts).
3232

3333
:::info
3434
The code in this guide is set up for the Coston2 testnet.
@@ -168,23 +168,23 @@ Both paths use `reuseExistingMint: true` so `PaymentAlreadyConfirmed` errors fro
168168
Clone [flare-viem-starter](https://github.com/flare-foundation/flare-viem-starter), configure `.env`, and run:
169169

170170
```bash
171-
STUCK_XRPL_TX_HASH=<your-stuck-tx-hash> pnpm run script src/recover-stuck-direct-mint.ts
171+
STUCK_XRPL_TX_HASH=<your-stuck-tx-hash> pnpm run script src/recover-direct-mint-transaction.ts
172172
```
173173

174174
For a `0xFE` stuck payment, also pass the original user-operation bytes:
175175

176176
```bash
177177
STUCK_XRPL_TX_HASH=<hash> \
178178
STUCK_USER_OP_DATA=<packed-user-op-hex> \
179-
pnpm run script src/recover-stuck-direct-mint.ts
179+
pnpm run script src/recover-direct-mint-transaction.ts
180180
```
181181

182182
If you already sent the `0xE0` recovery payment, resume from step 2:
183183

184184
```bash
185185
STUCK_XRPL_TX_HASH=<stuck-hash> \
186186
RECOVERY_XRPL_TX_HASH=<recovery-hash> \
187-
pnpm run script src/recover-stuck-direct-mint.ts
187+
pnpm run script src/recover-direct-mint-transaction.ts
188188
```
189189

190190
## Full Script
@@ -193,9 +193,9 @@ The repository with the example is available on [GitHub](https://github.com/flar
193193
Helper functions live in the `src/utils` directory.
194194

195195
<details>
196-
<summary>src/recover-stuck-direct-mint.ts</summary>
197-
<CodeBlock language="typescript" title="src/recover-stuck-direct-mint.ts">
198-
{RecoverStuckDirectMintScript}
196+
<summary>src/recover-direct-mint-transaction.ts</summary>
197+
<CodeBlock language="typescript" title="src/recover-direct-mint-transaction.ts">
198+
{RecoverDirectMintTransactionScript}
199199
</CodeBlock>
200200
</details>
201201

docs/smart-accounts/guides/typescript-viem/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ Mint FXRP and dispatch user operations through XRPL memo opcodes (`0xFE`, `0xFF`
6969
<DocCard
7070
item={{
7171
type: "link",
72-
label: "Recover Stuck Direct Mint",
73-
href: "/smart-accounts/guides/typescript-viem/recover-stuck-direct-mint-ts",
72+
label: "Recover Stuck Mint Transaction",
73+
href: "/smart-accounts/guides/typescript-viem/recover-stuck-mint-transaction-ts",
7474
docId:
75-
"smart-accounts/guides/typescript-viem/recover-stuck-direct-mint",
75+
"smart-accounts/guides/typescript-viem/recover-stuck-mint-transaction",
7676
}}
7777
/>
7878
</div>

docs/smart-accounts/reference/IMasterAccountController.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -493,7 +493,7 @@ Emitted when an `0xE0` memo marks a target XRPL transaction's memo to be skipped
493493

494494
Use this opcode to recover when [`executeDirectMintingWithData`](/fassets/reference/IAssetManager#executedirectmintingwithdata) reverts and the underlying XRP payment is still unminted at the Core Vault.
495495
After `IgnoreMemoSet` is recorded, the executor re-submits the direct mint with the original FDC proof; FXRP is credited to the personal account without dispatching the original custom instruction.
496-
See [Recovery after a failed mint](/smart-accounts/custom-instruction#recovery-after-a-failed-mint) and the [Recover Stuck Direct Mint TypeScript guide](/smart-accounts/guides/typescript-viem/recover-stuck-direct-mint-ts).
496+
See [Recovery after a failed mint](/smart-accounts/custom-instruction#recovery-after-a-failed-mint) and the [Recover Stuck Mint Transaction TypeScript guide](/smart-accounts/guides/typescript-viem/recover-stuck-mint-transaction-ts).
497497

498498
```solidity
499499
event IgnoreMemoSet(

examples/developer-hub-javascript/smart-accounts/recover-stuck-direct-mint.ts renamed to examples/developer-hub-javascript/smart-accounts/recover-direct-mint-transaction.ts

File renamed without changes.

0 commit comments

Comments
 (0)