@gearbox-protocol/sdk 14.11.3 → 14.12.0-next.10

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

@@ -1,11 +1,11 @@
 import type { Address, ContractFunctionArgs, GetContractReturnType, Hex, PublicClient } from "viem";
 import type { creditAccountCompressorAbi } from "../../abi/compressors/creditAccountCompressor.js";
 import type { iWithdrawalCompressorV310Abi } from "../../abi/IWithdrawalCompressorV310.js";
-import type { ConnectedBotData, Construct, CreditAccountData } from "../base/index.js";
+import type { Asset, ConnectedBotData, Construct, CreditAccountData } from "../base/index.js";
 import type { CreditSuite, PriceUpdate, RWAOperationParams } from "../market/index.js";
 import type { RWAOpenAccountRequirements } from "../market/rwa/index.js";
 import type { OnchainSDK } from "../OnchainSDK.js";
-import type { Asset, RouterCASlice, RouterCloseResult } from "../router/index.js";
+import type { RouterCASlice, RouterCloseResult } from "../router/index.js";
 import type { MultiCall, RawTx } from "../types/index.js";
 /**
  * @internal
@@ -672,6 +672,53 @@ export type GetApprovalAddressProps = {
     creditManager: Address;
     creditAccount: Address;
 };
+/**
+ * A single step in a generic credit account update operation chain.
+ *
+ * Used by {@link ICreditAccountsService.assembleCaUpdateCalls} to build the
+ * underlying credit facade multicall calls.
+ */
+export type CreditAccountUpdateOperation = {
+    type: "increaseDebt";
+    amount: bigint;
+} | {
+    type: "decreaseDebt";
+    amount: bigint;
+} | {
+    type: "addCollateral";
+    token: Address;
+    amount: bigint;
+} | {
+    type: "withdrawCollateral";
+    token: Address;
+    amount: bigint;
+} | {
+    type: "swap";
+} | {
+    type: "changeQuota";
+    quotaIncrease: Array<Asset>;
+    quotaDecrease: Array<Asset>;
+} | {
+    type: "closeCreditAccount";
+};
+/**
+ * Input for {@link ICreditAccountsService.assembleCaUpdateCalls}.
+ */
+export type AssembleCaUpdateCallsProps = {
+    operations: Array<CreditAccountUpdateOperation>;
+    /** One group per swap leg (in order), or a single group for the close path. */
+    routerCallGroups: Array<Array<MultiCall>>;
+    creditFacade: Address;
+    withdrawTo: Address;
+    creditAccount: {
+        debt: bigint;
+        assets: Array<Asset>;
+        initialQuotas: Record<Address, {
+            quota: bigint;
+        }>;
+    };
+    underlyingToken: Address;
+};
 export interface ICreditAccountsService extends Construct {
     sdk: OnchainSDK;
     /**
@@ -883,6 +930,41 @@ export interface ICreditAccountsService extends Construct {
     botMulticall(creditAccount: RouterCASlice, calls: Array<MultiCall>, options?: {
         ignoreReservePrices?: boolean;
     }): Promise<RawTx>;
+    /**
+     * Analyzes a multicall array and prepends necessary on-demand price feed updates.
+     *
+     * @param creditManager - Credit manager address
+     * @param calls - Original multicall payload
+     * @param creditAccount - Optional credit account slice (used to determine which tokens need prices)
+     * @param options - Optional settings for price update generation
+     * @returns Multicall payload with price updates prepended when needed
+     */
+    prependPriceUpdates(creditManager: Address, calls: Array<MultiCall>, creditAccount?: RouterCASlice, options?: {
+        ignoreReservePrices?: boolean;
+    }): Promise<Array<MultiCall>>;
+    /**
+     * Builds the credit facade multicall calls for a chain of update operations.
+     *
+     * @param props - Operation chain, router call groups and account context
+     * @returns Array of facade multicall calls (without price feed updates)
+     */
+    assembleCaUpdateCalls(props: AssembleCaUpdateCallsProps): Array<MultiCall>;
+    /**
+     * Executes a credit account update: prepends price feed updates and builds the raw
+     * multicall transaction. Uses the RWA factory when applicable.
+     *
+     * @param creditAccount - Credit account to update
+     * @param calls - Operation calls to execute
+     * @param options - Optional price update and ETH value settings
+     * @returns Raw transaction and the final multicall payload
+     */
+    executeCaUpdate(creditAccount: RouterCASlice, calls: Array<MultiCall>, options?: {
+        ignoreReservePrices?: boolean;
+        ethAmount?: bigint;
+    }): Promise<{
+        tx: RawTx;
+        calls: Array<MultiCall>;
+    }>;
     /**
      * Returns multicall entries to redeem (unwrap) RWA ERC-4626 vault shares into underlying for the given credit manager.
      * Used when withdrawing debt from a RWA market: redeems adapter vault shares so the underlying can be withdrawn.

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

@@ -151,7 +151,7 @@ export declare class BaseContract<abi extends Abi | readonly unknown[]> extends
      * @param strict - propagated from parseFunctionDataV2 for recursive parsing
      */
     protected parseFunctionParamsV2(params: DecodeFunctionDataReturnType<abi>, _strict?: boolean): Record<string, unknown>;
-    protected wrapParseCallV2(functionName: string, rawArgs: Record<string, unknown>): ParsedCallV2;
+    protected wrapParseCallV2(functionName: string, calldata: Hex, rawArgs: Record<string, unknown>): ParsedCallV2;
     /**
      * Creates a raw transaction for a function in this contract
      * @param parameters

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

@@ -1,5 +1,5 @@
 import type { Address, Chain, PublicClient, Transport } from "viem";
-import type { Asset } from "../router/index.js";
+import type { Asset } from "../index.js";
 import type { ILogger } from "../types/logger.js";
 import { AddressMap } from "../utils/index.js";
 import type { PhantomTokenMeta, RWATokenMeta, TokenMetaData } from "./token-types.js";

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

@@ -87,6 +87,20 @@ export interface TokenInfo {
      **/
     success: boolean;
 }
+/**
+ * A token address paired with a balance, used throughout the SDK to
+ * represent holdings, collateral inputs, and leftover targets.
+ **/
+export interface Asset {
+    /**
+     * ERC-20 token address.
+     **/
+    token: Address;
+    /**
+     * Token amount in the token's native decimals.
+     **/
+    balance: bigint;
+}
 /**
  * Compile-time assertion: `U` must be assignable to `T`.
  *
@@ -337,6 +351,10 @@ export interface ParsedCallV2 {
      * For unknown selectors: `"unknown function 0x1a2b3c4d"`
      */
     functionName: string;
+    /**
+     * Raw ABI-encoded calldata this call was parsed from.
+     **/
+    calldata: Hex;
     /**
      * Named arguments with their original types (bigint, Address, etc.).
      **/

package/dist/types/sdk/market/MarketRegister.d.ts

@@ -1,7 +1,7 @@
 import type { Address } from "viem";
 import type { MarketData, MarketFilter } from "../base/index.js";
 import type { OnchainSDK } from "../OnchainSDK.js";
-import type { MarketStateHuman } from "../types/index.js";
+import type { MarketStateHuman, ZapperStateHuman } from "../types/index.js";
 import { AddressMap } from "../utils/index.js";
 import { type DelegatedMulticall } from "../utils/viem/index.js";
 import type { CreditSuite } from "./credit/index.js";
@@ -9,7 +9,18 @@ import { MarketConfiguratorContract } from "./MarketConfiguratorContract.js";
 import { MarketSuite } from "./MarketSuite.js";
 import type { IPriceOracleContract } from "./oracle/index.js";
 import type { PoolSuite } from "./pool/index.js";
+import type { ZapperData } from "./types.js";
 import { ZapperRegister } from "./ZapperRegister.js";
+/** @internal */
+export interface MarketRegistryState {
+    markets: MarketData[];
+    zappers?: ZapperData[];
+}
+/** @internal */
+export interface MarketRegistryStateHuman {
+    markets: MarketStateHuman[];
+    zappers?: ZapperStateHuman[];
+}
 /**
  * Central registry of all Gearbox markets on the current chain.
  *
@@ -29,7 +40,7 @@ export declare class MarketRegister extends ZapperRegister {
      * bypassing on-chain reads.
      * @param state - Array of market data snapshots.
      **/
-    hydrate(state: MarketData[]): void;
+    hydrate({ markets, zappers }: MarketRegistryState): void;
     /**
      * @internal
      * Returns delegated multicalls for loading all markets from the on-chain
@@ -57,14 +68,12 @@ export declare class MarketRegister extends ZapperRegister {
     /**
      * Serializable snapshot of all loaded markets, suitable for hydration.
      **/
-    get state(): MarketData[];
+    get state(): MarketRegistryState;
     /**
      * Returns a human-readable snapshot of all markets.
      * @param raw - When `true`, includes raw/unformatted values.
      **/
-    stateHuman(raw?: boolean): {
-        markets: MarketStateHuman[];
-    };
+    stateHuman(raw?: boolean): MarketRegistryStateHuman;
     /**
      * All pool suites across loaded markets.
      **/

package/dist/types/sdk/market/ZapperRegister.d.ts

@@ -1,17 +1,38 @@
 import type { Address } from "viem";
 import { SDKConstruct } from "../base/index.js";
+import type { ZapperStateHuman } from "../types/index.js";
 import { AddressMap } from "../utils/index.js";
-import { type Zapper } from "./zapper/index.js";
+import type { ZapperData } from "./types.js";
+import { type IZapperContract } from "./zapper/index.js";
 export declare class ZapperRegister extends SDKConstruct {
     #private;
     /**
      * Load zappers for all pools using periphery compressor, adds hardcoded zappers
      */
     loadZappers(force?: boolean): Promise<void>;
-    get zappers(): AddressMap<Zapper[]>;
-    poolZappers(pool: Address): Zapper[];
+    /**
+     * Serializable snapshot of all loaded zappers, suitable for hydration.
+     * Returns `undefined` when zappers were never loaded (i.e. `loadZappers` was
+     * not called), so the not-loaded state round-trips cleanly.
+     **/
+    protected get zappersState(): ZapperData[] | undefined;
+    /**
+     * Restores zapper state from a previously serialized snapshot,
+     * bypassing on-chain reads.
+     * @param state - Array of zapper data snapshots, or `undefined` when zappers
+     *   were not loaded in the snapshot (leaves the registry in the not-loaded state).
+     **/
+    protected hydrateZappers(state?: ZapperData[]): void;
+    /**
+     * Returns a human-readable snapshot of all loaded zappers.
+     * Returns `undefined` when zappers were never loaded.
+     * @param raw - When `true`, includes raw/unformatted values.
+     **/
+    protected zappersStateHuman(_?: boolean): ZapperStateHuman[] | undefined;
+    get zappers(): AddressMap<IZapperContract[]>;
+    poolZappers(pool: Address): IZapperContract[];
     /**
      * Can return multiple zappers if there are multiple zappers for the same tokenIn and tokenOut
      */
-    getZapper(pool: Address, tokenIn: Address, tokenOut: Address): Array<Zapper> | undefined;
+    getZapper(pool: Address, tokenIn: Address, tokenOut: Address): Array<IZapperContract> | undefined;
 }

package/dist/types/sdk/market/rwa/securitize/SecuritizeRWAFactory.d.ts

@@ -1,4 +1,4 @@
-import { type Address } from "viem";
+import { type Address, type DecodeFunctionDataReturnType } from "viem";
 import type { GetOpenAccountRequirementsProps } from "../../../accounts/types.js";
 import { BaseContract } from "../../../base/index.js";
 import type { OnchainSDK } from "../../../OnchainSDK.js";
@@ -463,10 +463,15 @@ export declare class SecuritizeRWAFactory extends BaseContract<abi> implements I
     readonly dsTokens: DStokenData[];
     readonly contractType = "RWA_FACTORY::SECURITIZE";
     constructor(sdk: OnchainSDK, data: RWAFactoryData);
+    protected parseFunctionParamsV2(params: DecodeFunctionDataReturnType<abi>, strict?: boolean): Record<string, unknown>;
     /**
      * {@inheritDoc IRWAFactory.decodeInvestorData}
      */
     decodeInvestorData(data: RWACompressorInvestorData): SecuritizeInvestorData;
+    /**
+     * {@inheritDoc IRWAFactory.getTokens}
+     */
+    getTokens(): Address[];
     /**
      * {@inheritDoc IRWAFactory.getInvestor}
      */

package/dist/types/sdk/market/rwa/types.d.ts

@@ -102,6 +102,12 @@ export interface IRWAFactory<T extends RWAFactoryType = RWAFactoryType> extends
      * @param data - raw RWACompressor InvestorData
      **/
     decodeInvestorData(data: RWACompressorInvestorData): RWAInvestorData<T>;
+    /**
+     * Returns the RWA token addresses this factory can register/gate
+     * (e.g. Securitize DSTokens). Named for parity with the Solidity
+     * `IRWAFactory` contract.
+     **/
+    getTokens(): Address[];
     /**
      * Returns the investor address for a credit account.
      * @param creditAccount - credit account address
@@ -161,11 +167,13 @@ export interface IRWAFactory<T extends RWAFactoryType = RWAFactoryType> extends
     openCreditAccount(creditManager: Address, calls: MultiCall[], options?: RWAOperationParams<T>): RawTx;
 }
 /**
- * Narrows an {@link IRWAFactory} to a specific factory type.
+ * Narrows any contract to an {@link IRWAFactory}.
  *
- * @param factory - factory instance to check
- * @param type - expected factory type literal
- * @returns `true` if `factory.factoryType === type`
+ * @param contract - contract instance to check
+ * @param type - optional expected factory type literal. When provided, narrows
+ *   to the concrete `IRWAFactory<T>`; when omitted, narrows to the
+ *   generalized {@link IRWAFactory}
+ * @returns `true` if the contract is an RWA factory (of the given type, if provided)
  **/
