@gearbox-protocol/sdk 14.12.0-next.5 → 14.12.0-next.50

package/dist/esm/preview/prerequisites/index.js

@@ -1,8 +1,6 @@
 export * from "./AllowancePrerequisite.js";
 export * from "./BalancePrerequisite.js";
-export * from "./buildPrerequisites.js";
+export * from "./checkPrerequisites.js";
 export * from "./Prerequisite.js";
-export * from "./prepareAction.js";
 export * from "./RWAOpenRequirementsPrerequisite.js";
-export * from "./runPrerequisites.js";
 export * from "./types.js";

package/dist/esm/preview/preview/CreditAccountState.js

@@ -0,0 +1,133 @@
+import { zeroAddress } from "viem";
+import {
+  AssetsMap,
+  MIN_INT96
+} from "../../sdk/index.js";
+class CreditAccountState {
+  creditAccount;
+  creditManager;
+  /**
+   * Credit manager underlying
+   */
+  underlying;
+  /**
+   * Per-token balances
+   */
+  balances;
+  /**
+   * Per-token quotas
+   */
+  quotas;
+  /**
+   * Debt principal
+   */
+  debt;
+  /**
+   * Total debt: principal + accrued interest + accrued fees.
+   * `decreaseDebt` amounts operate on total debt (interest and fees are
+   * repaid before principal), so principal alone is not enough to resolve
+   * either the underlying balance decrement or the final principal.
+   */
+  totalDebt;
+  constructor(props) {
+    this.creditAccount = props.creditAccount;
+    this.creditManager = props.creditManager;
+    this.underlying = props.underlying;
+    this.balances = props.balances ?? new AssetsMap();
+    this.quotas = props.quotas ?? new AssetsMap();
+    this.debt = props.debt ?? 0n;
+    this.totalDebt = props.totalDebt ?? 0n;
+  }
+  /**
+   * The account-opening seed: everything zero/empty. The account doesn't
+   * exist yet at preview time, so `creditAccount` is the zero address;
+   * opening previews take identity from the parsed operation instead.
+   */
+  static beforeOpen(creditManager, underlying) {
+    return new CreditAccountState({
+      creditAccount: zeroAddress,
+      creditManager,
+      underlying
+    });
+  }
+  /**
+   * Pre-state of an existing account from its on-chain data, with dust
+   * balances and quotas (≤ 1 wei) filtered out.
+   */
+  static fromCreditAccountData(ca) {
+    const balances = new AssetsMap();
+    const quotas = new AssetsMap();
+    for (const t of ca.tokens) {
+      if (t.balance > 1n) {
+        balances.upsert(t.token, t.balance);
+      }
+      if (t.quota > 1n) {
+        quotas.upsert(t.token, t.quota);
+      }
+    }
+    return new CreditAccountState({
+      creditAccount: ca.creditAccount,
+      creditManager: ca.creditManager,
+      underlying: ca.underlying,
+      balances,
+      quotas,
+      debt: ca.debt,
+      totalDebt: ca.debt + ca.accruedInterest + ca.accruedFees
+    });
+  }
+  clone() {
+    return new CreditAccountState({
+      creditAccount: this.creditAccount,
+      creditManager: this.creditManager,
+      underlying: this.underlying,
+      balances: this.balances.clone(),
+      quotas: this.quotas.clone(),
+      debt: this.debt,
+      totalDebt: this.totalDebt
+    });
+  }
+  /**
+   * Borrows `amount` of underlying: debt, total debt and the underlying
+   * balance all increase by it.
+   */
+  increaseDebt(amount) {
+    this.debt += amount;
+    this.totalDebt += amount;
+    this.balances.inc(this.underlying, amount);
+  }
+  /**
+   * Repays up to `amount` of underlying against the debt, clamped to the
+   * total debt (the facade never repays more than is owed). Interest and
+   * fees are repaid before principal (CreditLogic.calcDecrease), so
+   * principal only decreases once total debt drops below it. The underlying
+   * balance decreases by the repaid amount.
+   *
+   * @returns The actually repaid (post-clamp) amount.
+   */
+  repay(amount) {
+    const repaid = amount > this.totalDebt ? this.totalDebt : amount;
+    this.balances.dec(this.underlying, repaid);
+    this.totalDebt -= repaid;
+    if (this.debt > this.totalDebt) {
+      this.debt = this.totalDebt;
+    }
+    return repaid;
+  }
+  /**
+   * Applies a relative `updateQuota` change to the token's quota:
+   * `MIN_INT96` is the facade "disable quota" sentinel and zeroes it, other
+   * changes are added with the result clamped at zero (quotas cannot go
+   * negative on-chain).
+   */
+  updateQuota(token, change) {
+    if (change === MIN_INT96) {
+      this.quotas.upsert(token, 0n);
+      return;
+    }
+    const next = this.quotas.getOrZero(token) + change;
+    this.quotas.upsert(token, next > 0n ? next : 0n);
+  }
+}
+export {
+  CreditAccountState
+};

