@gearbox-protocol/sdk 14.12.0-next.47 → 14.12.0-next.49

package/dist/types/plugins/adapters/abi/midas/iMidasGatewayV311.d.ts

@@ -0,0 +1,261 @@
+export declare const iMidasGatewayV311Abi: readonly [{
+    readonly type: "function";
+    readonly name: "accessControl";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    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: "depositInstant";
+    readonly inputs: readonly [{
+        readonly name: "amountToken";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "minReceiveAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "referrerId";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "isEligibleAccountOwner";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "mToken";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "mode";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "enum MidasMode";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "pendingAndClaimableTokenOutAmounts";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "pendingAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "claimableAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "pendingRedeemers";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "redeemers";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "phantomToken";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "quoteToken";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "redeemInstant";
+    readonly inputs: readonly [{
+        readonly name: "amountMTokenIn";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "minReceiveAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redemptionLogger";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "requestRedeem";
+    readonly inputs: readonly [{
+        readonly name: "amountMTokenIn";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "extraData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "transferMaster";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "transferRedeemer";
+    readonly inputs: readonly [{
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "newAccount";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "withdraw";
+    readonly inputs: readonly [{
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "withdrawFromRedeemer";
+    readonly inputs: readonly [{
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "error";
+    readonly name: "AccessControlNotSetException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ArbitraryCAAllowedInPermissionedModeException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "CreditAccountNotEligibleException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "IncompatibleAccessControlsException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "IncompatibleIssuanceAndRedemptionVaultsException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InsufficientBalanceException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "MaxPendingRedeemersPerAccountException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "NewAccountNotGreenlistedException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "RedeemerNotOwnedByAccountException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "RedeemerTransferNotAllowedException";
+    readonly inputs: readonly [];
+}];

package/dist/types/plugins/adapters/abi/midas/index.d.ts

@@ -0,0 +1 @@
+export * from "./iMidasGatewayV311.js";

package/dist/types/plugins/adapters/abi/securitize/iSecuritizeRedemptionGatewayV311.d.ts

@@ -70,6 +70,20 @@ export declare const iSecuritizeRedemptionGatewayV311Abi: readonly [{
         readonly internalType: "address[]";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isEligibleAccountOwner";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "masterRedeemer";
@@ -90,6 +104,16 @@ export declare const iSecuritizeRedemptionGatewayV311Abi: readonly [{
         readonly internalType: "address";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "phantomToken";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "redeem";

package/dist/types/plugins/adapters/contracts/MidasGatewayAdapterContract.d.ts

@@ -377,6 +377,20 @@ declare const protocolAbi: readonly [{
     }];
     readonly outputs: readonly [];
     readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "isEligibleAccountOwner";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "mToken";
@@ -387,6 +401,16 @@ declare const protocolAbi: readonly [{
         readonly internalType: "address";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "mode";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint8";
+        readonly internalType: "enum MidasMode";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "pendingAndClaimableTokenOutAmounts";
@@ -539,6 +563,10 @@ declare const protocolAbi: readonly [{
     readonly type: "error";
     readonly name: "AccessControlNotSetException";
     readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ArbitraryCAAllowedInPermissionedModeException";
+    readonly inputs: readonly [];
 }, {
     readonly type: "error";
     readonly name: "CreditAccountNotEligibleException";

package/dist/types/plugins/adapters/contracts/SecuritizeRedemptionGatewayAdapterContract.d.ts

@@ -327,6 +327,20 @@ declare const protocolAbi: readonly [{
         readonly internalType: "address[]";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isEligibleAccountOwner";
+    readonly inputs: readonly [{
+        readonly name: "account";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "masterRedeemer";
@@ -347,6 +361,16 @@ declare const protocolAbi: readonly [{
         readonly internalType: "address";
     }];
     readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "phantomToken";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
 }, {
     readonly type: "function";
     readonly name: "redeem";

package/dist/types/rewards/rewards/merkl-api.d.ts

@@ -40,7 +40,7 @@ export declare class MerkleXYZApi {
     static defaultDomain: string;
     static angleDomain: string;
     static apiKeyHeader: string;
-    static fetchWithFallback: <T>(getUrl: (domain: string) => string, apiKey?: string) => Promise<import("axios").AxiosResponse<T, any, {}>>;
+    static fetchWithFallback: <T>(getUrl: (domain: string) => string, apiKey?: string) => Promise<import("axios").AxiosResponse<T, any, {}, any>>;
     static getUserRewardsUrl: (options: UserOptions) => (domain: string) => string;
 }
 export {};

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

@@ -107,7 +107,7 @@ export declare class MultichainSDK<const Plugins extends PluginsMap = {}> {
      * Namespace for liquidatable credit accounts discovery across all
      * configured chains.
      */
-    readonly liquidations: ILiquidationsService;
+    readonly liquidations: ILiquidationsService<true>;
     constructor(options: MultichainSDKOptions<Plugins>);
     /**
      * Attach all configured chains in parallel.

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

@@ -1,5 +1,6 @@
 import { SDKConstruct } from "../../base/index.js";
-import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
+import type { RawTx } from "../../types/index.js";
+import type { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
 /**
  * Per-chain implementation of {@link ILiquidationsService}.
  *
@@ -17,6 +18,10 @@ export declare class LiquidationsService extends SDKConstruct implements ILiquid
      * {@inheritDoc ILiquidationsService.getLiquidationDetails}
      **/
     getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
+    /**
+     * {@inheritDoc ILiquidationsService.buildLiquidationTx}
+     **/
+    buildLiquidationTx(props: BuildLiquidationTxProps): Promise<RawTx>;
     /**
      * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
      **/

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

@@ -1,27 +1,32 @@
 import type { MultichainSDK } from "../../MultichainSDK.js";
 import type { PluginsMap } from "../../plugins/index.js";
-import type { GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
+import type { RawTx } from "../../types/index.js";
+import type { BuildLiquidationTxProps, GetLiquidatableAccountsProps, GetLiquidationDetailsProps, GetLiquidatorWithdrawalsProps, ILiquidationsService, LiquidatableAccount, LiquidationDetails, LiquidatorWithdrawal } from "./types.js";
 /**
  * Cross-chain implementation of {@link ILiquidationsService}.
  *
  * Aggregates liquidatable accounts over all chains configured in
  * {@link MultichainSDK} (optionally restricted via
- * {@link GetLiquidatableAccountsProps.networks}). A failed chain is logged as
+ * {@link MultichainNetworksProps.networks}). A failed chain is logged as
  * a warning and skipped, so one dead RPC does not empty the whole list.
  **/
-export declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> implements ILiquidationsService {
+export declare class MultichainLiquidationsService<const Plugins extends PluginsMap = {}> implements ILiquidationsService<true> {
     #private;
     constructor(sdk: MultichainSDK<Plugins>);
     /**
      * {@inheritDoc ILiquidationsService.getLiquidatableAccounts}
      **/
-    getLiquidatableAccounts(props?: GetLiquidatableAccountsProps): Promise<LiquidatableAccount[]>;
+    getLiquidatableAccounts(props?: GetLiquidatableAccountsProps<true>): Promise<LiquidatableAccount[]>;
     /**
      * {@inheritDoc ILiquidationsService.getLiquidationDetails}
      **/
-    getLiquidationDetails(props: GetLiquidationDetailsProps): Promise<LiquidationDetails>;
+    getLiquidationDetails(props: GetLiquidationDetailsProps<true>): Promise<LiquidationDetails>;
+    /**
+     * {@inheritDoc ILiquidationsService.buildLiquidationTx}
+     **/
+    buildLiquidationTx(props: BuildLiquidationTxProps<true>): Promise<RawTx>;
     /**
      * {@inheritDoc ILiquidationsService.getLiquidatorWithdrawals}
      **/
-    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps): Promise<LiquidatorWithdrawal[]>;
+    getLiquidatorWithdrawals(props: GetLiquidatorWithdrawalsProps<true>): Promise<LiquidatorWithdrawal[]>;
 }

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

@@ -0,0 +1,6 @@
+import type { Address } from "viem";
+/**
+ * TODO: the contract is not deployed yet, replace with the real address
+ * (per-network lookup if it ends up being deployed on several chains).
+ **/
+export declare const LIQUIDATION_COMPRESSOR_V313_ADDRESS: Address;

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

@@ -1,8 +1,22 @@
-import type { Address } from "viem";
+import type { Address, ContractFunctionReturnType } from "viem";
+import type { iLiquidationCompressorV313Abi } from "../../../abi/ILiquidationCompressorV313.js";
 import type { CreditAccountData } from "../../base/index.js";
 import type { NetworkType } from "../../chain/index.js";
+import type { RawTx } from "../../types/index.js";
 import type { CurrentWithdrawals } from "../withdrawal-compressor/index.js";
-import type { LiquidatorWithdrawal } from "./types.js";
+import type { LiquidationApproval, LiquidatorWithdrawal, ReceivedAsset } from "./types.js";
+/**
+ * Raw `LiquidationData` returned by `LiquidationCompressor.getLiquidationData`.
+ **/
+export type OnchainLiquidationData = ContractFunctionReturnType<typeof iLiquidationCompressorV313Abi, "nonpayable", "getLiquidationData">;
+/**
+ * Single element of {@link OnchainLiquidationData.expectedOutputs}.
+ **/
+export type OnchainLiquidationOutput = OnchainLiquidationData["expectedOutputs"][number];
+/**
+ * Single call built by the liquidation compressor.
+ **/
+export type OnchainLiquidationCall = OnchainLiquidationData["liquidationCall"];
 /**
  * Token balances at or below this threshold are treated as dust and ignored,
  * consistent with the rest of the SDK (see `filterDust`).
@@ -44,3 +58,60 @@ export declare function pickMainAsset(ca: CreditAccountData, convert: (token: Ad
  * @param network - Network the withdrawals live on
  **/
 export declare function toLiquidatorWithdrawals(current: CurrentWithdrawals, network: NetworkType): LiquidatorWithdrawal[];
+/**
+ * Normalizes the liquidation compressor outputs into assets the liquidator
+ * receives. Zero `redeemerAddress` and `claimableAt` (used by the contracts
+ * for "not applicable") become `undefined`.
+ *
+ * @param outputs - `expectedOutputs` of the compressor's liquidation data
+ **/
+export declare function toReceivedAssets(outputs: readonly OnchainLiquidationOutput[]): ReceivedAsset[];
+/**
+ * Props for {@link toLiquidationApproval}.
+ **/
+export interface ToLiquidationApprovalProps {
+    /**
+     * Target of the compressor's `liquidationCall`.
+     **/
+    target: Address;
+    /**
+     * Credit facade of the liquidated account's credit manager.
+     **/
+    creditFacade: Address;
+    /**
+     * Credit manager of the liquidated account.
+     **/
+    creditManager: Address;
+    /**
+     * Token the liquidation transaction pulls from the liquidator.
+     **/
+    token: Address;
+    /**
+     * Amount of `token` the liquidation transaction pulls.
+     **/
+    amount: bigint;
+}
+/**
+ * Resolves the approval the liquidator must grant for the liquidation call.
+ *
+ * A call targeting the credit facade is paid by `msg.sender` but transferred by
+ * the credit manager, so the latter is the spender. Any other target is a
+ * dedicated liquidator contract (Midas / Securitize) that pulls the token to
+ * itself and re-approves the credit manager, so it is the spender itself.
+ *
+ * @param props - See {@link ToLiquidationApprovalProps}
+ * @returns The approval, or `undefined` when the call pulls nothing
+ **/
+export declare function toLiquidationApproval(props: ToLiquidationApprovalProps): LiquidationApproval | undefined;
+/**
+ * Converts the compressor's liquidation call into a raw transaction.
+ *
+ * The calldata is passed through as-is: depending on the liquidated assets,
+ * the target is either the credit facade or a dedicated liquidator contract
+ * (with its own function signature), so it cannot be re-encoded from a single
+ * known ABI.
+ *
+ * @param call - `liquidationCall` of the compressor's liquidation data
+ * @param description - Optional human-readable description
+ **/
+export declare function liquidationCallToRawTx(call: OnchainLiquidationCall, description?: string): RawTx;

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

@@ -1,4 +1,4 @@
-export * from "./helpers.js";
+export * from "./constants.js";
 export * from "./LiquidationsService.js";
 export * from "./MultichainLiquidationsService.js";
 export * from "./types.js";