@gearbox-protocol/sdk 14.12.0-next.9 → 14.12.0-test.1

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

@@ -0,0 +1,614 @@
+import { type Address, type DecodeFunctionDataReturnType, type Hex } from "viem";
+import { type AssetsMap, type OnchainSDK } from "../../../sdk/index.js";
+import type { DelayedWithdrawalClaim, DelayedWithdrawalRequest } from "../types.js";
+import type { ConcreteAdapterContractOptions } from "./AbstractAdapter.js";
+import { AbstractAdapterContract } from "./AbstractAdapter.js";
+declare const abi: readonly [{
+    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: "creditManager";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    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: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "depositInstantDiff";
+    readonly inputs: readonly [{
+        readonly name: "leftoverAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "rateMinRAY";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "depositPhantomToken";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "gateway";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    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: "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 name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemInstantDiff";
+    readonly inputs: readonly [{
+        readonly name: "leftoverAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "rateMinRAY";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemRequest";
+    readonly inputs: readonly [{
+        readonly name: "amountMTokenIn";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemRequest";
+    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 name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemRequestDiff";
+    readonly inputs: readonly [{
+        readonly name: "leftoverAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "redeemRequestDiff";
+    readonly inputs: readonly [{
+        readonly name: "leftoverAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "extraData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "referrerId";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    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: "targetContract";
+    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 name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    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 name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    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 name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "withdrawPhantomToken";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "amount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "useSafePrices";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "error";
+    readonly name: "IncorrectStakedPhantomTokenException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "PhantomTokenNotSetException";
+    readonly inputs: readonly [];
+}];
+type abi = typeof abi;
+declare const protocolAbi: 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: "mToken";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    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: "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 [];
+}];
+type protocolAbi = typeof protocolAbi;
+export declare class MidasGatewayAdapterContract extends AbstractAdapterContract<abi, protocolAbi> {
+    #private;
+    constructor(sdk: OnchainSDK, args: ConcreteAdapterContractOptions);
+    get gateway(): Address;
+    get mToken(): Address;
+    get quoteToken(): Address;
+    /**
+     * Redemption phantom token; `zeroAddress` when the gateway was deployed
+     * without delayed withdrawals
+     */
+    get phantomToken(): Address;
+    get referrerId(): string;
+    stateHuman(raw?: boolean): {
+        address: string;
+        version: number;
+        contractType?: string;
+        creditManager?: string;
+        targetContract?: string;
+        gateway: string | undefined;
+        mToken: string | undefined;
+        quoteToken: string | undefined;
+        phantomToken: string | undefined;
+        referrerId: string | undefined;
+    };
+    /**
+     * `redeemRequest` (the only request call the withdrawal compressor emits)
+     * spends the mToken and mints the redemption phantom token; the quote token
+     * is received when the redemption is claimed. The 2-arg overload carries
+     * the intent `extraData`.
+     */
+    parseDelayedWithdrawalRequest(calldata: Hex): DelayedWithdrawalRequest | undefined;
+    /**
+     * `withdrawFromRedeemer(address redeemer, uint256 amount)` claims a matured
+     * redemption from a redeemer contract.
+     */
+    parseDelayedWithdrawalClaim(calldata: Hex): DelayedWithdrawalClaim | undefined;
+    protected applyBalanceChanges(balances: AssetsMap, decoded: DecodeFunctionDataReturnType<abi>): Promise<void>;
+}
+export {};

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

@@ -1,6 +1,5 @@
 import { type Address, type DecodeFunctionDataReturnType } from "viem";
-import { type AddressMap, type ConstructOptions } from "../../../sdk/index.js";
-import type { DiffLeftover } from "../types.js";
+import { type AssetsMap, type OnchainSDK } from "../../../sdk/index.js";
 import type { ConcreteAdapterContractOptions } from "./AbstractAdapter.js";
 import { AbstractAdapterContract } from "./AbstractAdapter.js";
 declare const abi: readonly [{
@@ -220,20 +219,20 @@ declare const protocolAbi: readonly [{
 type protocolAbi = typeof protocolAbi;
 export declare class MidasIssuanceVaultAdapterContract extends AbstractAdapterContract<abi, protocolAbi> {
     #private;
-    constructor(options: ConstructOptions, args: ConcreteAdapterContractOptions);
+    constructor(sdk: OnchainSDK, args: ConcreteAdapterContractOptions);
     get mToken(): Address;
     get referrerId(): string;
     get allowedTokens(): Address[];
     stateHuman(raw?: boolean): {
-        mToken: string | undefined;
-        referrerId: string | undefined;
-        allowedTokens: string[] | undefined;
-        creditManager?: string;
-        targetContract?: string;
         address: string;
         version: number;
         contractType?: string;
+        creditManager?: string;
+        targetContract?: string;
+        mToken: string | undefined;
+        referrerId: string | undefined;
+        allowedTokens: string[] | undefined;
     };
-    protected decodeDiffLeftovers(decoded: DecodeFunctionDataReturnType<abi>, balances: AddressMap<bigint>): DiffLeftover[];
+    protected applyBalanceChanges(balances: AssetsMap, decoded: DecodeFunctionDataReturnType<abi>): Promise<void>;
 }
 export {};

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

@@ -1,6 +1,5 @@
 import { type Address, type DecodeFunctionDataReturnType } from "viem";
-import { type AddressMap, type ConstructOptions } from "../../../sdk/index.js";
-import type { DiffLeftover } from "../types.js";
+import { type AssetsMap, type OnchainSDK } from "../../../sdk/index.js";
 import type { ConcreteAdapterContractOptions } from "./AbstractAdapter.js";
 import { AbstractAdapterContract } from "./AbstractAdapter.js";
 declare const abi: readonly [{
@@ -460,7 +459,7 @@ declare const protocolAbi: readonly [{
 type protocolAbi = typeof protocolAbi;
 export declare class MidasRedemptionVaultAdapterContract extends AbstractAdapterContract<abi, protocolAbi> {
     #private;
-    constructor(options: ConstructOptions, args: ConcreteAdapterContractOptions);
+    constructor(sdk: OnchainSDK, args: ConcreteAdapterContractOptions);
     get gateway(): Address;
     get mToken(): Address;
     get allowedTokens(): {
@@ -468,18 +467,18 @@ export declare class MidasRedemptionVaultAdapterContract extends AbstractAdapter
         phantomToken: Address;
     }[];
     stateHuman(raw?: boolean): {
+        address: string;
+        version: number;
+        contractType?: string;
+        creditManager?: string;
+        targetContract?: string;
         gateway: string | undefined;
         mToken: string | undefined;
         allowedTokens: {
             token: string;
             phantomToken: string;
         }[] | undefined;
-        creditManager?: string;
-        targetContract?: string;
-        address: string;
-        version: number;
-        contractType?: string;
     };
-    protected decodeDiffLeftovers(decoded: DecodeFunctionDataReturnType<abi>, balances: AddressMap<bigint>): DiffLeftover[];
+    protected applyBalanceChanges(balances: AssetsMap, decoded: DecodeFunctionDataReturnType<abi>): Promise<void>;
 }
 export {};