Skip to content

docs(swap): document the --refuel flag for cross-chain bridges#19

Merged
chaitanyapotti merged 1 commit into
mainfrom
docs/swap-refuel-flag
Jun 23, 2026
Merged

docs(swap): document the --refuel flag for cross-chain bridges#19
chaitanyapotti merged 1 commit into
mainfrom
docs/swap-refuel-flag

Conversation

@cloudonshore

Copy link
Copy Markdown
Collaborator

Summary

Documents the --refuel flag for cross-chain bridges across the swap skill surface. Refuel bundles a small destination native-gas top-up into a cross-chain quote so the recipient lands with gas even when their destination native balance is zero.

Pairs with the SDK/CLI support in MetaMask/agentic#204.

Changes

  • references/swap.md--refuel added to the swap quote and swap execute syntax + flag tables, a worked example, a dedicated Refuel section, and a usage note.
  • workflows/bridge.md (both metamask-agent-wallet and metamask-agent-workflows) — --refuel option in the quote step, confirmation checklist, and an edge-case entry.
  • SKILL.md--refuel row in the input-validation table and the swaps/bridges confirmation row.

Key caveats documented

  • Opt-in, cross-chain only — never auto-enabled; no effect on same-chain swaps.
  • Best-effort — only some aggregators offer a top-up; the CLI prefers a refuel-bearing quote and falls back to the best regular quote otherwise.
  • Not for native-asset destinations — bridging into the destination chain's native gas asset (e.g. ETH→ETH on Arbitrum) returns 0 quotes (NO_QUOTES); only use --refuel when bridging into a non-native token.

Add the --refuel flag to the swap command reference (quote + execute),
a dedicated Refuel section, the bridge workflows, and the SKILL.md
validation and confirmation tables.

Key caveats documented: refuel is opt-in and cross-chain only, is
best-effort across aggregators, and must not be used when the
destination token is the destination chain's native gas asset (the
backend returns 0 quotes / NO_QUOTES in that case).
@chaitanyapotti chaitanyapotti merged commit 51f4f07 into main Jun 23, 2026
11 checks passed
@chaitanyapotti chaitanyapotti deleted the docs/swap-refuel-flag branch June 23, 2026 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants