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

import { Contract, ContractTransaction, EventFilter, Signer } from "ethers";
import { Listener, Provider } from "ethers/providers";
import { Arrayish, BigNumber, BigNumberish, Interface } from "ethers/utils";
import {
  TransactionOverrides,
  TypedEventDescription,
  TypedFunctionDescription,
} from ".";

interface CoinMachineInterface extends Interface {
  functions: {
    authority: TypedFunctionDescription<{ encode([]: []): string }>;

    getCapabilityRoles: TypedFunctionDescription<{
      encode([_sig]: [Arrayish]): string;
    }>;

    getColony: TypedFunctionDescription<{ encode([]: []): string }>;

    getDeprecated: TypedFunctionDescription<{ encode([]: []): string }>;

    owner: TypedFunctionDescription<{ encode([]: []): string }>;

    setAuthority: TypedFunctionDescription<{
      encode([authority_]: [string]): string;
    }>;

    setOwner: TypedFunctionDescription<{ encode([owner_]: [string]): string }>;

    identifier: TypedFunctionDescription<{ encode([]: []): string }>;

    version: TypedFunctionDescription<{ encode([]: []): string }>;

    install: TypedFunctionDescription<{ encode([_colony]: [string]): string }>;

    finishUpgrade: TypedFunctionDescription<{ encode([]: []): string }>;

    deprecate: TypedFunctionDescription<{
      encode([_deprecated]: [boolean]): string;
    }>;

    uninstall: TypedFunctionDescription<{ encode([]: []): string }>;

    initialise: TypedFunctionDescription<{
      encode([
        _token,
        _purchaseToken,
        _periodLength,
        _windowSize,
        _targetPerPeriod,
        _maxPerPeriod,
        _startingPrice,
        _whitelist,
      ]: [
        string,
        string,
        BigNumberish,
        BigNumberish,
        BigNumberish,
        BigNumberish,
        BigNumberish,
        string
      ]): string;
    }>;

    setWhitelist: TypedFunctionDescription<{
      encode([_whitelist]: [string]): string;
    }>;

    buyTokens: TypedFunctionDescription<{
      encode([_numTokens]: [BigNumberish]): string;
    }>;

    updatePeriod: TypedFunctionDescription<{ encode([]: []): string }>;

    getPurchaseToken: TypedFunctionDescription<{ encode([]: []): string }>;

    getToken: TypedFunctionDescription<{ encode([]: []): string }>;

    getActivePeriod: TypedFunctionDescription<{ encode([]: []): string }>;

    getActiveSold: TypedFunctionDescription<{ encode([]: []): string }>;

    getActiveIntake: TypedFunctionDescription<{ encode([]: []): string }>;

    getEMAIntake: TypedFunctionDescription<{ encode([]: []): string }>;

    getTokenBalance: TypedFunctionDescription<{ encode([]: []): string }>;

    getPeriodLength: TypedFunctionDescription<{ encode([]: []): string }>;

    getWindowSize: TypedFunctionDescription<{ encode([]: []): string }>;

    getTargetPerPeriod: TypedFunctionDescription<{ encode([]: []): string }>;

    getMaxPerPeriod: TypedFunctionDescription<{ encode([]: []): string }>;

    getCurrentPrice: TypedFunctionDescription<{ encode([]: []): string }>;

    getNumAvailable: TypedFunctionDescription<{ encode([]: []): string }>;

    getWhitelist: TypedFunctionDescription<{ encode([]: []): string }>;

    getEvolvePrice: TypedFunctionDescription<{ encode([]: []): string }>;
  };

  events: {
    ExtensionInitialised: TypedEventDescription<{
      encodeTopics([]: []): string[];
    }>;

    LogSetAuthority: TypedEventDescription<{
      encodeTopics([authority]: [string | null]): string[];
    }>;

    LogSetOwner: TypedEventDescription<{
      encodeTopics([owner]: [string | null]): string[];
    }>;

    PeriodUpdated: TypedEventDescription<{
      encodeTopics([activePeriod, currentPeriod]: [null, null]): string[];
    }>;

    PriceEvolutionSet: TypedEventDescription<{
      encodeTopics([evolvePrice]: [null]): string[];
    }>;

    TokensBought: TypedEventDescription<{
      encodeTopics([buyer, numTokens, totalCost]: [null, null, null]): string[];
    }>;

    WhitelistSet: TypedEventDescription<{
      encodeTopics([whitelist]: [null]): string[];
    }>;
  };
}

