@gearbox-protocol/sdk 15.1.0-next.9 → 16.0.0-next.2

package/dist/types/sdk/accounts/intents/utils/pick-token.d.ts

@@ -0,0 +1,55 @@
+import { OnchainSDK } from "../../../OnchainSDK.js";
+import { CreditAccountSlice } from "../types.js";
+import "../../../index.js";
+import { Address } from "viem";
+//#region src/sdk/accounts/intents/utils/pick-token.d.ts
+/**
+ * Whether `token` is a phantom (a non-transferable position marker such as a
+ * pending delayed withdrawal).
+ *
+ * Reads `contractType` directly instead of going through
+ * `TokensMeta.isPhantomToken`, which throws when extended token data has not
+ * been loaded. Here an unknown token is simply treated as non-phantom.
+ */
+declare function isPhantomToken(sdk: OnchainSDK, token: Address): boolean;
+/**
+ * Whether `token` is the phantom of a redemption in flight, rather than one of
+ * the phantoms a position is simply held in (Convex, Infrared, staking
+ * rewards), which the router sells like any other balance.
+ *
+ * Only the former stands between an account and being emptied: it cannot be
+ * sold and it cannot leave until its claim has landed.
+ */
+declare function isRedemptionPhantomToken(sdk: OnchainSDK, token: Address): boolean;
+interface CandidateToken {
+  token: Address;
+  balance: bigint;
+  /** Balance priced in the market underlying, used for the ranking. */
+  valueInUnderlying: bigint;
+}
+/**
+ * Account balances that can actually back an operation, richest first.
+ *
+ * Phantoms are dropped because a pending delayed withdrawal cannot be spent:
+ * it has to be claimed first, in a transaction of its own.
+ */
+declare function rankAccountTokens(args: {
+  creditAccount: CreditAccountSlice;
+  sdk: OnchainSDK;
+  /** Tokens to skip, e.g. the operation's own target. */
+  exclude?: Address[];
+}): CandidateToken[];
+/**
+ * Default working token for flows that do not get one from the caller: the
+ * most valuable non-phantom balance on the account.
+ *
+ * Used for the source of a partial withdraw and the position leg of a leverage
+ * adjustment, both of which the caller may override explicitly.
+ */
+declare function pickFattestNonPhantomToken(args: {
+  creditAccount: CreditAccountSlice;
+  sdk: OnchainSDK;
+  exclude?: Address[];
+}): CandidateToken | undefined;
+//#endregion
+export { CandidateToken, isPhantomToken, isRedemptionPhantomToken, pickFattestNonPhantomToken, rankAccountTokens };

package/dist/types/sdk/accounts/intents/utils/quotas-for-update.d.ts

@@ -1,9 +1,8 @@
 import { AddressMap } from "../../../utils/AddressMap.js";
 import { Asset } from "../../../base/types.js";
-import { QuotaUpdateState } from "../operations/quota-update/index.js";
-import "../operations/index.js";
+import { QuotaUpdateState } from "../operations.js";
 import "../../../index.js";