package/dist/esm/preview/preview/applyRWAWrapUnwrap.js

@@ -0,0 +1,50 @@
+import { decodeFunctionData } from "viem";
+import { ierc4626AdapterAbi } from "../../abi/ierc4626Adapter.js";
+function resolveWrapUnwrap(adapter, calldata, balances) {
+  const decoded = decodeFunctionData({
+    abi: ierc4626AdapterAbi,
+    data: calldata
+  });
+  const { asset, share } = adapter;
+  switch (decoded.functionName) {
+    case "deposit":
+      return { tokenIn: asset, tokenOut: share, amountIn: decoded.args[0] };
+    case "depositDiff": {
+      const [leftoverAmount] = decoded.args;
+      const running = balances.getOrZero(asset);
+      return {
+        tokenIn: asset,
+        tokenOut: share,
+        amountIn: running > leftoverAmount ? running - leftoverAmount : 0n
+      };
+    }
+    case "redeem":
+      return { tokenIn: share, tokenOut: asset, amountIn: decoded.args[0] };
+    case "redeemDiff": {
+      const [leftoverAmount] = decoded.args;
+      const running = balances.getOrZero(share);
+      return {
+        tokenIn: share,
+        tokenOut: asset,
+        amountIn: running > leftoverAmount ? running - leftoverAmount : 0n
+      };
+    }
+    default:
+      return void 0;
+  }
+}
+function applyRWAWrapUnwrap(adapter, calldata, balances) {
+  const resolved = resolveWrapUnwrap(adapter, calldata, balances);
+  if (!resolved) {
+    return;
+  }
+  const { tokenIn, tokenOut, amountIn } = resolved;
+  if (amountIn === 0n) {
+    return;
+  }
+  balances.dec(tokenIn, amountIn);
+  balances.inc(tokenOut, amountIn);
+}
+export {
+  applyRWAWrapUnwrap
+};

package/dist/esm/preview/preview/buildDelayedPreview.js

