/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */

import BN from "bn.js";
import { EventData, PastEventOptions } from "web3-eth-contract";

export interface IUniswapV3FactoryContract
  extends Truffle.Contract<IUniswapV3FactoryInstance> {
  "new"(meta?: Truffle.TransactionDetails): Promise<IUniswapV3FactoryInstance>;
}

export interface FeeAmountEnabled {
  name: "FeeAmountEnabled";
  args: {
    fee: BN;
    tickSpacing: BN;
    0: BN;
    1: BN;
  };
}

export interface OwnerChanged {
  name: "OwnerChanged";
  args: {
    oldOwner: string;
    newOwner: string;
    0: string;
    1: string;
  };
}

export interface PoolCreated {
  name: "PoolCreated";
  args: {
    token0: string;
    token1: string;
    fee: BN;
    tickSpacing: BN;
    pool: string;
    0: string;
    1: string;
    2: BN;
    3: BN;
    4: string;
  };
}

type AllEvents = FeeAmountEnabled | OwnerChanged | PoolCreated;

export interface IUniswapV3FactoryInstance extends Truffle.ContractInstance {
  /**
   * Can be changed by the current owner via setOwner
   * Returns the current owner of the factory
   */
  owner(txDetails?: Truffle.TransactionDetails): Promise<string>;

  /**
   * A fee amount can never be removed, so this value should be hard coded or cached in the calling context
   * Returns the tick spacing for a given fee amount, if enabled, or 0 if not enabled
   * @param fee The enabled fee, denominated in hundredths of a bip. Returns 0 in case of unenabled fee
   */
  feeAmountTickSpacing(
    fee: number | BN | string,
    txDetails?: Truffle.TransactionDetails
  ): Promise<BN>;

  /**
   * tokenA and tokenB may be passed in either token0/token1 or token1/token0 order
   * Returns the pool address for a given pair of tokens and a fee, or address 0 if it does not exist
   * @param fee The fee collected upon every swap in the pool, denominated in hundredths of a bip
   * @param tokenA The contract address of either token0 or token1
   * @param tokenB The contract address of the other token
   */
  getPool(
    tokenA: string,
    tokenB: string,
    fee: number | BN | string,
    txDetails?: Truffle.TransactionDetails
  ): Promise<string>;

