@gearbox-protocol/sdk 14.12.0-next.33 → 14.12.0-next.34

package/dist/cjs/preview/prerequisites/buildCollateralPrerequisites.js

@@ -21,10 +21,13 @@ __export(buildCollateralPrerequisites_exports, {
   buildCollateralPrerequisites: () => buildCollateralPrerequisites
 });
 module.exports = __toCommonJS(buildCollateralPrerequisites_exports);
+var import_viem = require("viem");
 var import_sdk = require("../../sdk/index.js");
+var import_AllowancePrerequisite = require("./AllowancePrerequisite.js");
+var import_BalancePrerequisite = require("./BalancePrerequisite.js");
 var import_helpers = require("./helpers.js");
 async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
-  const { sdk, wallet } = ctx;
+  const { sdk, wallet, value = 0n } = ctx;
   const required = new import_sdk.AssetsMap();
   for (const op of multicall) {
     if (op.operation !== "AddCollateral" || op.amount === 0n) {
@@ -32,12 +35,45 @@ async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
     }
     required.inc(op.token, op.amount);
   }
-  if (required.size === 0) {
+  if (required.size === 0 && value === 0n) {
     return [];
   }
-  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
   const prereqs = [];
+  if (value > 0n) {
+    prereqs.push(
+      new import_BalancePrerequisite.BalancePrerequisite({
+        token: import_sdk.NATIVE_ADDRESS,
+        owner: wallet,
+        required: value
+      })
+    );
+  }
+  if (required.size === 0) {
+    return prereqs;
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const weth = sdk.addressProvider.getAddress(import_sdk.AP_WETH_TOKEN, import_sdk.NO_VERSION);
   for (const [token, amount] of required.entries()) {
+    if (value > 0n && (0, import_viem.isAddressEqual)(token, weth)) {
+      prereqs.push(
+        new import_AllowancePrerequisite.AllowancePrerequisite({
+          token,
+          owner: wallet,
+          spender,
+          required: amount
+        })
+      );
+      if (amount > value) {
+        prereqs.push(
+          new import_BalancePrerequisite.BalancePrerequisite({
+            token,
+            owner: wallet,
+            required: amount - value
+          })
+        );
+      }
+      continue;
+    }
     prereqs.push(
       ...(0, import_helpers.allowanceAndBalance)({
         token,

package/dist/cjs/preview/prerequisites/checkPrerequisites.js

@@ -32,7 +32,8 @@ async function checkPrerequisites(input, options) {
   const ctx = {
     sdk,
     wallet,
-    blockNumber: options?.blockNumber
+    blockNumber: options?.blockNumber,
+    value: input.value ?? 0n
   };
   const prereqs = await buildPrerequisites(tx, ctx);
   return Promise.all(prereqs.map((p) => p.verify(ctx)));

package/dist/cjs/preview/preview/buildDelayedPreview.js

@@ -25,7 +25,7 @@ var import_viem = require("viem");
 var import_common_utils = require("../../common-utils/index.js");
 var import_sdk = require("../../sdk/index.js");
 var import_types = require("./types.js");
-function buildDelayedPreview(afterInstant, before, detected, convert) {
+function buildDelayedPreview(afterInstant, before, detected, convert, receivedToken) {
   const { request, intent } = detected;
   const post = afterInstant.clone();
   const converter = makeSafeConverter(convert);
@@ -33,7 +33,7 @@ function buildDelayedPreview(afterInstant, before, detected, convert) {
   const collateralWithdrawn = new import_sdk.AssetsMap();
   switch (intent?.type) {
     case "CLOSE_ACCOUNT":
-      return buildClosePreview(post, converter);
+      return buildClosePreview(post, converter, receivedToken);
     case "DECREASE_LEVERAGE":
       repayFromClaim(post, request.claimToken, converter.convert, claimed);
       break;
@@ -104,16 +104,17 @@ function totalValueInUnderlying(post, convert, dust) {
     (token, balance) => balance > dust ? convert(token, post.underlying, balance) : 0n
   );
 }
-function buildClosePreview(post, converter) {
+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 denominated in the underlying
+    // Oracle estimate computed in the underlying; RWA underlyings convert
+    // 1:1 with their vault asset, so the amount holds for `receivedToken`
     receivedAmount: {
-      token: post.underlying,
+      token: receivedToken,
       balance: import_common_utils.BigIntMath.max(totalValue - post.totalDebt, 0n)
     },
     error: converter.error

package/dist/cjs/preview/preview/previewOperation.js

@@ -74,6 +74,8 @@ async function previewMulticallOperation(input, operation, options) {
     operation.creditManager
   );
   const convert = (token, to, amount) => market.priceOracle.convert(token, to, amount);
+  const meta = sdk.tokensMeta.get(market.underlying);
+  const receivedToken = meta && sdk.tokensMeta.isRWAUnderlying(meta) ? meta.asset : market.underlying;
   return {
     operation: "DelayedCreditAccountOperation",
     creditAccount: operation.creditAccount,
@@ -84,7 +86,8 @@ async function previewMulticallOperation(input, operation, options) {
       after.account,
       before,
       delayed,
-      convert
+      convert,
+      receivedToken
     )
   };
 }

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

@@ -1,9 +1,15 @@
+import { isAddressEqual } from "viem";
 import {
-  AssetsMap
+  AP_WETH_TOKEN,
+  AssetsMap,
+  NATIVE_ADDRESS,
+  NO_VERSION
 } from "../../sdk/index.js";
+import { AllowancePrerequisite } from "./AllowancePrerequisite.js";
+import { BalancePrerequisite } from "./BalancePrerequisite.js";
 import { allowanceAndBalance } from "./helpers.js";
 async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
-  const { sdk, wallet } = ctx;
+  const { sdk, wallet, value = 0n } = ctx;
   const required = new AssetsMap();
   for (const op of multicall) {
     if (op.operation !== "AddCollateral" || op.amount === 0n) {
@@ -11,12 +17,45 @@ async function buildCollateralPrerequisites(spenderOptions, multicall, ctx) {
     }
     required.inc(op.token, op.amount);
   }
-  if (required.size === 0) {
+  if (required.size === 0 && value === 0n) {
     return [];
   }
-  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
   const prereqs = [];
+  if (value > 0n) {
+    prereqs.push(
+      new BalancePrerequisite({
+        token: NATIVE_ADDRESS,
+        owner: wallet,
+        required: value
+      })
+    );
+  }
+  if (required.size === 0) {
+    return prereqs;
+  }
+  const spender = await sdk.accounts.getApprovalAddress(spenderOptions);
+  const weth = sdk.addressProvider.getAddress(AP_WETH_TOKEN, NO_VERSION);
   for (const [token, amount] of required.entries()) {
+    if (value > 0n && isAddressEqual(token, weth)) {
+      prereqs.push(
+        new AllowancePrerequisite({
+          token,
+          owner: wallet,
+          spender,
+          required: amount
+        })
+      );
+      if (amount > value) {
+        prereqs.push(
+          new BalancePrerequisite({
+            token,
+            owner: wallet,
+            required: amount - value
+          })
+        );
+      }
+      continue;
+    }
     prereqs.push(
       ...allowanceAndBalance({
         token,

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

@@ -9,7 +9,8 @@ async function checkPrerequisites(input, options) {
   const ctx = {
     sdk,
     wallet,
-    blockNumber: options?.blockNumber
+    blockNumber: options?.blockNumber,
+    value: input.value ?? 0n
   };
   const prereqs = await buildPrerequisites(tx, ctx);
   return Promise.all(prereqs.map((p) => p.verify(ctx)));

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

@@ -5,7 +5,7 @@ import {
   ERROR_UNPRICEABLE_TOKEN,
   PREVIEW_DUST
 } from "./types.js";
-function buildDelayedPreview(afterInstant, before, detected, convert) {
+function buildDelayedPreview(afterInstant, before, detected, convert, receivedToken) {
   const { request, intent } = detected;
   const post = afterInstant.clone();
   const converter = makeSafeConverter(convert);
@@ -13,7 +13,7 @@ function buildDelayedPreview(afterInstant, before, detected, convert) {
   const collateralWithdrawn = new AssetsMap();
   switch (intent?.type) {
     case "CLOSE_ACCOUNT":
-      return buildClosePreview(post, converter);
+      return buildClosePreview(post, converter, receivedToken);
     case "DECREASE_LEVERAGE":
       repayFromClaim(post, request.claimToken, converter.convert, claimed);
       break;
@@ -84,16 +84,17 @@ function totalValueInUnderlying(post, convert, dust) {
     (token, balance) => balance > dust ? convert(token, post.underlying, balance) : 0n
   );
 }
-function buildClosePreview(post, converter) {
+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 denominated in the underlying
+    // Oracle estimate computed in the underlying; RWA underlyings convert
+    // 1:1 with their vault asset, so the amount holds for `receivedToken`
     receivedAmount: {
-      token: post.underlying,
+      token: receivedToken,
       balance: BigIntMath.max(totalValue - post.totalDebt, 0n)
     },
     error: converter.error

package/dist/esm/preview/preview/previewOperation.js

@@ -56,6 +56,8 @@ async function previewMulticallOperation(input, operation, options) {
     operation.creditManager
   );
   const convert = (token, to, amount) => market.priceOracle.convert(token, to, amount);
+  const meta = sdk.tokensMeta.get(market.underlying);
+  const receivedToken = meta && sdk.tokensMeta.isRWAUnderlying(meta) ? meta.asset : market.underlying;
   return {
     operation: "DelayedCreditAccountOperation",
     creditAccount: operation.creditAccount,
@@ -66,7 +68,8 @@ async function previewMulticallOperation(input, operation, options) {
       after.account,
       before,
       delayed,
-      convert
+      convert,
+      receivedToken
     )
   };
 }

package/dist/types/preview/prerequisites/buildCollateralPrerequisites.d.ts

@@ -10,5 +10,6 @@ import type { PrerequisiteContext } from "./types.js";
  * the credit manager for classic markets, but a per-investor "special wallet"
  * for RWA markets. The resolution happens at build time because the spender is
  * part of the prerequisite's identity and UI detail.
+ *
  */
 export declare function buildCollateralPrerequisites(spenderOptions: GetApprovalAddressProps, multicall: InnerOperation[], ctx: PrerequisiteContext): Promise<Prerequisite[]>;

package/dist/types/preview/prerequisites/types.d.ts

@@ -34,8 +34,16 @@ export type PrerequisiteKind = PrerequisiteResult["kind"];
 /** Shared inputs for building and verifying prerequisites. */
 export interface PrerequisiteContext {
     sdk: OnchainSDK;
-    /** Address whose balances/allowances are checked (the tx sender). */
+    /**
+     * Address whose balances/allowances are checked (the tx sender).
+     **/
     wallet: Address;
-    /** Block to read at; defaults to latest. Only set for testnet forks. */
+    /**
+     * Block to read at; defaults to latest. Only set for testnet forks.
+     **/
     blockNumber?: bigint;
+    /**
+     * Transaction `msg.value`
+     **/
+    value: bigint;
 }

package/dist/types/preview/preview/buildDelayedPreview.d.ts

@@ -21,7 +21,9 @@ export type ConvertFn = (token: Address, to: Address, amount: bigint) => bigint;
  *
  * Intent-specific resume:
  * - `CLOSE_ACCOUNT`: everything is swapped into the underlying, the debt is
- *   fully repaid and the rest is withdrawn to the user.
+ *   fully repaid and the rest is withdrawn to the user as `receivedToken`
+ *   (the unwrapped underlying for RWA markets, converting 1:1 with the
+ *   underlying; the underlying itself otherwise).
  * - `DECREASE_LEVERAGE`: the claimed amount is swapped into the underlying
  *   and used to decrease the debt.
  * - `WITHDRAW_COLLATERAL`: the recorded amount of the recorded token is
@@ -38,5 +40,8 @@ export type ConvertFn = (token: Address, to: Address, amount: bigint) => bigint;
  * @param afterInstant - Account state after the instant part of the
  * transaction.
  * @param before - Account state before the transaction (the diff base).
+ * @param receivedToken - Token the `CLOSE_ACCOUNT` resume withdraws to the
+ * user: the unwrapped underlying (vault asset) for RWA markets, the
+ * underlying itself otherwise.
  */
-export declare function buildDelayedPreview(afterInstant: CreditAccountState, before: CreditAccountState, detected: DetectedDelayedOperation, convert: ConvertFn): InstantOperationPreview;
+export declare function buildDelayedPreview(afterInstant: CreditAccountState, before: CreditAccountState, detected: DetectedDelayedOperation, convert: ConvertFn, receivedToken: Address): InstantOperationPreview;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "14.12.0-next.33",
+  "version": "14.12.0-next.34",
   "description": "Gearbox SDK",
   "license": "MIT",
   "repository": {