@@ -0,0 +1,154 @@
+import { isAddressEqual } from "viem";
+import { BigIntMath } from "../../common-utils/index.js";
+import {
+  AssetsMap
+} from "../../sdk/index.js";
+import {
+  ERROR_UNPRICEABLE_TOKEN,
+  PREVIEW_DUST
+} from "./types.js";
+function buildDelayedPreview(afterInstant, before, detected, convert, receivedToken) {
+  const { request, intent } = detected;
+  const post = afterInstant.clone();
+  const converter = makeSafeConverter(convert);
+  const claimed = applyClaim(post, request);
+  const collateralWithdrawn = new AssetsMap();
+  switch (intent?.type) {
+    case "CLOSE_ACCOUNT":
+      return buildClosePreview(post, converter, receivedToken);
+    case "DECREASE_LEVERAGE":
+      repayFromClaim(post, request.claimToken, converter.convert, claimed);
+      break;
+    case "WITHDRAW_COLLATERAL": {
+      applyWithdrawCollateral(
+        post,
+        request,
+        intent,
+        converter,
+        collateralWithdrawn
+      );
+      break;
+    }
+    default:
+      break;
+  }
+  return buildAdjustPreview(post, before, collateralWithdrawn, converter);
+}
+function makeSafeConverter(convert) {
+  let error;
+  return {
+    convert: (token, to, amount) => {
+      try {
+        return convert(token, to, amount);
+      } catch {
+        error ??= {
+          code: ERROR_UNPRICEABLE_TOKEN,
+          message: `cannot price token ${token}`
+        };
+        return 0n;
+      }
+    },
+    get error() {
+      return error;
+    }
+  };
+}
+function applyClaim(post, request) {
+  const claimed = post.balances.getOrZero(request.phantomToken);
+  post.balances.upsert(request.phantomToken, 0n);
+  post.quotas.upsert(request.phantomToken, 0n);
+  post.balances.inc(request.claimToken, claimed);
+  return claimed;
+}
+function applyWithdrawCollateral(post, request, intent, converter, collateralWithdrawn) {
+  const { withdrawToken, withdrawAmount, debtRepaid } = intent;
+  const { claimToken } = request;
+  const sameToken = isAddressEqual(withdrawToken, claimToken);
+  const fromBalance = BigIntMath.min(
+    withdrawAmount,
+    post.balances.getOrZero(withdrawToken)
+  );
+  post.balances.dec(withdrawToken, fromBalance);
+  let withdrawn = fromBalance;
+  const missing = withdrawAmount - fromBalance;
+  if (missing > 0n && !sameToken) {
+    const available = post.balances.getOrZero(claimToken);
+    const cost = converter.convert(withdrawToken, claimToken, missing);
+    if (cost > 0n && cost <= available) {
+      post.balances.dec(claimToken, cost);
+      withdrawn += missing;
+    } else if (available > 0n) {
+      post.balances.dec(claimToken, available);
+      withdrawn += converter.convert(claimToken, withdrawToken, available);
+    }
+  }
+  if (withdrawn > 0n) {
+    collateralWithdrawn.upsert(withdrawToken, withdrawn);
+  }
+  const remaining = post.balances.getOrZero(claimToken);
+  if (remaining > 0n) {
+    const proceeds = converter.convert(claimToken, post.underlying, remaining);
+    post.balances.dec(claimToken, remaining);
+    post.balances.inc(post.underlying, proceeds);
+    post.repay(BigIntMath.min(proceeds, debtRepaid));
+  }
+}
+function repayFromClaim(post, claimToken, convert, amount) {
+  const spent = BigIntMath.min(amount, post.balances.getOrZero(claimToken));
+  if (spent <= 0n) {
+    return;
+  }
+  const received = convert(claimToken, post.underlying, spent);
+  post.balances.dec(claimToken, spent);
+  post.balances.inc(post.underlying, received);
+  post.repay(received);
+}
+function totalValueInUnderlying(post, convert, dust) {
+  return post.balances.sum(
+    (token, balance) => balance > dust ? convert(token, post.underlying, balance) : 0n
+  );
+}
+function buildClosePreview(post, converter, receivedToken) {
+  const totalValue = totalValueInUnderlying(post, converter.convert, 0n);
+  return {
+    operation: "CloseCreditAccount",
+    permanent: false,
+    creditManager: post.creditManager,
+    creditAccount: post.creditAccount,
+    // Oracle estimate computed in the underlying; RWA underlyings convert
+    // 1:1 with their vault asset, so the amount holds for `receivedToken`
+    receivedAmount: {
+      token: receivedToken,
+      balance: BigIntMath.max(totalValue - post.totalDebt, 0n)
+    },
+    error: converter.error
+  };
+}
+function buildAdjustPreview(post, before, collateralWithdrawn, converter) {
+  const totalValue = totalValueInUnderlying(
+    post,
+    converter.convert,
+    PREVIEW_DUST
+  );
+  return {
+    operation: "AdjustCreditAccount",
+    creditManager: post.creditManager,
+    creditAccount: post.creditAccount,
+    // the resume flow adds nothing from the wallet
+    collateralAdded: [],
+    collateralWithdrawn: collateralWithdrawn.toAssets(),
+    totalValue,
+    debt: post.debt,
+    // relative to the pre-transaction state: where the account will end up
+    // compared to now, once the withdrawal is claimed and the intent resumed
+    debtChange: post.debt - before.debt,
+    quotas: post.quotas.toAssets(0n),
+    quotasChange: post.quotas.difference(before.quotas).toAssets(),
+    assets: post.balances.toAssets(PREVIEW_DUST),
+    assetsChange: post.balances.difference(before.balances).toAssets(PREVIEW_DUST),
+    error: converter.error
+  };
+}
+export {
+  buildDelayedPreview
+};

package/dist/esm/preview/preview/detectCloseOrRepay.js

@@ -0,0 +1,29 @@
+import { isAddressEqual } from "viem";
+import { MAX_UINT256 } from "../../sdk/index.js";
+function isCloseOrRepay(multicall) {
+  return multicall.some(
+    (op) => op.operation === "DecreaseBorrowedAmount" && op.amount === MAX_UINT256
+  );
+}
+function classifyCloseOrRepay(multicall, exitTokens) {
+  let hasExitWithdrawal = false;
+  for (const op of multicall) {
+    if (op.operation === "AddCollateral") {
+      return "repay";
+    }
+    if (op.operation === "WithdrawCollateral") {
+      const isExit = exitTokens.some((token) => isAddressEqual(op.token, token));
+      if (!isExit) {
+        return "repay";
+      }
+      if (op.amount === MAX_UINT256) {
+        hasExitWithdrawal = true;
+      }
+    }
+  }
+  return hasExitWithdrawal ? "close" : "repay";
+}
+export {
+  classifyCloseOrRepay,
+  isCloseOrRepay
+};

