@gearbox-protocol/sdk 15.0.0-next.3 → 15.0.0-pyth.1

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

@@ -37,3 +37,182 @@ export declare const iDegenNftv2Abi: readonly [{
     }];
     readonly outputs: readonly [];
 }];
+export declare const faucetAbi: readonly [{
+    readonly type: "function";
+    readonly name: "assets";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "claim";
+    readonly inputs: readonly [{
+        readonly name: "amountUSD";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "claim";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "claim";
+    readonly inputs: readonly [{
+        readonly name: "claims";
+        readonly type: "tuple[]";
+        readonly internalType: "struct TokenClaim[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "amount";
+            readonly type: "uint256";
+            readonly internalType: "uint256";
+        }];
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getAssets";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "hasClaimed";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        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: "minAmountUSD";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "owner";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "prices";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "scales";
+    readonly inputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}];
+/**
+ * This contract is deployed on testnets and contains testnet executionId and forkAlias
+ */
+export declare const iOnchainExecutionIdAbi: readonly [{
+    readonly type: "function";
+    readonly name: "deployer";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "executionId";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "forkAlias";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "info";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "tuple";
+        readonly internalType: "struct ExecutionId.Info";
+        readonly components: readonly [{
+            readonly name: "deployer";
+            readonly type: "string";
+            readonly internalType: "string";
+        }, {
+            readonly name: "executionId";
+            readonly type: "string";
+            readonly internalType: "string";
+        }, {
+            readonly name: "forkAlias";
+            readonly type: "string";
+            readonly internalType: "string";
+        }];
+    }];
+    readonly stateMutability: "view";
+}];

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

@@ -0,0 +1,34 @@
+import { type Address, type Hex } from "viem";
+import { type ILogger } from "../sdk/index.js";
+import type { AnvilClient } from "./createAnvilClient.js";
+interface ClaimDSTokenProps {
+    anvil: AnvilClient;
+    claimer: Address;
+    adminPrivateKey: Hex;
+    /**
+     * DSToken addresses
+     */
+    token: Address;
+    /**
+     * USD amount without decimals
+     */
+    usdAmount?: string;
+    marketConfigurators?: Address[];
+    rwaFactories?: Address[];
+    logger?: ILogger;
+}
+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
+ * @returns
+ */
+export declare function claimDSTokens(props: ClaimDSTokensProps): Promise<void>;
+export {};

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