-export declare function isRWAFactory<T extends RWAFactoryType>(factory: IRWAFactory, type: T): factory is IRWAFactory<T>;
+export declare function isRWAFactory<T extends RWAFactoryType = RWAFactoryType>(contract: IBaseContract, type?: T): contract is IRWAFactory<T>;
 export {};

package/dist/types/sdk/market/zapper/IERC20ZapperContract.d.ts

@@ -1,8 +1,8 @@
 import type { Address, Hex } from "viem";
-import { BaseContract } from "../../base/index.js";
 import type { OnchainSDK } from "../../OnchainSDK.js";
 import type { RawTx } from "../../types/index.js";
 import type { ZapperData } from "../types.js";
+import { ZapperContract } from "./ZapperContract.js";
 declare const abi: readonly [{
     readonly type: "function";
     readonly inputs: readonly [{
@@ -197,132 +197,195 @@ declare const abi: readonly [{
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "contractType";
     readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
     readonly name: "pool";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "previewDeposit";
     readonly inputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly name: "previewDeposit";
     readonly outputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "previewRedeem";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
-    readonly name: "previewRedeem";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
+    readonly name: "redeem";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "receiver";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
-    readonly name: "redeem";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "redeemWithPermit";
     readonly inputs: readonly [{
         readonly name: "tokenOutAmount";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "receiver";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }, {
         readonly name: "deadline";
-        readonly internalType: "uint256";
         readonly type: "uint256";
+        readonly internalType: "uint256";
     }, {
         readonly name: "v";
-        readonly internalType: "uint8";
         readonly type: "uint8";
+        readonly internalType: "uint8";
     }, {
         readonly name: "r";
-        readonly internalType: "bytes32";
         readonly type: "bytes32";
+        readonly internalType: "bytes32";
     }, {
         readonly name: "s";
-        readonly internalType: "bytes32";
         readonly type: "bytes32";
+        readonly internalType: "bytes32";
     }];
-    readonly name: "redeemWithPermit";
     readonly outputs: readonly [{
         readonly name: "tokenInAmount";
+        readonly type: "uint256";
         readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemWithPermitAllowed";
+    readonly inputs: readonly [{
+        readonly name: "tokenOutAmount";
         readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "receiver";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "nonce";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "expiry";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "v";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "r";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "s";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "tokenInAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "nonpayable";
 }, {
     readonly type: "function";
+    readonly name: "serialize";
     readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
     readonly name: "tokenIn";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly inputs: readonly [];
     readonly name: "tokenOut";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
     }];
     readonly stateMutability: "view";
 }, {
     readonly type: "function";
-    readonly inputs: readonly [];
     readonly name: "underlying";
+    readonly inputs: readonly [];
     readonly outputs: readonly [{
         readonly name: "";
-        readonly internalType: "address";
         readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
     }];
     readonly stateMutability: "view";
 }];
 type abi = typeof abi;
-export declare class IERC20ZapperContract extends BaseContract<abi> implements ZapperData {
-    readonly pool: ZapperData["pool"];
-    readonly type: ZapperData["type"];
-    readonly baseParams: ZapperData["baseParams"];
-    readonly tokenIn: ZapperData["tokenIn"];
-    readonly tokenOut: ZapperData["tokenOut"];
+export declare class IERC20ZapperContract extends ZapperContract<abi> {
     constructor(sdk: OnchainSDK, data: ZapperData);
     /**
      * Deposits ERC20 tokens into the pool via this zapper.
@@ -337,14 +400,5 @@ export declare class IERC20ZapperContract extends BaseContract<abi> implements Z
      * EIP-2612 permit signature, skipping a separate approve transaction.
      */
     depositWithReferralAndPermit(tokenInAmount: bigint, receiver: Address, referralCode: bigint, deadline: bigint, v: number, r: Hex, s: Hex): RawTx;
-    /**
-     * Redeems pool shares (diesel tokens) for the underlying asset via this zapper.
-     */
-    redeem(tokenInAmount: bigint, receiver: Address): RawTx;
-    /**
-     * Redeems pool shares via this zapper with an EIP-2612 permit signature,
-     * skipping a separate approve transaction.
-     */
-    redeemWithPermit(tokenInAmount: bigint, receiver: Address, deadline: bigint, v: number, r: Hex, s: Hex): RawTx;
 }
 export {};