@cryptoalgebra/alm-sdk
Version:
Algebra ALM SDK
202 lines (201 loc) • 15.3 kB
TypeScript
import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PayableOverrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result, EventFragment } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common";
export interface AlgebraVaultDepositGuardInterface extends utils.Interface {
functions: {
"AlgebraVaultFactory()": FunctionFragment;
"WRAPPED_NATIVE()": FunctionFragment;
"forwardDepositToAlgebraVault(address,address,address,uint256,uint256,address)": FunctionFragment;
"forwardNativeDepositToAlgebraVault(address,address,uint256,address)": FunctionFragment;
"forwardNativeWithdrawFromAlgebraVault(address,address,uint256,address,uint256,uint256)": FunctionFragment;
"forwardWithdrawFromAlgebraVault(address,address,uint256,address,uint256,uint256)": FunctionFragment;
"vaultKey(address,address,address,bool,bool)": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "AlgebraVaultFactory" | "WRAPPED_NATIVE" | "forwardDepositToAlgebraVault" | "forwardNativeDepositToAlgebraVault" | "forwardNativeWithdrawFromAlgebraVault" | "forwardWithdrawFromAlgebraVault" | "vaultKey"): FunctionFragment;
encodeFunctionData(functionFragment: "AlgebraVaultFactory", values?: undefined): string;
encodeFunctionData(functionFragment: "WRAPPED_NATIVE", values?: undefined): string;
encodeFunctionData(functionFragment: "forwardDepositToAlgebraVault", values: [
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<string>
]): string;
encodeFunctionData(functionFragment: "forwardNativeDepositToAlgebraVault", values: [
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<string>
]): string;
encodeFunctionData(functionFragment: "forwardNativeWithdrawFromAlgebraVault", values: [
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<BigNumberish>
]): string;
encodeFunctionData(functionFragment: "forwardWithdrawFromAlgebraVault", values: [
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<string>,
PromiseOrValue<BigNumberish>,
PromiseOrValue<BigNumberish>
]): string;
encodeFunctionData(functionFragment: "vaultKey", values: [
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<string>,
PromiseOrValue<boolean>,
PromiseOrValue<boolean>
]): string;
decodeFunctionResult(functionFragment: "AlgebraVaultFactory", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "WRAPPED_NATIVE", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "forwardDepositToAlgebraVault", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "forwardNativeDepositToAlgebraVault", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "forwardNativeWithdrawFromAlgebraVault", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "forwardWithdrawFromAlgebraVault", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "vaultKey", data: BytesLike): Result;
events: {
"Deployed(address,address)": EventFragment;
"DepositForwarded(address,address,address,uint256,uint256,address)": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "Deployed"): EventFragment;
getEvent(nameOrSignatureOrTopic: "DepositForwarded"): EventFragment;
}
export interface DeployedEventObject {
_AlgebraVaultFactory: string;
_WETH: string;
}
export type DeployedEvent = TypedEvent<[string, string], DeployedEventObject>;
export type DeployedEventFilter = TypedEventFilter<DeployedEvent>;
export interface DepositForwardedEventObject {
sender: string;
vault: string;
token: string;
amount: BigNumber;
shares: BigNumber;
to: string;
}
export type DepositForwardedEvent = TypedEvent<[
string,
string,
string,
BigNumber,
BigNumber,
string
], DepositForwardedEventObject>;
export type DepositForwardedEventFilter = TypedEventFilter<DepositForwardedEvent>;
export interface AlgebraVaultDepositGuard extends BaseContract {
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: AlgebraVaultDepositGuardInterface;
queryFilter<TEvent extends TypedEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>;
listeners<TEvent extends TypedEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>;
listeners(eventName?: string): Array<Listener>;
removeAllListeners<TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>): this;
removeAllListeners(eventName?: string): this;
off: OnEvent<this>;
on: OnEvent<this>;
once: OnEvent<this>;
removeListener: OnEvent<this>;
functions: {
AlgebraVaultFactory(overrides?: CallOverrides): Promise<[string]>;
WRAPPED_NATIVE(overrides?: CallOverrides): Promise<[string]>;
forwardDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, token: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
forwardNativeDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
forwardNativeWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
forwardWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
vaultKey(vaultDeployer: PromiseOrValue<string>, token0: PromiseOrValue<string>, token1: PromiseOrValue<string>, allowToken0: PromiseOrValue<boolean>, allowToken1: PromiseOrValue<boolean>, overrides?: CallOverrides): Promise<[string] & {
key: string;
}>;
};
AlgebraVaultFactory(overrides?: CallOverrides): Promise<string>;
WRAPPED_NATIVE(overrides?: CallOverrides): Promise<string>;
forwardDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, token: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
forwardNativeDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
forwardNativeWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
forwardWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
vaultKey(vaultDeployer: PromiseOrValue<string>, token0: PromiseOrValue<string>, token1: PromiseOrValue<string>, allowToken0: PromiseOrValue<boolean>, allowToken1: PromiseOrValue<boolean>, overrides?: CallOverrides): Promise<string>;
callStatic: {
AlgebraVaultFactory(overrides?: CallOverrides): Promise<string>;
WRAPPED_NATIVE(overrides?: CallOverrides): Promise<string>;
forwardDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, token: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
forwardNativeDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
forwardNativeWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
BigNumber,
BigNumber
] & {
amount0: BigNumber;
amount1: BigNumber;
}>;
forwardWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
BigNumber,
BigNumber
] & {
amount0: BigNumber;
amount1: BigNumber;
}>;
vaultKey(vaultDeployer: PromiseOrValue<string>, token0: PromiseOrValue<string>, token1: PromiseOrValue<string>, allowToken0: PromiseOrValue<boolean>, allowToken1: PromiseOrValue<boolean>, overrides?: CallOverrides): Promise<string>;
};
filters: {
"Deployed(address,address)"(_AlgebraVaultFactory?: null, _WETH?: null): DeployedEventFilter;
Deployed(_AlgebraVaultFactory?: null, _WETH?: null): DeployedEventFilter;
"DepositForwarded(address,address,address,uint256,uint256,address)"(sender?: PromiseOrValue<string> | null, vault?: PromiseOrValue<string> | null, token?: PromiseOrValue<string> | null, amount?: null, shares?: null, to?: null): DepositForwardedEventFilter;
DepositForwarded(sender?: PromiseOrValue<string> | null, vault?: PromiseOrValue<string> | null, token?: PromiseOrValue<string> | null, amount?: null, shares?: null, to?: null): DepositForwardedEventFilter;
};
estimateGas: {
AlgebraVaultFactory(overrides?: CallOverrides): Promise<BigNumber>;
WRAPPED_NATIVE(overrides?: CallOverrides): Promise<BigNumber>;
forwardDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, token: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
forwardNativeDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
forwardNativeWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
forwardWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
vaultKey(vaultDeployer: PromiseOrValue<string>, token0: PromiseOrValue<string>, token1: PromiseOrValue<string>, allowToken0: PromiseOrValue<boolean>, allowToken1: PromiseOrValue<boolean>, overrides?: CallOverrides): Promise<BigNumber>;
};
populateTransaction: {
AlgebraVaultFactory(overrides?: CallOverrides): Promise<PopulatedTransaction>;
WRAPPED_NATIVE(overrides?: CallOverrides): Promise<PopulatedTransaction>;
forwardDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, token: PromiseOrValue<string>, amount: PromiseOrValue<BigNumberish>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
forwardNativeDepositToAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, minimumProceeds: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: PayableOverrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
forwardNativeWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
forwardWithdrawFromAlgebraVault(vault: PromiseOrValue<string>, vaultDeployer: PromiseOrValue<string>, shares: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, minAmount0: PromiseOrValue<BigNumberish>, minAmount1: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
vaultKey(vaultDeployer: PromiseOrValue<string>, token0: PromiseOrValue<string>, token1: PromiseOrValue<string>, allowToken0: PromiseOrValue<boolean>, allowToken1: PromiseOrValue<boolean>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
};
}