package/dist/esm/preview/preview/detectDelayedClaim.js

@@ -0,0 +1,30 @@
+import {
+  AbstractAdapterContract
+} from "../../plugins/adapters/index.js";
+function detectDelayedClaim(sdk, multicall) {
+  for (const op of multicall) {
+    if (op.operation !== "Execute") {
+      continue;
+    }
+    const adapter = sdk.getContract(op.adapter);
+    if (!(adapter instanceof AbstractAdapterContract)) {
+      continue;
+    }
+    const claim = adapter.parseDelayedWithdrawalClaim(op.calldata);
+    if (claim) {
+      return { adapter: op.adapter, redeemer: claim.redeemer };
+    }
+  }
+  return void 0;
+}
+async function resolveDelayedClaimIntent(sdk, multicall, blockNumber) {
+  const claim = detectDelayedClaim(sdk, multicall);
+  if (!claim) {
+    return void 0;
+  }
+  return sdk.redemptionLogger?.getDelayedIntent(claim.redeemer, blockNumber);
+}
+export {
+  detectDelayedClaim,
+  resolveDelayedClaimIntent
+};

package/dist/esm/preview/preview/detectDelayedOperation.js

@@ -0,0 +1,51 @@
+import { isAddressEqual } from "viem";
+import {
+  AbstractAdapterContract
+} from "../../plugins/adapters/index.js";
+import {
+  decodeDelayedIntent,
+  InvalidDelayedIntentError
+} from "../../sdk/index.js";
+function detectDelayedOperation(sdk, multicall) {
+  let bracketDeltas = [];
+  for (const op of multicall) {
+    if (op.operation === "StoreExpectedBalances") {
+      bracketDeltas = op.deltas;
+      continue;
+    }
+    if (op.operation === "CompareBalances") {
+      bracketDeltas = [];
+      continue;
+    }
+    if (op.operation !== "Execute") {
+      continue;
+    }
+    const adapter = sdk.getContract(op.adapter);
+    if (!(adapter instanceof AbstractAdapterContract)) {
+      continue;
+    }
+    const request = adapter.parseDelayedWithdrawalRequest(op.calldata);
+    if (!request) {
+      continue;
+    }
+    const mintsPhantom = bracketDeltas.some(
+      ({ token, balance }) => balance > 0n && isAddressEqual(token, request.phantomToken)
+    );
+    if (!mintsPhantom) {
+      continue;
+    }
+    let intent;
+    if (request.extraData && request.extraData !== "0x") {
+      try {
+        intent = decodeDelayedIntent(request.extraData);
+      } catch (e) {
+        throw new InvalidDelayedIntentError(request.extraData, e);
+      }
+    }
+    return { request, intent };
+  }
+  return void 0;
+}
+export {
+  detectDelayedOperation
+};

package/dist/esm/preview/preview/index.js

@@ -1,3 +1,12 @@
+export * from "./buildDelayedPreview.js";
+export * from "./CreditAccountState.js";
+export * from "./detectCloseOrRepay.js";
+export * from "./detectDelayedClaim.js";
+export * from "./detectDelayedOperation.js";
 export * from "./errors.js";
+export * from "./previewAdjustCreditAccount.js";
+export * from "./previewCloseOrRepayCreditAccount.js";
 export * from "./previewOperation.js";
+export * from "./replayInnerOperations.js";
+export * from "./replayMulticall.js";
 export * from "./types.js";

package/dist/esm/preview/preview/previewAdjustCreditAccount.js