  /**
   * tokenA and tokenB may be passed in either order: token0/token1 or token1/token0. tickSpacing is retrieved from the fee. The call will revert if the pool already exists, the fee is invalid, or the token arguments are invalid.
   * Creates a pool for the given two tokens and fee
   * @param fee The desired fee for the pool
   * @param tokenA One of the two tokens in the desired pool
   * @param tokenB The other of the two tokens in the desired pool
   */
  createPool: {
    (
      tokenA: string,
      tokenB: string,
      fee: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<Truffle.TransactionResponse<AllEvents>>;
    call(
      tokenA: string,
      tokenB: string,
      fee: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<string>;
    sendTransaction(
      tokenA: string,
      tokenB: string,
      fee: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<string>;
    estimateGas(
      tokenA: string,
      tokenB: string,
      fee: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<number>;
  };

  /**
   * Must be called by the current owner
   * Updates the owner of the factory
   * @param _owner The new owner of the factory
   */
  setOwner: {
    (_owner: string, txDetails?: Truffle.TransactionDetails): Promise<
      Truffle.TransactionResponse<AllEvents>
    >;
    call(_owner: string, txDetails?: Truffle.TransactionDetails): Promise<void>;
    sendTransaction(
      _owner: string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<string>;
    estimateGas(
      _owner: string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<number>;
  };

  /**
   * Fee amounts may never be removed once enabled
   * Enables a fee amount with the given tickSpacing
   * @param fee The fee amount to enable, denominated in hundredths of a bip (i.e. 1e-6)
   * @param tickSpacing The spacing between ticks to be enforced for all pools created with the given fee amount
   */
  enableFeeAmount: {
    (
      fee: number | BN | string,
      tickSpacing: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<Truffle.TransactionResponse<AllEvents>>;
    call(
      fee: number | BN | string,
      tickSpacing: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<void>;
    sendTransaction(
      fee: number | BN | string,
      tickSpacing: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<string>;
    estimateGas(
      fee: number | BN | string,
      tickSpacing: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<number>;
  };

  methods: {
    /**
     * Can be changed by the current owner via setOwner
     * Returns the current owner of the factory
     */
    owner(txDetails?: Truffle.TransactionDetails): Promise<string>;

    /**
     * A fee amount can never be removed, so this value should be hard coded or cached in the calling context
     * Returns the tick spacing for a given fee amount, if enabled, or 0 if not enabled
     * @param fee The enabled fee, denominated in hundredths of a bip. Returns 0 in case of unenabled fee
     */
    feeAmountTickSpacing(
      fee: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<BN>;

    /**
     * tokenA and tokenB may be passed in either token0/token1 or token1/token0 order
     * Returns the pool address for a given pair of tokens and a fee, or address 0 if it does not exist
     * @param fee The fee collected upon every swap in the pool, denominated in hundredths of a bip
     * @param tokenA The contract address of either token0 or token1
     * @param tokenB The contract address of the other token
     */
    getPool(
      tokenA: string,
      tokenB: string,
      fee: number | BN | string,
      txDetails?: Truffle.TransactionDetails
    ): Promise<string>;

    /**
     * tokenA and tokenB may be passed in either order: token0/token1 or token1/token0. tickSpacing is retrieved from the fee. The call will revert if the pool already exists, the fee is invalid, or the token arguments are invalid.
     * Creates a pool for the given two tokens and fee
     * @param fee The desired fee for the pool
     * @param tokenA One of the two tokens in the desired pool
     * @param tokenB The other of the two tokens in the desired pool
     */
    createPool: {
      (
        tokenA: string,
        tokenB: string,
        fee: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<Truffle.TransactionResponse<AllEvents>>;
      call(
        tokenA: string,
        tokenB: string,
        fee: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<string>;
      sendTransaction(
        tokenA: string,
        tokenB: string,
        fee: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<string>;
      estimateGas(
        tokenA: string,
        tokenB: string,
        fee: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<number>;
    };

    /**
     * Must be called by the current owner
     * Updates the owner of the factory
     * @param _owner The new owner of the factory
     */
    setOwner: {
      (_owner: string, txDetails?: Truffle.TransactionDetails): Promise<
        Truffle.TransactionResponse<AllEvents>
      >;
      call(
        _owner: string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<void>;
      sendTransaction(
        _owner: string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<string>;
      estimateGas(
        _owner: string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<number>;
    };

    /**
     * Fee amounts may never be removed once enabled
     * Enables a fee amount with the given tickSpacing
     * @param fee The fee amount to enable, denominated in hundredths of a bip (i.e. 1e-6)
     * @param tickSpacing The spacing between ticks to be enforced for all pools created with the given fee amount
     */
    enableFeeAmount: {
      (
        fee: number | BN | string,
        tickSpacing: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<Truffle.TransactionResponse<AllEvents>>;
      call(
        fee: number | BN | string,
        tickSpacing: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<void>;
      sendTransaction(
        fee: number | BN | string,
        tickSpacing: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<string>;
      estimateGas(
        fee: number | BN | string,
        tickSpacing: number | BN | string,
        txDetails?: Truffle.TransactionDetails
      ): Promise<number>;
    };
  };

  getPastEvents(event: string): Promise<EventData[]>;
  getPastEvents(
    event: string,
    options: PastEventOptions,
    callback: (error: Error, event: EventData) => void
  ): Promise<EventData[]>;
  getPastEvents(event: string, options: PastEventOptions): Promise<EventData[]>;
  getPastEvents(
    event: string,
    callback: (error: Error, event: EventData) => void
  ): Promise<EventData[]>;
}