@@ -1,4 +1,4 @@
-import { type Account, type Address, type PublicClient, type WalletClient } from "viem";
+import type { Account, Address, PublicClient, WalletClient } from "viem";
 import { type ILogger, type OnchainSDK } from "../sdk/index.js";
 interface TokenClaim {
     token: Address;
@@ -21,6 +21,7 @@ interface ClaimFromFaucetOptions {
     amount?: TokenClaim[] | bigint | ((minAmountUSD: bigint) => bigint);
     gasMultiplier?: bigint;
     logger?: ILogger;
+    sync?: boolean;
 }
 export declare function claimFromFaucet(opts: ClaimFromFaucetOptions): Promise<void>;
 export {};

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

@@ -1,4 +1,4 @@
-import type { Block, Chain, Client, Hex, Prettify, PublicClient, TestActions, TestRpcSchema, Transport, WalletClient } from "viem";
+import type { Account, Address, Block, Chain, Client, Hex, Prettify, PublicClient, TestActions, TestRpcSchema, Transport, WalletClient } from "viem";
 export interface AnvilNodeInfo {
     currentBlockNumber: string;
     currentBlockTimestamp: number;
@@ -30,6 +30,20 @@ export type AnvilRPCSchema = [
         ReturnType: Block<Hex>[];
     }
 ];
+export interface AnvilDealParameters {
+    /**
+     * ERC20 token address.
+     */
+    erc20: Address;
+    /**
+     * Account that should receive the tokens.
+     */
+    account: Account | Address;
+    /**
+     * Token amount in raw units (no decimals applied).
+     */
+    amount: bigint;
+}
 export type AnvilActions = {
     anvilNodeInfo: () => Promise<AnvilNodeInfo>;
     isAnvil: () => Promise<boolean>;
@@ -38,6 +52,11 @@ export type AnvilActions = {
      * Block timestamp in seconds
      */
     timestamp: bigint | number) => Promise<Block<Hex> | undefined>;
+    /**
+     * Deals ERC20 tokens to an account by overriding the storage of
+     * `balanceOf(account)`. Requires `viem-deal` as a peer dependency.
+     */
+    deal: (params: AnvilDealParameters) => Promise<void>;
 };
 export type AnvilClient = Prettify<{
     mode: "anvil";
@@ -48,6 +67,14 @@ export interface AnvilClientConfig<transport extends Transport = Transport, chai
     cacheTime?: number;
     pollingInterval?: number;
 }
+/**
+ * Extends an arbitrary viem `PublicClient` with anvil + wallet actions plus
+ * the SDK's bonus actions (`anvilNodeInfo`, `isAnvil`, `evmMineDetailed`,
+ * `deal`).
+ *
+ * Used to lift `sdk.client` into an `AnvilClient` shape on the fly when test
+ * RPCs (impersonateAccount, setBalance, setStorageAt, ...) are needed.
+ */
 export declare function extendAnvilClient(client: PublicClient): AnvilClient;
 export declare function createAnvilClient({ chain, transport, cacheTime, pollingInterval, }: AnvilClientConfig): AnvilClient;
 /**

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

@@ -1,5 +1,7 @@
 export * from "./AccountOpener.js";
+export * from "./abi.js";
 export * from "./calcLiquidatableLTs.js";
+export * from "./claimDSToken.js";
 export * from "./claimFromFaucet.js";
 export * from "./create2.js";
 export * from "./createAnvilClient.js";

package/dist/types/history/assembleOperations.d.ts

@@ -1,5 +1,6 @@
 import type { Address } from "viem";
 import type { AddressMap, ChainContractsRegister } from "../sdk/index.js";
+import type { WithdrawCollateralEventInfo } from "./extractTransfers.js";
 import type { ExecuteResult, FacadeParsedCall } from "./internal-types.js";
 import type { FacadeOperationMetadata, OuterFacadeOperation } from "./types.js";
 export interface AssembleOperationsInput {
@@ -9,6 +10,7 @@ export interface AssembleOperationsInput {
     underlying: Address;
     liquidationRemainingFunds?: bigint;
     phantomTokens?: AddressMap<Address>;
+    withdrawCollateralEvents?: WithdrawCollateralEventInfo[];
     strict?: boolean;
 }
 /**

package/dist/types/history/classifyMulticallOperations.d.ts

@@ -1,5 +1,6 @@
 import { type Address, type Hex } from "viem";
 import type { AddressMap, ChainContractsRegister, ParsedCallV2 } from "../sdk/index.js";
+import type { WithdrawCollateralEventInfo } from "./extractTransfers.js";
 import type { InnerOperation } from "./inner-operations.js";
 import type { ExecuteResult } from "./internal-types.js";
 export interface ClassifyMulticallOperationsInput {
@@ -11,6 +12,7 @@ export interface ClassifyMulticallOperationsInput {
     underlying: Address;
     strict?: boolean;
     phantomTokens?: AddressMap<Address>;
+    withdrawCollateralEvents?: WithdrawCollateralEventInfo[];
 }
 /**
  * Classifies each multicall inner call into a {@link InnerOperation}:

package/dist/types/history/errors.d.ts

@@ -6,6 +6,9 @@ export declare class UnknownAdapterError extends Error {
 export declare class TransferAlignmentError extends Error {
     constructor(expected: number, actual: number);
 }
+export declare class WithdrawCollateralAlignmentError extends Error {
+    constructor(expected: number, actual: number);
+}
 export declare class ProtocolCallNotFoundError extends Error {
     readonly targetContract: Address;
     readonly executeIndex: number;

package/dist/types/history/extractTransfers.d.ts

@@ -3,9 +3,23 @@ import { AddressMap } from "../sdk/index.js";
 import type { ExecuteResult } from "./internal-types.js";
 import type { DirectTransferInfo } from "./types.js";
 type RawLog = Log<bigint | number, number, false>;
+/**
+ * Effective `withdrawCollateral` outcome decoded from the facade's
+ * `WithdrawCollateral` event.
+ */
+export interface WithdrawCollateralEventInfo {
+    /**
+     * For regular withdrawals: the calldata token.
+     * For phantom withdrawals: the deposited (resolved) token.
+     */
+    token: Address;
+    amount: bigint;
+    to: Address;
+}
 /**
  * Extracts per-adapter-call token balance changes and detects direct
- * incoming transfers to the credit account.
+ * transfers into and out of the credit account (deposits and withdrawals
+ * performed independently of the facade).
  *
  * @param logs - raw viem Log[] from transaction receipt, sorted by logIndex
  * @param facadeAddress - the credit facade address (sole boundary event source)
@@ -17,6 +31,12 @@ export interface ExtractTransfersResult {
     liquidationRemainingFunds?: bigint;
     /** Maps phantom token address to its deposited (underlying) token address. */
     phantomTokens: AddressMap<Address>;
+    /**
+     * One entry per facade `WithdrawCollateral` event targeting `creditAccount`,
+     * in transaction order. Used to recover the effective amount when the
+     * calldata uses the `type(uint256).max` "withdraw all" sentinel.
+     */
+    withdrawCollateralEvents: WithdrawCollateralEventInfo[];
 }
 export declare function extractTransfers(logs: RawLog[], creditAccount: Address, pool: Address, creditFacade: Address): ExtractTransfersResult;
 export {};

package/dist/types/history/types.d.ts

@@ -1,12 +1,17 @@
 import type { Address, Hex } from "viem";
 import type { InnerOperation } from "./inner-operations.js";
 /**
- * An ERC-20 Transfer to the credit account that was not part of any
- * facade operation (multicall, liquidation, etc.).
+ * An ERC-20 Transfer into or out of the credit account that was not part of
+ * any facade operation (multicall, liquidation, etc.).
+ *
+ * `from`/`to` are the raw transfer endpoints: an inbound transfer (manual
+ * top-up / deposit) has `to` == the credit account, an outbound transfer
+ * (direct withdrawal) has `from` == the credit account.
  */
 export interface DirectTransferInfo {
     token: Address;
     from: Address;
+    to: Address;
     amount: bigint;
 }
 export interface OperationMetadata {
@@ -56,6 +61,7 @@ export interface DirectTokenTransferOperation extends OperationMetadata {
     protocol: Address;
     token: Address;
     from: Address;
+    to: Address;
     creditAccount: Address;
     amount: bigint;
 }