fxSAVE methods

All seven fxSAVE methods use Ethereum. Keep vault shares, underlying fxSP base-pool shares, and redemption outputs distinct. They are different assets even when they share an 18-decimal representation.

getFxSaveBalance#

Read a wallet's fxSAVE shares and their underlying-asset conversion.

Input

userAddress.

Output

balanceWei in fxSAVE shares and optional assetsWei in fxSP, the f(x) Stability Pool share (SDK key fxUSDBasePool). A successful zero balance can omit assetsWei.

Refresh

On Earn/Portfolio open and after every fxSAVE write. No signing; a failed read must not be presented as zero.

getFxSaveConfig#

Read vault totals and live configuration.

Input

No arguments required; an empty request object is also accepted.

Output

totalSupplyWei (fxSAVE), totalAssetsWei (fxSP), cooldownPeriodSeconds, instantRedeemFeeRatio, expenseRatio, harvesterRatio, and threshold.

Instant-redemption fee precision

instantRedeemFeeRatio uses 1e18 precision: divide by 1e18 for the fractional rate, then multiply by 100 for a percentage. This is separate from the pool/router fee ratios at 1e9 precision described below.

Refresh

With the other Earn reads. No signing. Read cooldown and fee settings live rather than hardcoding them.

getFxSaveRedeemStatus#

Read a pending queued redemption and its cooldown state.

Input

userAddress.

Output

hasPendingRedeem, pendingSharesWei (fxSP), cooldownPeriodSeconds, redeemableAt (Unix seconds or null), and isCooldownComplete.

Refresh

On Earn open, after withdrawal or claim, and around cooldown completion. No signing. A local countdown alone does not authorize a claim.

getFxSaveClaimable#

Read redemption status plus the expected claim outputs when available.

Input

userAddress.

Output

The redemption-status fields, plus optional previewReceive: amountYieldOutWei in fxUSD units and amountStableOutWei in USDC units.

Refresh

On Earn open and after withdrawal or claim. A receive preview can exist while cooldown is still running; it is neither claim permission nor a guaranteed final amount.

getRedeemTx#

Prepare the claim for a queued redemption whose cooldown has completed.

Input

userAddress and optional receiver, defaulting to the wallet.

Output

{ txs }, an ordered transaction array. Despite its name, this is a write plan, not a balance read.

Review and refresh

Require fresh pending/cooldown state and successful simulation, then explicit wallet approval. Reload balance, redemption status, and claimable state after the canonical receipt.

depositFxSave#

Prepare a deposit of USDC, fxUSD, or fxSP base-pool shares.

Input

userAddress, tokenIn (usdc, fxUSD, or fxUSDBasePool), positive amount in input-token units, and optional slippage.

Output

{ txs }, with an exact input-token approval when needed before the deposit action.

Deposit slippage limitation

SDK 1.0.5 validates the caller's slippage value but ignores the chosen tolerance when generating routed USDC/fxUSD deposit calldata. The pinned router forwards the SDK-calculated floor to the base pool, where it is checked in base-pool-share units. It is not a separately enforced final fxSAVE minimum and does not guarantee the caller's selected deposit tolerance. Direct base-pool deposits have no routed minimum-output floor.

Review and refresh

Review the encoded minimum with its actual units, then sign each step in order. Reload fxSAVE balance and status after the canonical action receipt.

Implementation references: the pinned SDK deposit planner (opens in a new tab), router forwarding (opens in a new tab), and base-pool minimum-share check (opens in a new tab).

withdrawFxSave#

Prepare a queued redemption, an instant exit, or a direct redemption to fxSP base-pool shares.

Input

userAddress, tokenOut (usdc, fxUSD, or fxUSDBasePool), positive amount in fxSAVE share units, optional instant, and slippage required for an instant exit.

Output

{ txs }, with any required approval before the action. Instant USDC/fxUSD exits apply a fee and slippage. Base-pool-share output is a direct redemption and cannot use instant: true in FxAeon.

Review and refresh

For queued USDC/fxUSD paths, the request queues shares; the later claim can return both fxUSD and USDC. Confirmed queueing does not mean claimed assets. Reload balance, redemption status, and claimable state after each canonical action receipt.

Sources: share and asset units (opens in a new tab), fxSAVE planners (opens in a new tab), claim availability (opens in a new tab).