export class CoinMachine extends Contract {
  connect(signerOrProvider: Signer | Provider | string): CoinMachine;
  attach(addressOrName: string): CoinMachine;
  deployed(): Promise<CoinMachine>;

  on(event: EventFilter | string, listener: Listener): CoinMachine;
  once(event: EventFilter | string, listener: Listener): CoinMachine;
  addListener(eventName: EventFilter | string, listener: Listener): CoinMachine;
  removeAllListeners(eventName: EventFilter | string): CoinMachine;
  removeListener(eventName: any, listener: Listener): CoinMachine;

  interface: CoinMachineInterface;

  functions: {
    authority(overrides?: TransactionOverrides): Promise<string>;

    "authority()"(overrides?: TransactionOverrides): Promise<string>;

    getCapabilityRoles(
      _sig: Arrayish,
      overrides?: TransactionOverrides
    ): Promise<string>;

    "getCapabilityRoles(bytes4)"(
      _sig: Arrayish,
      overrides?: TransactionOverrides
    ): Promise<string>;

    getColony(overrides?: TransactionOverrides): Promise<string>;

    "getColony()"(overrides?: TransactionOverrides): Promise<string>;

    getDeprecated(overrides?: TransactionOverrides): Promise<boolean>;

    "getDeprecated()"(overrides?: TransactionOverrides): Promise<boolean>;

    owner(overrides?: TransactionOverrides): Promise<string>;

    "owner()"(overrides?: TransactionOverrides): Promise<string>;

    setAuthority(
      authority_: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    "setAuthority(address)"(
      authority_: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    setOwner(
      owner_: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    "setOwner(address)"(
      owner_: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Returns the identifier of the extension
     */
    identifier(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Returns the identifier of the extension
     */
    "identifier()"(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Returns the version of the extension
     */
    version(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Returns the version of the extension
     */
    "version()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Configures the extension
     * @param _colony The colony in which the extension holds permissions
     */
    install(
      _colony: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Configures the extension
     * @param _colony The colony in which the extension holds permissions
     */
    "install(address)"(
      _colony: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Called when upgrading the extension
     */
    finishUpgrade(
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Called when upgrading the extension
     */
    "finishUpgrade()"(
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Called when deprecating (or undeprecating) the extension
     */
    deprecate(
      _deprecated: boolean,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Called when deprecating (or undeprecating) the extension
     */
    "deprecate(bool)"(
      _deprecated: boolean,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Called when uninstalling the extension
     */
    uninstall(overrides?: TransactionOverrides): Promise<ContractTransaction>;

    /**
     * Called when uninstalling the extension
     */
    "uninstall()"(
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Must be called before any sales can be made
     * @param _maxPerPeriod The maximum number of tokens that can be sold per period
     * @param _periodLength How long in seconds each period of the sale should last
     * @param _purchaseToken The token to receive payments in. Use 0x0 for ether
     * @param _startingPrice The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
     * @param _targetPerPeriod The number of tokens to aim to sell per period
     * @param _token The token we are selling. Cannot be ether
     * @param _whitelist Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
     * @param _windowSize Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
     */
    initialise(
      _token: string,
      _purchaseToken: string,
      _periodLength: BigNumberish,
      _windowSize: BigNumberish,
      _targetPerPeriod: BigNumberish,
      _maxPerPeriod: BigNumberish,
      _startingPrice: BigNumberish,
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Must be called before any sales can be made
     * @param _maxPerPeriod The maximum number of tokens that can be sold per period
     * @param _periodLength How long in seconds each period of the sale should last
     * @param _purchaseToken The token to receive payments in. Use 0x0 for ether
     * @param _startingPrice The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
     * @param _targetPerPeriod The number of tokens to aim to sell per period
     * @param _token The token we are selling. Cannot be ether
     * @param _whitelist Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
     * @param _windowSize Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
     */
    "initialise(address,address,uint256,uint256,uint256,uint256,uint256,address)"(
      _token: string,
      _purchaseToken: string,
      _periodLength: BigNumberish,
      _windowSize: BigNumberish,
      _targetPerPeriod: BigNumberish,
      _maxPerPeriod: BigNumberish,
      _startingPrice: BigNumberish,
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Set the address for an (optional) whitelist
     * @param _whitelist The address of the whitelist
     */
    setWhitelist(
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Set the address for an (optional) whitelist
     * @param _whitelist The address of the whitelist
     */
    "setWhitelist(address)"(
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Purchase tokens from Coin Machine.
     * @param _numTokens The number of tokens to purchase
     */
    buyTokens(
      _numTokens: BigNumberish,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Purchase tokens from Coin Machine.
     * @param _numTokens The number of tokens to purchase
     */
    "buyTokens(uint256)"(
      _numTokens: BigNumberish,
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Bring the token accounting current
     */
    updatePeriod(
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Bring the token accounting current
     */
    "updatePeriod()"(
      overrides?: TransactionOverrides
    ): Promise<ContractTransaction>;

    /**
     * Get the address of the token being used to make purchases
     */
    getPurchaseToken(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Get the address of the token being used to make purchases
     */
    "getPurchaseToken()"(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Get the address of the token being sold
     */
    getToken(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Get the address of the token being sold
     */
    "getToken()"(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Get the period that the price was last updated for or a purchase was made
     */
    getActivePeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the period that the price was last updated for or a purchase was made
     */
    "getActivePeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens sold in the period that the price was last updated for or a purchase was made
     */
    getActiveSold(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens sold in the period that the price was last updated for or a purchase was made
     */
    "getActiveSold()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens received in the period that the price was last updated for or a purchase was made
     */
    getActiveIntake(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens received in the period that the price was last updated for or a purchase was made
     */
    "getActiveIntake()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the EMA of the number of tokens received each period
     */
    getEMAIntake(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the EMA of the number of tokens received each period
     */
    "getEMAIntake()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the remaining balance of tokens
     */
    getTokenBalance(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the remaining balance of tokens
     */
    "getTokenBalance()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the length of the sale period
     */
    getPeriodLength(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the length of the sale period
     */
    "getPeriodLength()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the size of the averaging window
     */
    getWindowSize(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the size of the averaging window
     */
    "getWindowSize()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the target number of tokens to sell per period
     */
    getTargetPerPeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the target number of tokens to sell per period
     */
    "getTargetPerPeriod()"(
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Get the maximum number of tokens to sell per period
     */
    getMaxPerPeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the maximum number of tokens to sell per period
     */
    "getMaxPerPeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the current price per token
     */
    getCurrentPrice(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the current price per token
     */
    "getCurrentPrice()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of remaining tokens for sale this period
     */
    getNumAvailable(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of remaining tokens for sale this period
     */
    "getNumAvailable()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the whitelist (if exists)
     */
    getWhitelist(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Get the address of the whitelist (if exists)
     */
    "getWhitelist()"(overrides?: TransactionOverrides): Promise<string>;

    /**
     * Get the evolvePrice boolean
     */
    getEvolvePrice(overrides?: TransactionOverrides): Promise<boolean>;

    /**
     * Get the evolvePrice boolean
     */
    "getEvolvePrice()"(overrides?: TransactionOverrides): Promise<boolean>;
  };

  authority(overrides?: TransactionOverrides): Promise<string>;

  "authority()"(overrides?: TransactionOverrides): Promise<string>;

  getCapabilityRoles(
    _sig: Arrayish,
    overrides?: TransactionOverrides
  ): Promise<string>;

  "getCapabilityRoles(bytes4)"(
    _sig: Arrayish,
    overrides?: TransactionOverrides
  ): Promise<string>;

  getColony(overrides?: TransactionOverrides): Promise<string>;

  "getColony()"(overrides?: TransactionOverrides): Promise<string>;

  getDeprecated(overrides?: TransactionOverrides): Promise<boolean>;

  "getDeprecated()"(overrides?: TransactionOverrides): Promise<boolean>;

  owner(overrides?: TransactionOverrides): Promise<string>;

  "owner()"(overrides?: TransactionOverrides): Promise<string>;

  setAuthority(
    authority_: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  "setAuthority(address)"(
    authority_: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  setOwner(
    owner_: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  "setOwner(address)"(
    owner_: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Returns the identifier of the extension
   */
  identifier(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Returns the identifier of the extension
   */
  "identifier()"(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Returns the version of the extension
   */
  version(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Returns the version of the extension
   */
  "version()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Configures the extension
   * @param _colony The colony in which the extension holds permissions
   */
  install(
    _colony: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Configures the extension
   * @param _colony The colony in which the extension holds permissions
   */
  "install(address)"(
    _colony: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Called when upgrading the extension
   */
  finishUpgrade(overrides?: TransactionOverrides): Promise<ContractTransaction>;

  /**
   * Called when upgrading the extension
   */
  "finishUpgrade()"(
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Called when deprecating (or undeprecating) the extension
   */
  deprecate(
    _deprecated: boolean,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Called when deprecating (or undeprecating) the extension
   */
  "deprecate(bool)"(
    _deprecated: boolean,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Called when uninstalling the extension
   */
  uninstall(overrides?: TransactionOverrides): Promise<ContractTransaction>;

  /**
   * Called when uninstalling the extension
   */
  "uninstall()"(overrides?: TransactionOverrides): Promise<ContractTransaction>;

  /**
   * Must be called before any sales can be made
   * @param _maxPerPeriod The maximum number of tokens that can be sold per period
   * @param _periodLength How long in seconds each period of the sale should last
   * @param _purchaseToken The token to receive payments in. Use 0x0 for ether
   * @param _startingPrice The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
   * @param _targetPerPeriod The number of tokens to aim to sell per period
   * @param _token The token we are selling. Cannot be ether
   * @param _whitelist Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
   * @param _windowSize Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
   */
  initialise(
    _token: string,
    _purchaseToken: string,
    _periodLength: BigNumberish,
    _windowSize: BigNumberish,
    _targetPerPeriod: BigNumberish,
    _maxPerPeriod: BigNumberish,
    _startingPrice: BigNumberish,
    _whitelist: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Must be called before any sales can be made
   * @param _maxPerPeriod The maximum number of tokens that can be sold per period
   * @param _periodLength How long in seconds each period of the sale should last
   * @param _purchaseToken The token to receive payments in. Use 0x0 for ether
   * @param _startingPrice The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
   * @param _targetPerPeriod The number of tokens to aim to sell per period
   * @param _token The token we are selling. Cannot be ether
   * @param _whitelist Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
   * @param _windowSize Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
   */
  "initialise(address,address,uint256,uint256,uint256,uint256,uint256,address)"(
    _token: string,
    _purchaseToken: string,
    _periodLength: BigNumberish,
    _windowSize: BigNumberish,
    _targetPerPeriod: BigNumberish,
    _maxPerPeriod: BigNumberish,
    _startingPrice: BigNumberish,
    _whitelist: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Set the address for an (optional) whitelist
   * @param _whitelist The address of the whitelist
   */
  setWhitelist(
    _whitelist: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Set the address for an (optional) whitelist
   * @param _whitelist The address of the whitelist
   */
  "setWhitelist(address)"(
    _whitelist: string,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Purchase tokens from Coin Machine.
   * @param _numTokens The number of tokens to purchase
   */
  buyTokens(
    _numTokens: BigNumberish,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Purchase tokens from Coin Machine.
   * @param _numTokens The number of tokens to purchase
   */
  "buyTokens(uint256)"(
    _numTokens: BigNumberish,
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Bring the token accounting current
   */
  updatePeriod(overrides?: TransactionOverrides): Promise<ContractTransaction>;

  /**
   * Bring the token accounting current
   */
  "updatePeriod()"(
    overrides?: TransactionOverrides
  ): Promise<ContractTransaction>;

  /**
   * Get the address of the token being used to make purchases
   */
  getPurchaseToken(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Get the address of the token being used to make purchases
   */
  "getPurchaseToken()"(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Get the address of the token being sold
   */
  getToken(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Get the address of the token being sold
   */
  "getToken()"(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Get the period that the price was last updated for or a purchase was made
   */
  getActivePeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the period that the price was last updated for or a purchase was made
   */
  "getActivePeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the number of tokens sold in the period that the price was last updated for or a purchase was made
   */
  getActiveSold(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the number of tokens sold in the period that the price was last updated for or a purchase was made
   */
  "getActiveSold()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the number of tokens received in the period that the price was last updated for or a purchase was made
   */
  getActiveIntake(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the number of tokens received in the period that the price was last updated for or a purchase was made
   */
  "getActiveIntake()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the EMA of the number of tokens received each period
   */
  getEMAIntake(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the EMA of the number of tokens received each period
   */
  "getEMAIntake()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the remaining balance of tokens
   */
  getTokenBalance(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the remaining balance of tokens
   */
  "getTokenBalance()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the length of the sale period
   */
  getPeriodLength(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the length of the sale period
   */
  "getPeriodLength()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the size of the averaging window
   */
  getWindowSize(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the size of the averaging window
   */
  "getWindowSize()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the target number of tokens to sell per period
   */
  getTargetPerPeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the target number of tokens to sell per period
   */
  "getTargetPerPeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the maximum number of tokens to sell per period
   */
  getMaxPerPeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the maximum number of tokens to sell per period
   */
  "getMaxPerPeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the current price per token
   */
  getCurrentPrice(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the current price per token
   */
  "getCurrentPrice()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the number of remaining tokens for sale this period
   */
  getNumAvailable(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the number of remaining tokens for sale this period
   */
  "getNumAvailable()"(overrides?: TransactionOverrides): Promise<BigNumber>;

  /**
   * Get the address of the whitelist (if exists)
   */
  getWhitelist(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Get the address of the whitelist (if exists)
   */
  "getWhitelist()"(overrides?: TransactionOverrides): Promise<string>;

  /**
   * Get the evolvePrice boolean
   */
  getEvolvePrice(overrides?: TransactionOverrides): Promise<boolean>;

  /**
   * Get the evolvePrice boolean
   */
  "getEvolvePrice()"(overrides?: TransactionOverrides): Promise<boolean>;

  filters: {
    ExtensionInitialised(): EventFilter;

    LogSetAuthority(authority: string | null): EventFilter;

    LogSetOwner(owner: string | null): EventFilter;

    PeriodUpdated(activePeriod: null, currentPeriod: null): EventFilter;

    PriceEvolutionSet(evolvePrice: null): EventFilter;

    TokensBought(buyer: null, numTokens: null, totalCost: null): EventFilter;

    WhitelistSet(whitelist: null): EventFilter;
  };

  estimate: {
    authority(overrides?: TransactionOverrides): Promise<BigNumber>;

    "authority()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    getCapabilityRoles(
      _sig: Arrayish,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    "getCapabilityRoles(bytes4)"(
      _sig: Arrayish,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    getColony(overrides?: TransactionOverrides): Promise<BigNumber>;

    "getColony()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    getDeprecated(overrides?: TransactionOverrides): Promise<BigNumber>;

    "getDeprecated()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    owner(overrides?: TransactionOverrides): Promise<BigNumber>;

    "owner()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    setAuthority(
      authority_: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    "setAuthority(address)"(
      authority_: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    setOwner(
      owner_: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    "setOwner(address)"(
      owner_: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Returns the identifier of the extension
     */
    identifier(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Returns the identifier of the extension
     */
    "identifier()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Returns the version of the extension
     */
    version(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Returns the version of the extension
     */
    "version()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Configures the extension
     * @param _colony The colony in which the extension holds permissions
     */
    install(
      _colony: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Configures the extension
     * @param _colony The colony in which the extension holds permissions
     */
    "install(address)"(
      _colony: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Called when upgrading the extension
     */
    finishUpgrade(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Called when upgrading the extension
     */
    "finishUpgrade()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Called when deprecating (or undeprecating) the extension
     */
    deprecate(
      _deprecated: boolean,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Called when deprecating (or undeprecating) the extension
     */
    "deprecate(bool)"(
      _deprecated: boolean,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Called when uninstalling the extension
     */
    uninstall(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Called when uninstalling the extension
     */
    "uninstall()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Must be called before any sales can be made
     * @param _maxPerPeriod The maximum number of tokens that can be sold per period
     * @param _periodLength How long in seconds each period of the sale should last
     * @param _purchaseToken The token to receive payments in. Use 0x0 for ether
     * @param _startingPrice The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
     * @param _targetPerPeriod The number of tokens to aim to sell per period
     * @param _token The token we are selling. Cannot be ether
     * @param _whitelist Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
     * @param _windowSize Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
     */
    initialise(
      _token: string,
      _purchaseToken: string,
      _periodLength: BigNumberish,
      _windowSize: BigNumberish,
      _targetPerPeriod: BigNumberish,
      _maxPerPeriod: BigNumberish,
      _startingPrice: BigNumberish,
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Must be called before any sales can be made
     * @param _maxPerPeriod The maximum number of tokens that can be sold per period
     * @param _periodLength How long in seconds each period of the sale should last
     * @param _purchaseToken The token to receive payments in. Use 0x0 for ether
     * @param _startingPrice The sale price to start at, expressed in units of _purchaseToken per token being sold, as a WAD
     * @param _targetPerPeriod The number of tokens to aim to sell per period
     * @param _token The token we are selling. Cannot be ether
     * @param _whitelist Optionally an address of a whitelist contract to use can be provided. Pass 0x0 if no whitelist being used
     * @param _windowSize Characteristic number of periods that should be used for the moving average. In the long-term, 86% of the weighting will be in this window size. The higher the number, the slower the price will be to adjust
     */
    "initialise(address,address,uint256,uint256,uint256,uint256,uint256,address)"(
      _token: string,
      _purchaseToken: string,
      _periodLength: BigNumberish,
      _windowSize: BigNumberish,
      _targetPerPeriod: BigNumberish,
      _maxPerPeriod: BigNumberish,
      _startingPrice: BigNumberish,
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Set the address for an (optional) whitelist
     * @param _whitelist The address of the whitelist
     */
    setWhitelist(
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Set the address for an (optional) whitelist
     * @param _whitelist The address of the whitelist
     */
    "setWhitelist(address)"(
      _whitelist: string,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Purchase tokens from Coin Machine.
     * @param _numTokens The number of tokens to purchase
     */
    buyTokens(
      _numTokens: BigNumberish,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Purchase tokens from Coin Machine.
     * @param _numTokens The number of tokens to purchase
     */
    "buyTokens(uint256)"(
      _numTokens: BigNumberish,
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Bring the token accounting current
     */
    updatePeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Bring the token accounting current
     */
    "updatePeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the token being used to make purchases
     */
    getPurchaseToken(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the token being used to make purchases
     */
    "getPurchaseToken()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the token being sold
     */
    getToken(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the token being sold
     */
    "getToken()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the period that the price was last updated for or a purchase was made
     */
    getActivePeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the period that the price was last updated for or a purchase was made
     */
    "getActivePeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens sold in the period that the price was last updated for or a purchase was made
     */
    getActiveSold(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens sold in the period that the price was last updated for or a purchase was made
     */
    "getActiveSold()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens received in the period that the price was last updated for or a purchase was made
     */
    getActiveIntake(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of tokens received in the period that the price was last updated for or a purchase was made
     */
    "getActiveIntake()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the EMA of the number of tokens received each period
     */
    getEMAIntake(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the EMA of the number of tokens received each period
     */
    "getEMAIntake()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the remaining balance of tokens
     */
    getTokenBalance(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the remaining balance of tokens
     */
    "getTokenBalance()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the length of the sale period
     */
    getPeriodLength(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the length of the sale period
     */
    "getPeriodLength()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the size of the averaging window
     */
    getWindowSize(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the size of the averaging window
     */
    "getWindowSize()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the target number of tokens to sell per period
     */
    getTargetPerPeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the target number of tokens to sell per period
     */
    "getTargetPerPeriod()"(
      overrides?: TransactionOverrides
    ): Promise<BigNumber>;

    /**
     * Get the maximum number of tokens to sell per period
     */
    getMaxPerPeriod(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the maximum number of tokens to sell per period
     */
    "getMaxPerPeriod()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the current price per token
     */
    getCurrentPrice(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the current price per token
     */
    "getCurrentPrice()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of remaining tokens for sale this period
     */
    getNumAvailable(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the number of remaining tokens for sale this period
     */
    "getNumAvailable()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the whitelist (if exists)
     */
    getWhitelist(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the address of the whitelist (if exists)
     */
    "getWhitelist()"(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the evolvePrice boolean
     */
    getEvolvePrice(overrides?: TransactionOverrides): Promise<BigNumber>;

    /**
     * Get the evolvePrice boolean
     */
    "getEvolvePrice()"(overrides?: TransactionOverrides): Promise<BigNumber>;
  };
}