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

package/dist/types/abi/ierc4626Adapter.d.ts

@@ -0,0 +1,179 @@
+export declare const ierc4626AdapterAbi: readonly [{
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "asset";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "contractType";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "bytes32";
+        readonly type: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "creditManager";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "assets";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "deposit";
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "leftoverAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "depositDiff";
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "shares";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "mint";
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "shares";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "redeem";
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "leftoverAmount";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly name: "redeemDiff";
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "serialize";
+    readonly outputs: readonly [{
+        readonly name: "serializedData";
+        readonly internalType: "bytes";
+        readonly type: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "targetContract";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "vault";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [];
+    readonly name: "version";
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly inputs: readonly [{
+        readonly name: "assets";
+        readonly internalType: "uint256";
+        readonly type: "uint256";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }, {
+        readonly name: "";
+        readonly internalType: "address";
+        readonly type: "address";
+    }];
+    readonly name: "withdraw";
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly internalType: "bool";
+        readonly type: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}];

package/dist/types/abi/router/midasWorker.d.ts

@@ -547,7 +547,7 @@ export declare const midasWorkerAbi: readonly [{
     readonly type: "function";
     readonly name: "trimSpecialVertex";
     readonly inputs: readonly [{
-        readonly name: "edge";
+        readonly name: "";
         readonly type: "tuple";
         readonly internalType: "struct Edge";
         readonly components: readonly [{
@@ -592,7 +592,7 @@ export declare const midasWorkerAbi: readonly [{
             readonly internalType: "uint256";
         }];
     }, {
-        readonly name: "graph";
+        readonly name: "";
         readonly type: "tuple";
         readonly internalType: "struct Graph";
         readonly components: readonly [{
@@ -667,7 +667,7 @@ export declare const midasWorkerAbi: readonly [{
             }];
         }];
     }, {
-        readonly name: "targetToken";
+        readonly name: "";
         readonly type: "address";
         readonly internalType: "address";
     }];
@@ -676,7 +676,7 @@ export declare const midasWorkerAbi: readonly [{
         readonly type: "bool";
         readonly internalType: "bool";
     }];
-    readonly stateMutability: "view";
+    readonly stateMutability: "pure";
 }, {
     readonly type: "function";
     readonly name: "updateRouter";

package/dist/types/common-utils/utils/creditAccount/sort.d.ts

@@ -36,7 +36,7 @@ export declare function sortAssets<T extends Asset>(balances: Array<T>, prices:
  *
  * @returns Comparator result suitable for `Array.prototype.sort`.
  */
-export declare function assetComparator<T extends Asset>(t1: T, t2: T, prices1: Record<Address, bigint> | undefined, prices2: Record<Address, bigint> | undefined, tokens1: Record<Address, TokenDataSlice> | undefined, tokens2: Record<Address, TokenDataSlice> | undefined): 1 | 0 | -1;
+export declare function assetComparator<T extends Asset>(t1: T, t2: T, prices1: Record<Address, bigint> | undefined, prices2: Record<Address, bigint> | undefined, tokens1: Record<Address, TokenDataSlice> | undefined, tokens2: Record<Address, TokenDataSlice> | undefined): -1 | 0 | 1;
 /**
  * Alphabetical comparator for token symbols (case-insensitive).
  *
@@ -44,7 +44,7 @@ export declare function assetComparator<T extends Asset>(t1: T, t2: T, prices1:
  * @param t2 Second token metadata.
  * @returns `-1`, `0`, or `1` for ascending symbol order.
  */
-export declare function tokensAbcComparator(t1?: TokenDataSlice, t2?: TokenDataSlice): 1 | 0 | -1;
+export declare function tokensAbcComparator(t1?: TokenDataSlice, t2?: TokenDataSlice): -1 | 0 | 1;
 /**
  * Descending numeric comparator for bigint amounts.
  *
@@ -52,4 +52,4 @@ export declare function tokensAbcComparator(t1?: TokenDataSlice, t2?: TokenDataS
  * @param t2 Second amount.
  * @returns `-1` when `t1` should come before `t2`, otherwise `1`.
  */
-export declare function amountAbcComparator(t1: bigint, t2: bigint): 1 | -1;
+export declare function amountAbcComparator(t1: bigint, t2: bigint): -1 | 1;

package/dist/types/common-utils/utils/strategies/assets/assets.d.ts

@@ -1,3 +1,3 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 export declare function getDefaultAsset(token: Address): Omit<Asset, "balance">;

package/dist/types/common-utils/utils/strategies/credit-managers/get-wallet-balances-allowed-on-cm.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { TokenSlice } from "../strategy-info/types.js";
 export interface GetWalletBalancesAllowedOnCMProps {
     walletBalances: Record<Address, bigint> | undefined;

package/dist/types/common-utils/utils/strategies/eligibility/is-strategy-eligible.d.ts

@@ -1,7 +1,7 @@
 import type { AppChains, CuratorFilter, GearboxSDKFullState, NotValidatedStrategy, StrategyCreditManagerView } from "../types.js";
 export declare function isStrategyEligible<CM extends StrategyCreditManagerView>(s: Pick<NotValidatedStrategy, "chainId" | "network" | "hideInProd" | "tokenOutAddress" | "showInMainApp">, allowedChains: AppChains, showHiddenStrategies: boolean, sdkStateByChain: Record<number, Pick<GearboxSDKFullState<CM>, "tokens"> | undefined> | undefined, curatorFilter: CuratorFilter): {
     readonly isEligible: true;
-    readonly network: "Mainnet" | "Arbitrum" | "Optimism" | "Base" | "Sonic" | "MegaETH" | "Monad" | "Berachain" | "Avalanche" | "BNB" | "WorldChain" | "Etherlink" | "Hemi" | "Lisk" | "Plasma" | "Somnia";
+    readonly network: "Arbitrum" | "Avalanche" | "BNB" | "Base" | "Berachain" | "Etherlink" | "Hemi" | "Lisk" | "Mainnet" | "MegaETH" | "Monad" | "Optimism" | "Plasma" | "Somnia" | "Sonic" | "WorldChain";
 } | {
     readonly isEligible: false;
     readonly network: undefined;

package/dist/types/common-utils/utils/strategies/lists/get-available-and-disabled-strategies.d.ts

@@ -2,6 +2,6 @@ import type { CuratorFilter, StrategiesCMListByChain, Strategy, StrategyCreditMa
 export declare function getAvailableAndDisabledStrategies<CM extends StrategyCreditManagerView>(list: Strategy[] | undefined | undefined, listCMs: StrategiesCMListByChain<CM> | undefined, curatorFilter: CuratorFilter | undefined): {
     available: Error | import("../types.js").StrategyRecord | null;
     disabled: import("../types.js").StrategyRecord;
-    availableList: Error | Strategy[] | null;
+    availableList: Strategy[] | Error | null;
     disabledList: Strategy[];
 };

package/dist/types/common-utils/utils/strategies/strategy-info/calculate-total-apy.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { QuotaSlice, TokenSlice } from "./types.js";
 export interface TotalAPY {
     overallAPY: number | undefined | null;

package/dist/types/common-utils/utils/strategies/strategy-info/calculate-total-points.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { LocalDebtReward, LocalPointsInfo, LocalPointsReward } from "../types/points-slices.js";
 import type { TokenSlice } from "./types.js";
 export interface PointsData {

package/dist/types/common-utils/utils/strategies/tokens/add-amount-in-target.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { TokenSlice } from "../strategy-info/types.js";
 export declare function addAmountInTarget<T extends Asset>(asset: T, tokensList: Record<Address, TokenSlice>, prices: Record<Address, bigint>, toPrice: bigint, toDecimals: number): T & {
     amountInTarget: bigint;

package/dist/types/common-utils/utils/strategies/tokens/get-list-with-amount-in-target.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { TokenSlice } from "../strategy-info/types.js";
 export interface AddAmountInTargetProps<T> {
     assets: Array<T>;

package/dist/types/common-utils/utils/strategies/types/strategy-earnings.d.ts

@@ -1,4 +1,4 @@
-import type { Asset } from "../../../../sdk/router/types.js";
+import type { Asset } from "../../../../sdk/index.js";
 import type { calculateEarnings } from "../../apy/calculate-earnings.js";
 import type { Strategy } from "../../strategies/types/strategy.js";
 import type { calculateTotalAPY } from "../strategy-info/calculate-total-apy.js";

package/dist/types/common-utils/utils/validation/validate-balances.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 import type { ValidateBalanceResult } from "./validate-balance.js";
 export interface ValidateBalancesProps {
     balances: Record<Address, bigint>;

package/dist/types/common-utils/utils/validation/validate-open-account.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 import type { CreditManagerSlice } from "../strategies/strategy-info/types.js";
 import type { ValidateQuotaResult } from "./validate-quota.js";
 export interface ValidateOpenAccountProps {

package/dist/types/common-utils/utils/validation/validate-quota.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 import type { CreditManagerSlice } from "../strategies/strategy-info/types.js";
 export interface ValidateQuotaProps {
     desiredQuota: Record<Address, Asset>;

package/dist/types/common-utils/utils/validation/validate-token-to-obtain.d.ts

@@ -1,5 +1,5 @@
 import type { Address } from "viem";
-import type { Asset } from "../../../sdk/router/types.js";
+import type { Asset } from "../../../sdk/index.js";
 export interface ValidateTokenToObtainProps {
     targetToken: Address | Array<Asset> | null;
     creditManager: {

package/dist/types/dev/abi.d.ts

@@ -1,6 +1,6 @@
 export declare const iaclTraitAbi: readonly [{
     readonly name: "acl";
-    readonly type: "function";
+    readonly type: 'function';
     readonly stateMutability: "view";
     readonly inputs: readonly [];
     readonly outputs: readonly [{
@@ -9,7 +9,7 @@ export declare const iaclTraitAbi: readonly [{
 }];
 export declare const iOwnableAbi: readonly [{
     readonly name: "owner";
-    readonly type: "function";
+    readonly type: 'function';
     readonly stateMutability: "view";
     readonly inputs: readonly [];
     readonly outputs: readonly [{
@@ -18,7 +18,7 @@ export declare const iOwnableAbi: readonly [{
 }];
 export declare const iDegenNftv2Abi: readonly [{
     readonly name: "minter";
-    readonly type: "function";
+    readonly type: 'function';
     readonly stateMutability: "view";
     readonly inputs: readonly [];
     readonly outputs: readonly [{
@@ -26,7 +26,7 @@ export declare const iDegenNftv2Abi: readonly [{
     }];
 }, {
     readonly name: "mint";
-    readonly type: "function";
+    readonly type: 'function';
     readonly stateMutability: "nonpayable";
     readonly inputs: readonly [{
         readonly type: "address";

package/dist/types/dev/claimDSToken.d.ts

@@ -3,7 +3,7 @@ import { type ILogger } from "../sdk/index.js";
 import type { AnvilClient } from "./createAnvilClient.js";
 interface ClaimDSTokenProps {
     anvil: AnvilClient;
-    claimer: Address;
+    investor: Address;
     adminPrivateKey: Hex;
     /**
      * DSToken addresses
@@ -20,14 +20,13 @@ interface ClaimDSTokenProps {
 type ClaimDSTokensProps = Omit<ClaimDSTokenProps, "token"> & {
     tokens: Address[];
 };
-export declare function registerInvestor(props: ClaimDSTokenProps): Promise<void>;
 export declare function claimDSToken(props: ClaimDSTokenProps): Promise<void>;
 /**
  * Helper function to claim DSToken from the faucet.
  * Works both for MockDStoken and real DSToken connected by securitize-deploy script
  * @param forkStatus
  * @param publicClient
- * @param claimer
+ * @param investor
  * @returns
  */
 export declare function claimDSTokens(props: ClaimDSTokensProps): Promise<void>;

package/dist/types/dev/index.d.ts

@@ -10,6 +10,7 @@ export * from "./EthCallSpy.js";
 export * from "./isOutOfSyncError.js";
 export * from "./isRateLimitError.js";
 export * from "./isTransientError.js";
+export * from "./kycUtils.js";
 export { isRangeError, type LogSplitterTransportOptions, logSplitterTransport, } from "./logSplitterTransport.js";
 export * from "./ltUtils.js";
 export * from "./migrateFaucet.js";
@@ -21,3 +22,4 @@ export * from "./resilientTransport.js";
 export * from "./transports.js";
 export * from "./types.js";
 export * from "./verifyTestnet.js";
+export * from "./withdrawalUtils.js";

package/dist/types/dev/kycUtils.d.ts

@@ -0,0 +1,124 @@
+import { type Address, type Hex } from "viem";
+import { type ILogger, OnchainSDK } from "../sdk/index.js";
+import type { AnvilClient } from "./createAnvilClient.js";
+/**
+ * Writes to a contract, mines a block and waits for the receipt
+ */
+export declare function writeAndWait(anvil: AnvilClient, params: Parameters<AnvilClient["writeContract"]>[0]): Promise<Hex>;
+export interface RegisterSecuritizeInvestorProps {
+    anvil: AnvilClient;
+    /**
+     * Wallet to register in the Securitize DS registry
+     */
+    investor: Address;
+    adminPrivateKey: Hex;
+    /**
+     * DSToken address
+     */
+    token: Address;
+    logger?: ILogger;
+}
+/**
+ * Registers a wallet as a Securitize investor (fake KYC) in the DS registry
+ * service of a DSToken.
+ * Works both for MockDSToken and real DSToken connected by securitize-deploy script
+ */
+export declare function registerSecuritizeInvestor(props: RegisterSecuritizeInvestorProps): Promise<void>;
+export interface RegisterMidasInvestorProps {
+    anvil: AnvilClient;
+    /**
+     * Investor EOA to greenlist
+     */
+    investor: Address;
+    /**
+     * Midas access control admin, impersonated on the fork
+     * (MIDAS_ACL_ADMIN in periphery-v3/router-v3 foundry tests)
+     */
+    admin: Address;
+    /**
+     * mToken address, the gateway is resolved from it
+     */
+    token: Address;
+    /**
+     * Attached SDK, created from `anvil` when omitted
+     */
+    sdk?: OnchainSDK;
+    marketConfigurators?: Address[];
+    logger?: ILogger;
+}
+/**
+ * Greenlists an investor in Midas access control (fake KYC) on an anvil fork.
+ *
+ * Replicates the `_grantGreenlistAdmin` / `_grantGreenlist` logic from the
+ * foundry tests (periphery-v3's WithdrawalCompressorMidasRWA.t.sol and
+ * router-v3's RouterLiveTestMidas.sol) by impersonating the Midas access
+ * control admin instead of pranking it.
+ */
+export declare function registerMidasInvestor(props: RegisterMidasInvestorProps): Promise<void>;
+export interface GreenlistMidasGatewayProps {
+    anvil: AnvilClient;
+    /**
+     * Investor EOA to greenlist
+     */
+    investor: Address;
+    /**
+     * Midas access control admin, impersonated on the fork
+     * (MIDAS_ACL_ADMIN in periphery-v3/router-v3 foundry tests)
+     */
+    admin: Address;
+    /**
+     * Midas gateway address
+     */
+    gateway: Address;
+    logger?: ILogger;
+}
+/**
+ * Greenlists an investor in the access control of a single Midas gateway
+ */
+export declare function greenlistMidasGateway(props: GreenlistMidasGatewayProps): Promise<void>;
+export interface RegisterRWAInvestorProps {
+    anvil: AnvilClient;
+    /**
+     * Attached SDK, markets and RWA factories are read from it
+     */
+    sdk: OnchainSDK;
+    /**
+     * Wallet to pass the KYC of every RWA token
+     */
+    investor: Address;
+    /**
+     * Securitize registry admin, DSTokens are skipped when omitted
+     */
+    adminPrivateKey?: Hex;
+    /**
+     * Midas access control admin, Midas gateways are skipped when omitted
+     */
+    midasAdmin?: Address;
+    logger?: ILogger;
+}
+export interface RWAKycFailure {
+    /**
+     * DSToken or Midas gateway that failed
+     */
+    target: Address;
+    error: unknown;
+}
+export interface RegisterRWAInvestorResult {
+    /**
+     * DSTokens the investor was registered in
+     */
+    securitizeTokens: Address[];
+    /**
+     * Midas gateways the investor was greenlisted in
+     */
+    midasGateways: Address[];
+    failed: RWAKycFailure[];
+}
+/**
+ * Registers a wallet as an investor (fake KYC) in every Securitize DSToken and
+ * every Midas gateway of the markets loaded by `sdk`.
+ *
+ * Failures of a single token or gateway are collected and reported in the
+ * result instead of aborting the whole run.
+ */
+export declare function registerRWAInvestor(props: RegisterRWAInvestorProps): Promise<RegisterRWAInvestorResult>;

package/dist/types/dev/providers.d.ts

@@ -3,9 +3,9 @@ import { type NetworkType } from "../sdk/index.js";
 export declare const SUPPORTED_RPC_PROVIDERS: readonly ["alchemy", "drpc", "thirdweb", "ankr"];
 export declare const rpcProvidersSchema: z.ZodEnum<{
     alchemy: "alchemy";
+    ankr: "ankr";
     drpc: "drpc";
     thirdweb: "thirdweb";
-    ankr: "ankr";
 }>;
 export type RpcProvider = z.infer<typeof rpcProvidersSchema>;
 export declare function getRpcProviderUrl(provider: RpcProvider, network: NetworkType, apiKey?: string, protocol?: "http" | "ws"): string | undefined;