@orionprotocol/contracts/lib/ethers-v5/PoolFunctionality.d.ts

Orion Protocol contracts typings

import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, 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 declare namespace IPoolFunctionality {
    type SwapDataStruct = {
        amount_spend: PromiseOrValue<BigNumberish>;
        amount_receive: PromiseOrValue<BigNumberish>;
        orionpool_router: PromiseOrValue<string>;
        is_exact_spend: PromiseOrValue<boolean>;
        supportingFee: PromiseOrValue<boolean>;
        isInContractTrade: PromiseOrValue<boolean>;
        isSentETHEnough: PromiseOrValue<boolean>;
        isFromWallet: PromiseOrValue<boolean>;
        asset_spend: PromiseOrValue<string>;
        path: PromiseOrValue<string>[];
    };
    type SwapDataStructOutput = [
        BigNumber,
        BigNumber,
        string,
        boolean,
        boolean,
        boolean,
        boolean,
        boolean,
        string,
        string[]
    ] & {
        amount_spend: BigNumber;
        amount_receive: BigNumber;
        orionpool_router: string;
        is_exact_spend: boolean;
        supportingFee: boolean;
        isInContractTrade: boolean;
        isSentETHEnough: boolean;
        isFromWallet: boolean;
        asset_spend: string;
        path: string[];
    };
}
export interface PoolFunctionalityInterface extends utils.Interface {
    functions: {
        "WETH()": FunctionFragment;
        "addLiquidityFromExchange(address,address,uint256,uint256,uint256,uint256,address)": FunctionFragment;
        "doSwapThroughOrionPool(address,address,(uint112,uint112,address,bool,bool,bool,bool,bool,address,address[]))": FunctionFragment;
        "factories(uint256)": FunctionFragment;
        "factory()": FunctionFragment;
        "getFactoriesLength()": FunctionFragment;
        "getWETH()": FunctionFragment;
        "increaseAllowances(address[],address[],uint256[])": FunctionFragment;
        "isFactory(address)": FunctionFragment;
        "owner()": FunctionFragment;
        "pairFor(address,address,address)": FunctionFragment;
        "renounceOwnership()": FunctionFragment;
        "supportedFactories(address)": FunctionFragment;
        "transferOwnership(address)": FunctionFragment;
        "updateFactories(address[],uint8[])": FunctionFragment;
    };
    getFunction(nameOrSignatureOrTopic: "WETH" | "addLiquidityFromExchange" | "doSwapThroughOrionPool" | "factories" | "factory" | "getFactoriesLength" | "getWETH" | "increaseAllowances" | "isFactory" | "owner" | "pairFor" | "renounceOwnership" | "supportedFactories" | "transferOwnership" | "updateFactories"): FunctionFragment;
    encodeFunctionData(functionFragment: "WETH", values?: undefined): string;
    encodeFunctionData(functionFragment: "addLiquidityFromExchange", values: [
        PromiseOrValue<string>,
        PromiseOrValue<string>,
        PromiseOrValue<BigNumberish>,
        PromiseOrValue<BigNumberish>,
        PromiseOrValue<BigNumberish>,
        PromiseOrValue<BigNumberish>,
        PromiseOrValue<string>
    ]): string;
    encodeFunctionData(functionFragment: "doSwapThroughOrionPool", values: [
        PromiseOrValue<string>,
        PromiseOrValue<string>,
        IPoolFunctionality.SwapDataStruct
    ]): string;
    encodeFunctionData(functionFragment: "factories", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "factory", values?: undefined): string;
    encodeFunctionData(functionFragment: "getFactoriesLength", values?: undefined): string;
    encodeFunctionData(functionFragment: "getWETH", values?: undefined): string;
    encodeFunctionData(functionFragment: "increaseAllowances", values: [
        PromiseOrValue<string>[],
        PromiseOrValue<string>[],
        PromiseOrValue<BigNumberish>[]
    ]): string;
    encodeFunctionData(functionFragment: "isFactory", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "owner", values?: undefined): string;
    encodeFunctionData(functionFragment: "pairFor", values: [
        PromiseOrValue<string>,
        PromiseOrValue<string>,
        PromiseOrValue<string>
    ]): string;
    encodeFunctionData(functionFragment: "renounceOwnership", values?: undefined): string;
    encodeFunctionData(functionFragment: "supportedFactories", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "transferOwnership", values: [PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "updateFactories", values: [PromiseOrValue<string>[], PromiseOrValue<BigNumberish>[]]): string;
    decodeFunctionResult(functionFragment: "WETH", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "addLiquidityFromExchange", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "doSwapThroughOrionPool", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "factories", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "factory", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getFactoriesLength", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getWETH", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "increaseAllowances", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "isFactory", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "pairFor", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "renounceOwnership", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "supportedFactories", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "transferOwnership", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "updateFactories", data: BytesLike): Result;
    events: {
        "OrionPoolSwap(address,address,address,uint256,uint256,uint256,uint256,address)": EventFragment;
        "OwnershipTransferred(address,address)": EventFragment;
    };
    getEvent(nameOrSignatureOrTopic: "OrionPoolSwap"): EventFragment;
    getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
}
export interface OrionPoolSwapEventObject {
    sender: string;
    st: string;
    rt: string;
    st_r: BigNumber;
    st_a: BigNumber;
    rt_r: BigNumber;
    rt_a: BigNumber;
    f: string;
}
export type OrionPoolSwapEvent = TypedEvent<[
    string,
    string,
    string,
    BigNumber,
    BigNumber,
    BigNumber,
    BigNumber,
    string
], OrionPoolSwapEventObject>;
export type OrionPoolSwapEventFilter = TypedEventFilter<OrionPoolSwapEvent>;
export interface OwnershipTransferredEventObject {
    previousOwner: string;
    newOwner: string;
}
export type OwnershipTransferredEvent = TypedEvent<[
    string,
    string
], OwnershipTransferredEventObject>;
export type OwnershipTransferredEventFilter = TypedEventFilter<OwnershipTransferredEvent>;
export interface PoolFunctionality extends BaseContract {
    connect(signerOrProvider: Signer | Provider | string): this;
    attach(addressOrName: string): this;
    deployed(): Promise<this>;
    interface: PoolFunctionalityInterface;
    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: {
        WETH(overrides?: CallOverrides): Promise<[string]>;
        addLiquidityFromExchange(tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, amountADesired: PromiseOrValue<BigNumberish>, amountBDesired: PromiseOrValue<BigNumberish>, amountAMin: PromiseOrValue<BigNumberish>, amountBMin: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        doSwapThroughOrionPool(user: PromiseOrValue<string>, to: PromiseOrValue<string>, swapData: IPoolFunctionality.SwapDataStruct, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        factories(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[string]>;
        factory(overrides?: CallOverrides): Promise<[string]>;
        getFactoriesLength(overrides?: CallOverrides): Promise<[BigNumber]>;
        getWETH(overrides?: CallOverrides): Promise<[string]>;
        increaseAllowances(tokens: PromiseOrValue<string>[], tos: PromiseOrValue<string>[], amounts: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        isFactory(a: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[boolean]>;
        owner(overrides?: CallOverrides): Promise<[string]>;
        pairFor(curFactory: PromiseOrValue<string>, tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[string] & {
            pair: string;
        }>;
        renounceOwnership(overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        supportedFactories(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[number]>;
        transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        updateFactories(_factories: PromiseOrValue<string>[], _types: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
    };
    WETH(overrides?: CallOverrides): Promise<string>;
    addLiquidityFromExchange(tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, amountADesired: PromiseOrValue<BigNumberish>, amountBDesired: PromiseOrValue<BigNumberish>, amountAMin: PromiseOrValue<BigNumberish>, amountBMin: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    doSwapThroughOrionPool(user: PromiseOrValue<string>, to: PromiseOrValue<string>, swapData: IPoolFunctionality.SwapDataStruct, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    factories(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
    factory(overrides?: CallOverrides): Promise<string>;
    getFactoriesLength(overrides?: CallOverrides): Promise<BigNumber>;
    getWETH(overrides?: CallOverrides): Promise<string>;
    increaseAllowances(tokens: PromiseOrValue<string>[], tos: PromiseOrValue<string>[], amounts: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    isFactory(a: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
    owner(overrides?: CallOverrides): Promise<string>;
    pairFor(curFactory: PromiseOrValue<string>, tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>;
    renounceOwnership(overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    supportedFactories(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<number>;
    transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    updateFactories(_factories: PromiseOrValue<string>[], _types: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    callStatic: {
        WETH(overrides?: CallOverrides): Promise<string>;
        addLiquidityFromExchange(tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, amountADesired: PromiseOrValue<BigNumberish>, amountBDesired: PromiseOrValue<BigNumberish>, amountAMin: PromiseOrValue<BigNumberish>, amountBMin: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[
            BigNumber,
            BigNumber,
            BigNumber
        ] & {
            amountA: BigNumber;
            amountB: BigNumber;
            liquidity: BigNumber;
        }>;
        doSwapThroughOrionPool(user: PromiseOrValue<string>, to: PromiseOrValue<string>, swapData: IPoolFunctionality.SwapDataStruct, overrides?: CallOverrides): Promise<[
            BigNumber,
            BigNumber
        ] & {
            amountOut: BigNumber;
            amountIn: BigNumber;
        }>;
        factories(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
        factory(overrides?: CallOverrides): Promise<string>;
        getFactoriesLength(overrides?: CallOverrides): Promise<BigNumber>;
        getWETH(overrides?: CallOverrides): Promise<string>;
        increaseAllowances(tokens: PromiseOrValue<string>[], tos: PromiseOrValue<string>[], amounts: PromiseOrValue<BigNumberish>[], overrides?: CallOverrides): Promise<void>;
        isFactory(a: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
        owner(overrides?: CallOverrides): Promise<string>;
        pairFor(curFactory: PromiseOrValue<string>, tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>;
        renounceOwnership(overrides?: CallOverrides): Promise<void>;
        supportedFactories(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<number>;
        transferOwnership(newOwner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        updateFactories(_factories: PromiseOrValue<string>[], _types: PromiseOrValue<BigNumberish>[], overrides?: CallOverrides): Promise<void>;
    };
    filters: {
        "OrionPoolSwap(address,address,address,uint256,uint256,uint256,uint256,address)"(sender?: null, st?: null, rt?: null, st_r?: null, st_a?: null, rt_r?: null, rt_a?: null, f?: null): OrionPoolSwapEventFilter;
        OrionPoolSwap(sender?: null, st?: null, rt?: null, st_r?: null, st_a?: null, rt_r?: null, rt_a?: null, f?: null): OrionPoolSwapEventFilter;
        "OwnershipTransferred(address,address)"(previousOwner?: PromiseOrValue<string> | null, newOwner?: PromiseOrValue<string> | null): OwnershipTransferredEventFilter;
        OwnershipTransferred(previousOwner?: PromiseOrValue<string> | null, newOwner?: PromiseOrValue<string> | null): OwnershipTransferredEventFilter;
    };
    estimateGas: {
        WETH(overrides?: CallOverrides): Promise<BigNumber>;
        addLiquidityFromExchange(tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, amountADesired: PromiseOrValue<BigNumberish>, amountBDesired: PromiseOrValue<BigNumberish>, amountAMin: PromiseOrValue<BigNumberish>, amountBMin: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        doSwapThroughOrionPool(user: PromiseOrValue<string>, to: PromiseOrValue<string>, swapData: IPoolFunctionality.SwapDataStruct, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        factories(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
        factory(overrides?: CallOverrides): Promise<BigNumber>;
        getFactoriesLength(overrides?: CallOverrides): Promise<BigNumber>;
        getWETH(overrides?: CallOverrides): Promise<BigNumber>;
        increaseAllowances(tokens: PromiseOrValue<string>[], tos: PromiseOrValue<string>[], amounts: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        isFactory(a: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        owner(overrides?: CallOverrides): Promise<BigNumber>;
        pairFor(curFactory: PromiseOrValue<string>, tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        renounceOwnership(overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        supportedFactories(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
        transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        updateFactories(_factories: PromiseOrValue<string>[], _types: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
    };
    populateTransaction: {
        WETH(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        addLiquidityFromExchange(tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, amountADesired: PromiseOrValue<BigNumberish>, amountBDesired: PromiseOrValue<BigNumberish>, amountAMin: PromiseOrValue<BigNumberish>, amountBMin: PromiseOrValue<BigNumberish>, to: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        doSwapThroughOrionPool(user: PromiseOrValue<string>, to: PromiseOrValue<string>, swapData: IPoolFunctionality.SwapDataStruct, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        factories(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        factory(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getFactoriesLength(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getWETH(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        increaseAllowances(tokens: PromiseOrValue<string>[], tos: PromiseOrValue<string>[], amounts: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        isFactory(a: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        owner(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        pairFor(curFactory: PromiseOrValue<string>, tokenA: PromiseOrValue<string>, tokenB: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        renounceOwnership(overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        supportedFactories(arg0: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
        transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        updateFactories(_factories: PromiseOrValue<string>[], _types: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
    };
}