@@ -0,0 +1,57 @@
+import { AP_WETH_TOKEN, NO_VERSION } from "../../sdk/index.js";
+import { replayMulticall } from "./replayMulticall.js";
+import {
+  ERROR_UNPRICEABLE_TOKEN,
+  PREVIEW_DUST
+} from "./types.js";
+import { unwrapNativeCollateral } from "./unwrapNativeCollateral.js";
+async function previewAdjustCreditAccount(input, operation, options) {
+  const { sdk, value = 0n } = input;
+  const market = sdk.marketRegister.findByCreditManager(
+    operation.creditManager
+  );
+  const {
+    before,
+    after,
+    error: replayError
+  } = await replayMulticall(sdk, operation, options);
+  const account = after.account;
+  let error = replayError;
+  const { assets: collateralAdded, error: unwrapError } = unwrapNativeCollateral(
+    after.collateralAdded.toAssets(),
+    value,
+    sdk.addressProvider.getAddress(AP_WETH_TOKEN, NO_VERSION)
+  );
+  error ??= unwrapError;
+  const assets = account.balances.toAssets(PREVIEW_DUST);
+  const assetsChange = account.balances.difference(before.balances).toAssets(PREVIEW_DUST);
+  const totalValue = assets.reduce((acc, { token, balance }) => {
+    try {
+      return acc + market.priceOracle.convert(token, market.underlying, balance);
+    } catch {
+      error ??= {
+        code: ERROR_UNPRICEABLE_TOKEN,
+        message: `cannot price token ${token}`
+      };
+      return acc;
+    }
+  }, 0n);
+  return {
+    operation: "AdjustCreditAccount",
+    creditManager: operation.creditManager,
+    creditAccount: operation.creditAccount,
+    collateralAdded,
+    collateralWithdrawn: after.collateralWithdrawn.toAssets(),
+    totalValue,
+    debt: account.debt,
+    debtChange: account.debt - before.debt,
+    quotas: account.quotas.toAssets(0n),
+    quotasChange: account.quotas.difference(before.quotas).toAssets(),
+    assets,
+    assetsChange,
+    error
+  };
+}
+export {
+  previewAdjustCreditAccount
+};

package/dist/esm/preview/preview/previewCloseOrRepayCreditAccount.js

@@ -0,0 +1,76 @@
+import {
+  AP_WETH_TOKEN,
+  MAX_UINT256,
+  NO_VERSION
+} from "../../sdk/index.js";
+import { classifyCloseOrRepay } from "./detectCloseOrRepay.js";
+import {
+  replayMulticall
+} from "./replayMulticall.js";
+import { unwrapNativeCollateral } from "./unwrapNativeCollateral.js";
+async function previewCloseOrRepayCreditAccount(input, operation, permanent, options) {
+  const { sdk } = input;
+  const market = sdk.marketRegister.findByCreditManager(
+    operation.creditManager
+  );
+  const exitTokens = [market.underlying];
+  const meta = sdk.tokensMeta.get(market.underlying);
+  if (meta && sdk.tokensMeta.isRWAUnderlying(meta)) {
+    exitTokens.push(meta.asset);
+  }
+  const replay = await replayMulticall(sdk, operation, options);
+  const kind = classifyCloseOrRepay(operation.multicall, exitTokens);
+  return kind === "close" ? previewCloseCreditAccount(input, operation, permanent, replay) : previewRepayCreditAccount(input, operation, permanent, replay);
+}
+function previewCloseCreditAccount(input, operation, permanent, replay) {
+  const { sdk } = input;
+  const market = sdk.marketRegister.findByCreditManager(
+    operation.creditManager
+  );
+  const { after, error } = replay;
+  let receivedToken = market.underlying;
+  for (const m of operation.multicall) {
+    if (m.operation === "WithdrawCollateral" && m.amount === MAX_UINT256) {
+      receivedToken = m.token;
+      break;
+    }
+  }
+  return {
+    operation: "CloseCreditAccount",
+    permanent,
+    creditManager: operation.creditManager,
+    creditAccount: operation.creditAccount,
+    // On a malformed multicall the withdrawn amount depends on best-effort
+    // replayed balances and may be unreliable
+    receivedAmount: {
+      token: receivedToken,
+      balance: after.collateralWithdrawn.getOrZero(receivedToken)
+    },
+    error
+  };
+}
+function previewRepayCreditAccount(input, operation, permanent, replay) {
+  const { sdk, value = 0n } = input;
+  const { before, after, error: replayError } = replay;
+  const { assets: collateralAdded, error: unwrapError } = unwrapNativeCollateral(
+    after.collateralAdded.toAssets(),
+    value,
+    sdk.addressProvider.getAddress(AP_WETH_TOKEN, NO_VERSION)
+  );
+  const error = replayError ?? unwrapError;
+  return {
+    operation: "RepayCreditAccount",
+    permanent,
+    creditManager: operation.creditManager,
+    creditAccount: operation.creditAccount,
+    collateralAdded,
+    debtRepaid: before.totalDebt - after.account.totalDebt,
+    // On a malformed multicall the MAX_UINT256 withdrawal sentinel resolves
+    // against best-effort replayed balances and may be unreliable
+    collateralWithdrawn: after.collateralWithdrawn.toAssets(),
+    error
+  };
+}
+export {
+  previewCloseOrRepayCreditAccount
+};