-import { ConvertFn } from "./simulate-assets.js";
+import { ConvertFn } from "./ledger.js";
 import { Address } from "viem";
 //#region src/sdk/accounts/intents/utils/quotas-for-update.d.ts
 interface InitialQuota {
@@ -31,5 +30,27 @@ interface GetQuotasForUpdateProps {
   convert: ConvertFn;
 }
 declare function getQuotasForUpdate({ assetsBefore, assetsAfter, initialQuotas, quotaReserve, liquidationThresholds: liquidationThresholdsMap, quotas: quotasMap, maxDebt, underlyingToken, convert }: GetQuotasForUpdateProps): QuotaUpdateState;
+/**
+ * The update that leaves the account holding no quota at all.
+ *
+ * Sits beside {@link getQuotasForUpdate} rather than inside it because the two
+ * answer different questions: that one sizes quotas to the balances an
+ * operation leaves behind, this one is asked for by a plan that ends the loan,
+ * where the right size is none whatever the balances are.
+ *
+ * `MIN_INT96` is the protocol's "reset" sentinel, which is how a decrease says
+ * "all of it" instead of naming an amount that interest may have moved.
+ */
+declare function clearedQuotas(initialQuotas: Array<InitialQuota> | readonly InitialQuota[]): QuotaUpdateState;
+/**
+ * The quotas the account stands at once an update lands: the ones it came with,
+ * with the ones the update names written over them.
+ *
+ * An update only names the tokens its operation touched — see
+ * {@link filterQuotaUpdates} — and the quotas of everything else keep standing,
+ * so the update alone is not the account's quota set. Quotas that end at zero
+ * are dropped: a token with no quota is a token the account is not quoted for.
+ */
+declare function quotasAfterUpdate(initialQuotas: Array<InitialQuota> | readonly InitialQuota[], desiredQuota: Record<Address, Asset>): Record<Address, Asset>;
 //#endregion
-export { getQuotasForUpdate };
+export { clearedQuotas, getQuotasForUpdate, quotasAfterUpdate };

package/dist/types/sdk/accounts/intents/utils/router-path.d.ts

@@ -0,0 +1,84 @@
+import { Asset } from "../../../base/types.js";
+import { MultiCall } from "../../../types/transactions.js";
+import { OnchainSDK } from "../../../OnchainSDK.js";
+import { CreditAccountSlice } from "../types.js";
+import "../../../index.js";
+import { Address } from "viem";
+//#region src/sdk/accounts/intents/utils/router-path.d.ts
+/** One routed conversion leg. */
+interface SwapLeg {
+  /** Expected output amount. */
+  amount: bigint;
+  /** Conservative output — the pathfinder floor after slippage. */
+  minAmount: bigint;
+  calls: MultiCall[];
+}
+/** A routed leg that also projects the balances it leaves behind. */
+interface OpenStrategyLeg extends SwapLeg {
+  /** Expected balances after the swap, per token. */
+  balances: Record<Address, bigint>;
+  /** Floor balances after slippage. */
+  minBalances: Record<Address, bigint>;
+}
+interface RouterPaths {
+  /**
+   * Spends exactly `amount` of `tokenIn`.
+   *
+   * `keep` is the `tokenIn` balance that must survive the swap: when some of it
+   * is not swap input, the leftover-aware many-to-one path is used so the router
+   * does not sweep the whole balance.
+   */
+  swap(input: {
+    tokenIn: Address;
+    tokenOut: Address;
+    amount: bigint;
+    keep?: bigint;
+  }): Promise<SwapLeg>;
+  /**
+   * Sells every balance in `balances` into the underlying in one route — the
+   * path the router builds for a closure, dust included. `amount` is what the
+   * swap produces, so the underlying already on the account is not counted
+   * twice; a set of balances with nothing to sell comes back with no calls.
+   */
+  closeAll(input: {
+    balances: Asset[];
+  }): Promise<SwapLeg>;
+  /**
+   * Spends `expectedBalances` minus `leftoverBalances` into `target` and also
+   * projects the balances left on the account. Used when opening, where there
+   * is no live account state to diff the result against.
+   */
+  openStrategy(input: {
+    expectedBalances: Asset[];
+    leftoverBalances: Asset[];
+    target: Address;
+  }): Promise<OpenStrategyLeg>;
+}
+/**
+ * The engine's only door to the pathfinder.
+ *
+ * Deliberately not a quoter abstraction with an oracle-priced twin: paths are
+ * always resolved on-chain, because a preview whose swap amounts came from
+ * oracle prices could not produce the calldata that realises them.
+ */
+declare function createRouterPaths(args: {
+  sdk: OnchainSDK;
+  creditAccount: CreditAccountSlice;
+  slippage: number;
+}): RouterPaths;
+/**
+ * The same door, priced by the oracle and opening onto no calldata.
+ *
+ * For a leg that cannot be quoted yet: the tail of a redemption trades funds
+ * that do not exist, along a route the pathfinder will only be able to build
+ * once they do. Asking it now would price a swap of nothing, so the amounts
+ * come from the oracle instead — an estimate with no slippage floor, which is
+ * all a projection days out can honestly be — and the walk yields a state
+ * rather than a transaction.
+ */
+declare function createOraclePaths(args: {
+  sdk: OnchainSDK;
+  creditAccount: CreditAccountSlice;
+}): RouterPaths;
+//#endregion
+export { OpenStrategyLeg, RouterPaths, SwapLeg, createOraclePaths, createRouterPaths };

package/dist/types/sdk/accounts/intents/view.d.ts

@@ -0,0 +1,15 @@
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { CreditAccountSlice } from "./types.js";
+import "../../index.js";
+import { AccountView } from "./plan.js";
+//#region src/sdk/accounts/intents/view.d.ts
+/**
+ * The account as the planners see it: a handful of numbers in underlying units
+ * plus balance / price lookups. Read once per preview.
+ *
+ * TVL uses the RWA-aware conversion so an `rwa.asset` balance without a direct
+ * pool price still counts at its wrapped value instead of throwing.
+ */
+declare function accountView(creditAccount: CreditAccountSlice, sdk: OnchainSDK): AccountView;
+//#endregion
+export { accountView };

package/dist/types/sdk/accounts/liquidations/MultichainLiquidationsService.d.ts

@@ -1,9 +1,9 @@
 import { TxCall } from "../../../model/primitives.js";
-import { PluginsMap } from "../../plugins/types.js";
-import "../../plugins/index.js";
 import { LiquidatableAccount, LiquidationDetails, LiquidationPosition } from "../../../model/liquidations.js";
 import { DataResponse } from "../../../model/response.js";
 import "../../../model/index.js";
+import { PluginsMap } from "../../plugins/types.js";
+import "../../plugins/index.js";
 import { MultichainConstruct } from "../../base/MultichainConstruct.js";
 import "../../base/index.js";
 import { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidationPositionsProps, LoadRWALiquidatorsProps } from "./types.js";

package/dist/types/sdk/accounts/liquidations/types.d.ts

@@ -1,7 +1,7 @@
 import { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
-import { MultichainChainIdsProps, MultichainNetworkProps, WithBlock, WithMultichain } from "../../types/multichain.js";
 import { LiquidatableAccountFilter } from "../../../model/liquidations.js";
 import "../../../model/index.js";
+import { MultichainChainIdsProps, MultichainNetworkProps, WithBlock, WithMultichain } from "../../types/multichain.js";
 import "../../types/index.js";
 import { Address, ContractFunctionReturnType } from "viem";
 //#region src/sdk/accounts/liquidations/types.d.ts

package/dist/types/sdk/accounts/types.d.ts

@@ -1,4 +1,6 @@
-import { ClaimableWithdrawal, DelayedIntent, PendingWithdrawal, RequestableWithdrawal } from "./withdrawal-compressor/types.js";
+import { DelayedIntent } from "../../model/delayed-intents.js";
+import "../../model/index.js";
+import { ClaimableWithdrawal, PendingWithdrawal, RequestableWithdrawal } from "./withdrawal-compressor/types.js";
 import { Asset, CreditAccountData, CreditAccountTokensSlice, PermitResult } from "../base/types.js";
 import { GetOpenAccountRequirementsProps, RWAOpenAccountRequirements, RWAOperationArgs } from "../market/rwa/types.js";
 import "../market/rwa/index.js";
@@ -334,18 +336,32 @@ type GetApprovalAddressProps = {
 type EncodableCreditAccountOperation = {
   type: "increaseDebt";
   amount: bigint;
-} | {
+} |
+/**
+ * `full` settles the loan instead of shrinking it: the facade repays whatever
+ * is outstanding, so the interest accrued since `amount` was quoted is
+ * covered too and no dust is left below `minDebt`.
+ */
+{
   type: "decreaseDebt";
   amount: bigint;
+  full?: boolean;
 } | {
   type: "addCollateral";
   token: Address;
   amount: bigint;
-} | {
+} |
+/**
+ * `all` hands over the whole balance instead of a named amount: the facade
+ * reads it at execution, so whatever a swap produced above the quote leaves
+ * with the rest. `amount` is still the figure the projection was built on.
+ */
+{
   type: "withdrawCollateral";
   token: Address;
   amount: bigint;
   to: Address;
+  all?: boolean;
 } | {
   type: "swap";
   calls: Array<MultiCall>;

package/dist/types/sdk/accounts/utils/midasUtils.d.ts

@@ -0,0 +1,38 @@
+import { ILogger } from "../../types/logger.js";
+import { CreditSuite } from "../../market/credit/CreditSuite.js";
+import { MultiCall } from "../../types/transactions.js";
+import "../../types/index.js";
+import { PublicClient } from "viem";
+//#region src/sdk/accounts/utils/midasUtils.d.ts
+interface PrependMidasReceiveGreenlistProps {
+  /**
+   * Credit manager the account is opened on
+   */
+  cm: CreditSuite;
+  /**
+   * Client to read gateway `mode` with
+   */
+  client: PublicClient;
+  /**
+   * Calls to run in the credit facade multicall, as produced by the router
+   */
+  calls: MultiCall[];
+  logger?: ILogger;
+}
+/**
+ * Prepends `MidasGatewayAdapter.receiveGreenlist()` to a credit facade
+ * multicall that mints an mToken through a Midas issuance vault.
+ *
+ * Permissioned and restricted-interface mTokens can only be held by greenlisted
+ * accounts, and a freshly opened credit account is never greenlisted, so the
+ * mint reverts with `WMAC: hasnt role` unless the account asks the gateway for
+ * the greenlist first. Greenlisting the borrower is not enough — the role is
+ * checked on the token holder, which is the credit account.
+ *
+ * Returns `calls` unchanged when nothing has to be greenlisted: no issuance
+ * vault is called, its mToken has no gateway adapter on this credit manager,
+ * the gateway is permissionless, or the call is already there.
+ */
+declare function prependMidasReceiveGreenlist(props: PrependMidasReceiveGreenlistProps): Promise<MultiCall[]>;
+//#endregion
+export { PrependMidasReceiveGreenlistProps, prependMidasReceiveGreenlist };

package/dist/types/sdk/accounts/withdrawal-compressor/RedemptionLoggerV310Contract.d.ts

@@ -1,4 +1,6 @@
-import { DelayedIntent, IRedemptionLoggerContract, RedemptionLog } from "./types.js";
+import { DelayedIntent } from "../../../model/delayed-intents.js";
+import "../../../model/index.js";
+import { IRedemptionLoggerContract, RedemptionLog } from "./types.js";
 import { OnchainSDK } from "../../OnchainSDK.js";
 import { BaseContract } from "../../base/BaseContract.js";
 import "../../base/index.js";

package/dist/types/sdk/accounts/withdrawal-compressor/index.d.ts

@@ -1,4 +1,4 @@
-import { ClaimableWithdrawal, CurrentWithdrawals, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedIntentExtended, DelayedWithdrawCollateralIntent, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, PendingWithdrawal, RedemptionLog, RequestableWithdrawal, WithdrawableAsset, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, toWithdrawalStatus } from "./types.js";
+import { ClaimableWithdrawal, CurrentWithdrawals, DelayedIntentExtended, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, PendingWithdrawal, RedemptionLog, RequestableWithdrawal, WithdrawableAsset, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, toWithdrawalStatus } from "./types.js";
 import { AbstractWithdrawalCompressorContract, OnchainRequestableWithdrawal, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal } from "./AbstractWithdrawalCompressorContract.js";
 import { WithdrawalCompressorLocation, WithdrawalCompressorVersion, getWithdrawalCompressorAddress } from "./addresses.js";
 import { createRedemptionLogger } from "./createRedemptionLogger.js";
@@ -9,4 +9,4 @@ import { RedemptionLoggerV310Contract } from "./RedemptionLoggerV310Contract.js"
 import { WithdrawalCompressorV310Contract } from "./WithdrawalCompressorV310Contract.js";
 import { WithdrawalCompressorV311Contract } from "./WithdrawalCompressorV311Contract.js";
 import { WithdrawalCompressorV313Contract } from "./WithdrawalCompressorV313Contract.js";
-export { AbstractWithdrawalCompressorContract, ClaimableWithdrawal, CurrentWithdrawals, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedIntentExtended, DelayedWithdrawCollateralIntent, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, InvalidDelayedIntentError, OnchainRequestableWithdrawal, PendingWithdrawal, RedemptionLog, RedemptionLoggerV310Contract, RequestableWithdrawal, WithdrawableAsset, WithdrawalCompressorLocation, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WithdrawalCompressorVersion, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };
+export { AbstractWithdrawalCompressorContract, ClaimableWithdrawal, CurrentWithdrawals, DELAYED_INTENT_TYPES, DELAYED_INTENT_VERSION, DelayedIntentExtended, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, InvalidDelayedIntentError, OnchainRequestableWithdrawal, PendingWithdrawal, RedemptionLog, RedemptionLoggerV310Contract, RequestableWithdrawal, WithdrawableAsset, WithdrawalCompressorLocation, WithdrawalCompressorV310Contract, WithdrawalCompressorV311Contract, WithdrawalCompressorV313Contract, WithdrawalCompressorVersion, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, createRedemptionLogger, createWithdrawalCompressor, decodeDelayedIntent, encodeDelayedIntent, getWithdrawalCompressorAddress, iCreditAccountAbi, toClaimableWithdrawal, toPendingWithdrawal, toRequestableWithdrawal, toWithdrawalStatus };

package/dist/types/sdk/accounts/withdrawal-compressor/intent-codec.d.ts

@@ -1,4 +1,5 @@
-import { DelayedIntent } from "./types.js";
+import { DelayedIntent } from "../../../model/delayed-intents.js";
+import "../../../model/index.js";
 import { Hex } from "viem";
 //#region src/sdk/accounts/withdrawal-compressor/intent-codec.d.ts
 /**

package/dist/types/sdk/accounts/withdrawal-compressor/types.d.ts

@@ -1,3 +1,5 @@
+import { DelayedIntent } from "../../../model/delayed-intents.js";
+import "../../../model/index.js";
 import { MulticallBatch } from "../../utils/viem/executeMulticallBatches.js";
 import "../../utils/viem/index.js";
 import { IBaseContract } from "../../base/types.js";
@@ -6,96 +8,6 @@ import "../../types/index.js";
 import "../../base/index.js";
 import { Address, Hex } from "viem";
 //#region src/sdk/accounts/withdrawal-compressor/types.d.ts
-/**
- * App: 1.1 Deposit and 4.1 Adjust leverage — raise leverage at fixed collateral.
- * Borrow `underlying` -> swap `underlying` into `targetToken` (kept on CA).
- **/
-interface DelayedIncreaseLeverageIntent {
-  type: "INCREASE_LEVERAGE";
-}
-/**
- * App: 1.2 Deposit — `amount > 0`, leverage = current (grow net value at same L).
- * Add collateral -> borrow `underlying` -> swap collateral and `underlying`
- * into the target token.
- **/
-interface DelayedDepositIntent {
-  type: "DEPOSIT";
-}
-/**
- * App: 1.3 Deposit and Adjust leverage — `amount > 0`, leverage > current.
- * Add collateral -> borrow `underlying` -> swap collateral and `underlying`
- * into the target token.
- **/
-interface DelayedDepositAndIncreaseLeverageIntent {
-  type: "DEPOSIT_AND_INCREASE_LEVERAGE";
-}
-/**
- * App: 2.1 Withdraw — withdraw selected token at fixed leverage.
- * Primary goal is `withdrawAmount` of `withdrawToken` (W of T). Debt cut is
- * residual from the claim/path after reserving W. `sourceToken` (S) funds the
- * delayed path; `debtRepaid` is 0 when debt was already repaid on start.
- **/
-interface DelayedWithdrawCollateralIntent {
-  type: "WITHDRAW_COLLATERAL";
-  /**
-   * Wallet address that receives the withdrawn token
-   * when the flow is resumed after the claim
-   **/
-  to: Address;
-  /**
-   * Token to withdraw from the credit account to the wallet after the claim
-   **/
-  withdrawToken: Address;
-  /**
-   * Amount of `withdrawToken` to withdraw to the wallet after the claim (W)
-   **/
-  withdrawAmount: bigint;
-  /**
-   * Token that funds the delayed path / debt conversion (S)
-   **/
-  sourceToken: Address;
-  /**
-   * Desired debt decrease in underlying units remaining for resume.
-   * `0n` when debt was already repaid on the delayed-start branch.
-   **/
-  debtRepaid: bigint;
-}
-/**
- * App: 2.2 Withdraw — close account (receive leftover to wallet).
- **/
-interface DelayedCloseAccountIntent {
-  type: "CLOSE_ACCOUNT";
-  /**
-   * Wallet address that receives leftover tokens when the account is closed
-   * after the claim
-   **/
-  to: Address;
-}
-/**
- * App: 3.1 Add collateral — fixed debt.
- * Add collateral -> swap collateral into the target token.
- **/
-interface DelayedAddCollateralIntent {
-  type: "ADD_COLLATERAL";
-}
-/**
- * App: 4.2 Adjust leverage — lower leverage at fixed collateral.
- * Swap source token into `underlying` -> decrease debt.
- **/
-interface DelayedDecreaseLeverageIntent {
-  type: "DECREASE_LEVERAGE";
-}
-/**
- * Lean intent that is abi-encoded into `extraData` of a delayed withdrawal
- * request and decoded back when reading claimable withdrawals.
- *
- * It allows the app to resume a multi-step operation that was interrupted by
- * a delayed withdrawal: the intent records which operation was in progress
- * (and the minimal set of parameters that cannot be re-derived at claim time),
- * so that after the withdrawal is claimed, the remaining steps can be
- * previewed and executed.
- **/
-type DelayedIntent = DelayedIncreaseLeverageIntent | DelayedDepositIntent | DelayedDepositAndIncreaseLeverageIntent | DelayedWithdrawCollateralIntent | DelayedCloseAccountIntent | DelayedAddCollateralIntent | DelayedDecreaseLeverageIntent;
 /**
  * Delayed intent decoded from `extraData`, enriched with data known at read time.
  **/
@@ -495,4 +407,4 @@ interface IRedemptionLoggerContract extends IBaseContract {
   getDelayedIntent(redeemer: Address, blockNumber?: bigint): Promise<DelayedIntent | undefined>;
 }
 //#endregion
-export { ClaimableWithdrawal, CurrentWithdrawals, DelayedAddCollateralIntent, DelayedCloseAccountIntent, DelayedDecreaseLeverageIntent, DelayedDepositAndIncreaseLeverageIntent, DelayedDepositIntent, DelayedIncreaseLeverageIntent, DelayedIntent, DelayedIntentExtended, DelayedWithdrawCollateralIntent, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, PendingWithdrawal, RedemptionLog, RequestableWithdrawal, WithdrawableAsset, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, toWithdrawalStatus };
+export { ClaimableWithdrawal, CurrentWithdrawals, DelayedIntentExtended, GetExternalAccountCurrentWithdrawalsProps, GetWithdrawalRequestResultProps, IRedemptionLoggerContract, IWithdrawalCompressorContract, PendingWithdrawal, RedemptionLog, RequestableWithdrawal, WithdrawableAsset, WithdrawalOutput, WithdrawalStatus, WithdrawalsState, toWithdrawalStatus };

package/dist/types/sdk/base/MultichainConstruct.d.ts

@@ -1,9 +1,9 @@
 import { ChainId } from "../../model/primitives.js";
+import { DataResponse } from "../../model/response.js";
+import "../../model/index.js";
 import { NetworkType } from "../chain/chains.js";
 import { PluginsMap } from "../plugins/types.js";
 import "../plugins/index.js";
-import { DataResponse } from "../../model/response.js";
-import "../../model/index.js";
 import { OnchainSDK } from "../OnchainSDK.js";
 import { MultichainSDK } from "../MultichainSDK.js";
 //#region src/sdk/base/MultichainConstruct.d.ts

package/dist/types/sdk/base/TokensMeta.d.ts

@@ -1,7 +1,7 @@
 import { ILogger } from "../types/logger.js";
 import { Token } from "../../model/primitives.js";
-import { MulticallBatch } from "../utils/viem/executeMulticallBatches.js";
 import { AddressMap } from "../utils/AddressMap.js";
+import { MulticallBatch } from "../utils/viem/executeMulticallBatches.js";
 import { Asset } from "./types.js";
 import "../utils/index.js";
 import { PhantomTokenMeta, RWATokenMeta, TokenMetaData } from "./token-types.js";
@@ -20,6 +20,24 @@ interface FormatBNOptions {
    **/
   symbol?: boolean;
 }
+/**
+ * Source, target, and phantom token of a delayed redemption, used to rewrite
+ * the phantom's display symbol as `"source -> target"`.
+ **/
+interface RedemptionPhantomRename {
+  /**
+   * Redemption phantom token whose symbol is rewritten.
+   **/
+  phantom: Address;
+  /**
+   * Token being redeemed (e.g. mGLOBAL, ACRED).
+   **/
+  source: Address;
+  /**
+   * Token received when the redemption is claimed (e.g. USDC).
+   **/
+  target: Address;
+}
 /**
  * Serializable snapshot of the token metadata registry.
  **/
@@ -51,7 +69,11 @@ declare class TokensMeta extends AddressMap<TokenMetaData> {
   reset(): void;
   upsert(address: string, value: TokenMetaData | undefined): void;
   /**
-   * Returns the symbol string for a token.
+   * Returns the display symbol for a token.
+   *
+   * This is not always the on-chain ERC-20 `symbol()`: curated pretty names
+   * and redemption phantom tokens (`"source -> target"`) replace it.
+   *
    * @param token - Token address.
    * @throws If the token is not in the registry.
    */
@@ -109,6 +131,13 @@ declare class TokensMeta extends AddressMap<TokenMetaData> {
    * @param token - Token address, wrapper or not.
    */
   unwrapRWA(token: Address): Address;
+  /**
+   * Rewrites display symbols of redemption phantom tokens to
+   * `"${source} -> ${target}"`.
+   *
+   * @param renames - Phantom / source / target address triples.
+   **/
+  renameRedemptionPhantoms(renames: RedemptionPhantomRename[]): void;
   /**
    * Formats a raw token amount into a human-readable decimal string,
    * dividing by `10^decimals` for the token.
@@ -174,4 +203,4 @@ declare class TokensMeta extends AddressMap<TokenMetaData> {
   hydrate(state: TokensMetaState): void;
 }
 //#endregion
-export { FormatBNOptions, TokensMeta, TokensMetaState };
+export { FormatBNOptions, RedemptionPhantomRename, TokensMeta, TokensMetaState };

package/dist/types/sdk/base/index.d.ts

@@ -1,11 +1,10 @@
 import { AdapterData, AssertAssignable, Asset, BaseParams, BaseState, ConnectedBotData, CreditAccountData, CreditAccountDataPayload, CreditAccountTokensSlice, CreditConfiguratorState, CreditFacadeState, CreditManagerDebtParams, CreditManagerState, CreditSuiteState, GaugeData, IBaseContract, MarketData, MarketFilter, ParsedCall, ParsedCallArgs, ParsedCallV2, PermitResult, PoolState, PriceFeedAnswer, PriceFeedMapEntry, PriceFeedTreeNode, PriceOracleData, QuotaKeeperState, QuotaState, RateKeeperState, RelaxedBaseParams, RewardInfo, TokenInfo, Unarray, VotingContractStatus } from "./types.js";
-import { LPMonopolizedPoolMeta, PHANTOM_TOKEN_CONTRACT_TYPES, PhantomTokenContractType, PhantomTokenMeta, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, SimpleTokenMeta, TokenMetaData } from "./token-types.js";
-import { FormatBNOptions, TokensMeta, TokensMetaState } from "./TokensMeta.js";
+import { LPMonopolizedPoolMeta, NON_STRATEGY_PHANTOM_TOKEN_TYPES, PHANTOM_TOKEN_CONTRACT_TYPES, PhantomTokenContractType, PhantomTokenMeta, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, SimpleTokenMeta, TokenMetaData } from "./token-types.js";
+import { FormatBNOptions, RedemptionPhantomRename, TokensMeta, TokensMetaState } from "./TokensMeta.js";
 import { ChainContractsRegister, ContractOrInterface } from "./ChainContractsRegister.js";
 import { Construct, ConstructOptions } from "./Construct.js";
 import { BaseContract, BaseContractArgs, ContractParseError, ContractParseErrorOptions } from "./BaseContract.js";
 import { MissingSerializedParamsError } from "./errors.js";
 import { ChainBlock, ChainBlockPin, ChainBlockSource, ChainQueryOneProps, ChainQueryProps, MultichainConstruct } from "./MultichainConstruct.js";
-import { PlaceholderContract } from "./PlaceholderContract.js";
 import { SDKConstruct } from "./SDKConstruct.js";
-export { AdapterData, AssertAssignable, Asset, BaseContract, BaseContractArgs, BaseParams, BaseState, ChainBlock, ChainBlockPin, ChainBlockSource, ChainContractsRegister, ChainQueryOneProps, ChainQueryProps, ConnectedBotData, Construct, ConstructOptions, ContractOrInterface, ContractParseError, ContractParseErrorOptions, CreditAccountData, CreditAccountDataPayload, CreditAccountTokensSlice, CreditConfiguratorState, CreditFacadeState, CreditManagerDebtParams, CreditManagerState, CreditSuiteState, FormatBNOptions, GaugeData, IBaseContract, LPMonopolizedPoolMeta, MarketData, MarketFilter, MissingSerializedParamsError, MultichainConstruct, PHANTOM_TOKEN_CONTRACT_TYPES, ParsedCall, ParsedCallArgs, ParsedCallV2, PermitResult, PhantomTokenContractType, PhantomTokenMeta, PlaceholderContract, PoolState, PriceFeedAnswer, PriceFeedMapEntry, PriceFeedTreeNode, PriceOracleData, QuotaKeeperState, QuotaState, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RateKeeperState, RelaxedBaseParams, RewardInfo, SDKConstruct, SimpleTokenMeta, TokenInfo, TokenMetaData, TokensMeta, TokensMetaState, Unarray, VotingContractStatus };
+export { AdapterData, AssertAssignable, Asset, BaseContract, BaseContractArgs, BaseParams, BaseState, ChainBlock, ChainBlockPin, ChainBlockSource, ChainContractsRegister, ChainQueryOneProps, ChainQueryProps, ConnectedBotData, Construct, ConstructOptions, ContractOrInterface, ContractParseError, ContractParseErrorOptions, CreditAccountData, CreditAccountDataPayload, CreditAccountTokensSlice, CreditConfiguratorState, CreditFacadeState, CreditManagerDebtParams, CreditManagerState, CreditSuiteState, FormatBNOptions, GaugeData, IBaseContract, LPMonopolizedPoolMeta, MarketData, MarketFilter, MissingSerializedParamsError, MultichainConstruct, NON_STRATEGY_PHANTOM_TOKEN_TYPES, PHANTOM_TOKEN_CONTRACT_TYPES, ParsedCall, ParsedCallArgs, ParsedCallV2, PermitResult, PhantomTokenContractType, PhantomTokenMeta, PoolState, PriceFeedAnswer, PriceFeedMapEntry, PriceFeedTreeNode, PriceOracleData, QuotaKeeperState, QuotaState, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, RateKeeperState, RedemptionPhantomRename, RelaxedBaseParams, RewardInfo, SDKConstruct, SimpleTokenMeta, TokenInfo, TokenMetaData, TokensMeta, TokensMetaState, Unarray, VotingContractStatus };

package/dist/types/sdk/base/token-types.d.ts

@@ -9,6 +9,19 @@ type RWAUnderlyingContractType = typeof RWA_UNDERLYING_DEFAULT | typeof RWA_UNDE
 declare const RWA_ON_DEMAND_LP_MONOPOLIZED = "ON_DEMAND_LP::MONOPOLIZED";
 type RWAOnDemandLpContractType = typeof RWA_ON_DEMAND_LP_MONOPOLIZED;
 type PhantomTokenContractType = (typeof PHANTOM_TOKEN_CONTRACT_TYPES)[number];
+/**
+ * Withdrawal and redemption phantom tokens that can never be acquired as a
+ * strategy target. Other `PHANTOM_TOKEN::*` types (Convex, Infrared, staking
+ * rewards) can.
+ */
+declare const NON_STRATEGY_PHANTOM_TOKEN_TYPES: readonly ["PHANTOM_TOKEN::INFINIFI_UNWIND", "PHANTOM_TOKEN::MELLOW_WITHDRAWAL", "PHANTOM_TOKEN::MIDAS_REDEMPTION", "PHANTOM_TOKEN::SECURITIZE_RD", "PHANTOM_TOKEN::UPSHIFT_WITHDRAW"];
+/**
+ * Token metadata stored in {@link TokensMeta}.
+ *
+ * `symbol` is a display ticker. The SDK may rewrite it (curated pretty names,
+ * `"source -> target"` for redemption phantom tokens) and it is not guaranteed
+ * to match the ERC-20 `symbol()` on chain.
+ */
 interface SimpleTokenMeta extends TokenData {
   contractType?: string;
   /**
@@ -63,4 +76,4 @@ interface RWAOnDemandTokenMeta extends SimpleTokenMeta {
 type RWATokenMeta = RWADefaultTokenMeta | RWAOnDemandTokenMeta;
 type TokenMetaData = SimpleTokenMeta | PhantomTokenMeta | RWATokenMeta;
 //#endregion
-export { LPMonopolizedPoolMeta, PHANTOM_TOKEN_CONTRACT_TYPES, PhantomTokenContractType, PhantomTokenMeta, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, SimpleTokenMeta, TokenMetaData };
+export { LPMonopolizedPoolMeta, NON_STRATEGY_PHANTOM_TOKEN_TYPES, PHANTOM_TOKEN_CONTRACT_TYPES, PhantomTokenContractType, PhantomTokenMeta, RWADefaultTokenMeta, RWAOnDemandLPMeta, RWAOnDemandLPMonopolizedMeta, RWAOnDemandLpContractType, RWAOnDemandTokenMeta, RWATokenMeta, RWAUnderlyingContractType, RWA_ON_DEMAND_LP_MONOPOLIZED, RWA_UNDERLYING_DEFAULT, RWA_UNDERLYING_ON_DEMAND, SimpleTokenMeta, TokenMetaData };