@gearbox-protocol/sdk 14.12.0-next.3 → 14.12.0-next.31

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

@@ -0,0 +1,797 @@
+import { type Address, type DecodeFunctionDataReturnType, type Hex } from "viem";
+import { type AssetsMap, type OnchainSDK } from "../../../sdk/index.js";
+import type { DelayedWithdrawalRequest } from "../types.js";
+import type { ConcreteAdapterContractOptions } from "./AbstractAdapter.js";
+import { AbstractAdapterContract } from "./AbstractAdapter.js";
+declare const abi: readonly [{
+    readonly type: "function";
+    readonly name: "allowedInputTokens";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "allowedOutputTokens";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "allowedPhantomTokens";
+    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: "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: "tokenIn";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "tokenIn";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "isInputTokenAllowed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        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: "isOutputTokenAllowed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        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: "outputTokenToPhantomToken";
+    readonly inputs: readonly [{
+        readonly name: "outputToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "phantomTokenToOutputToken";
+    readonly inputs: readonly [{
+        readonly name: "phantomToken";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    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: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "redeemRequest";
+    readonly inputs: readonly [{
+        readonly name: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "redeemRequestDiff";
+    readonly inputs: readonly [{
+        readonly name: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "setInputTokenAllowedStatusBatch";
+    readonly inputs: readonly [{
+        readonly name: "tokens";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "allowed";
+        readonly type: "bool[]";
+        readonly internalType: "bool[]";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "setOutputTokenAllowedStatusBatch";
+    readonly inputs: readonly [{
+        readonly name: "configs";
+        readonly type: "tuple[]";
+        readonly internalType: "struct IMidasGatewayAdapter.MidasAllowedTokenStatus[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "phantomToken";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "allowed";
+            readonly type: "bool";
+            readonly internalType: "bool";
+        }];
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    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: "tokenOut";
+        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: "withdrawFromRedeemer";
+    readonly inputs: readonly [{
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "tokenOut";
+        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: "event";
+    readonly name: "SetInputTokenAllowedStatus";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "allowed";
+        readonly type: "bool";
+        readonly indexed: false;
+        readonly internalType: "bool";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetOutputTokenAllowedStatus";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "phantomToken";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "allowed";
+        readonly type: "bool";
+        readonly indexed: false;
+        readonly internalType: "bool";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "IncorrectArrayLengthException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "IncorrectStakedPhantomTokenException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "PhantomTokenTokenOutMismatchException";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "TokenNotAllowedException";
+    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: "tokenIn";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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 name: "tokenOut";
+        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: "redeemInstant";
+    readonly inputs: readonly [{
+        readonly name: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "tokenOut";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        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: "tokenOut";
+        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: "withdrawFromRedeemer";
+    readonly inputs: readonly [{
+        readonly name: "redeemer";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "tokenOut";
+        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: "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 referrerId(): string;
+    get allowedInputTokens(): Address[];
+    get allowedOutputTokens(): {
+        token: Address;
+        phantomToken: Address;
+    }[];
+    stateHuman(raw?: boolean): {
+        address: string;
+        version: number;
+        contractType?: string;
+        creditManager?: string;
+        targetContract?: string;
+        gateway: string | undefined;
+        mToken: string | undefined;
+        referrerId: string | undefined;
+        allowedInputTokens: string[] | undefined;
+        allowedOutputTokens: {
+            token: string;
+            phantomToken: string;
+        }[] | undefined;
+    };
+    /**
+     * `redeemRequest` (the only request call the withdrawal compressor emits)
+     * spends the mToken and mints the phantom token of the requested
+     * `tokenOut`, which is received when the redemption is claimed. The 3-arg
+     * overload carries the intent `extraData`.
+     */
+    parseDelayedWithdrawalRequest(calldata: Hex): DelayedWithdrawalRequest | undefined;
+    protected applyBalanceChanges(balances: AssetsMap, decoded: DecodeFunctionDataReturnType<abi>): Promise<void>;
+}
+export {};