@gooddollar/goodprotocol/types/contracts/reserve/ExchangeHelper.ts

GoodDollar Protocol

/* Autogenerated file. Do not edit manually. */
/* tslint:disable */
/* eslint-disable */
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,
} from "../../common";

export interface ExchangeHelperInterface extends utils.Interface {
  functions: {
    "avatar()": FunctionFragment;
    "buy(address[],uint256,uint256,uint256,address)": FunctionFragment;
    "cDaiAddress()": FunctionFragment;
    "daiAddress()": FunctionFragment;
    "dao()": FunctionFragment;
    "initialize(address)": FunctionFragment;
    "nameService()": FunctionFragment;
    "nativeToken()": FunctionFragment;
    "proxiableUUID()": FunctionFragment;
    "sell(address[],uint256,uint256,uint256,address)": FunctionFragment;
    "setAddresses()": FunctionFragment;
    "updateAvatar()": FunctionFragment;
    "upgradeTo(address)": FunctionFragment;
    "upgradeToAndCall(address,bytes)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "avatar"
      | "buy"
      | "cDaiAddress"
      | "daiAddress"
      | "dao"
      | "initialize"
      | "nameService"
      | "nativeToken"
      | "proxiableUUID"
      | "sell"
      | "setAddresses"
      | "updateAvatar"
      | "upgradeTo"
      | "upgradeToAndCall"
  ): FunctionFragment;

  encodeFunctionData(functionFragment: "avatar", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "buy",
    values: [string[], BigNumberish, BigNumberish, BigNumberish, string]
  ): string;
  encodeFunctionData(
    functionFragment: "cDaiAddress",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "daiAddress",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "dao", values?: undefined): string;
  encodeFunctionData(functionFragment: "initialize", values: [string]): string;
  encodeFunctionData(
    functionFragment: "nameService",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "nativeToken",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "proxiableUUID",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "sell",
    values: [string[], BigNumberish, BigNumberish, BigNumberish, string]
  ): string;
  encodeFunctionData(
    functionFragment: "setAddresses",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "updateAvatar",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "upgradeTo", values: [string]): string;
  encodeFunctionData(
    functionFragment: "upgradeToAndCall",
    values: [string, BytesLike]
  ): string;

  decodeFunctionResult(functionFragment: "avatar", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "buy", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "cDaiAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "daiAddress", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "dao", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "nameService",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "nativeToken",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "proxiableUUID",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "sell", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "setAddresses",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateAvatar",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "upgradeTo", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "upgradeToAndCall",
    data: BytesLike
  ): Result;

  events: {
    "AdminChanged(address,address)": EventFragment;
    "BeaconUpgraded(address)": EventFragment;
    "Initialized(uint8)": EventFragment;
    "TokenPurchased(address,address,uint256,uint256,address)": EventFragment;
    "TokenSold(address,address,uint256,uint256,uint256,address)": EventFragment;
    "Upgraded(address)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "AdminChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "BeaconUpgraded"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "TokenPurchased"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "TokenSold"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Upgraded"): EventFragment;
}

export interface AdminChangedEventObject {
  previousAdmin: string;
  newAdmin: string;
}
export type AdminChangedEvent = TypedEvent<
  [string, string],
  AdminChangedEventObject
>;

export type AdminChangedEventFilter = TypedEventFilter<AdminChangedEvent>;

export interface BeaconUpgradedEventObject {
  beacon: string;
}
export type BeaconUpgradedEvent = TypedEvent<
  [string],
  BeaconUpgradedEventObject
>;

export type BeaconUpgradedEventFilter = TypedEventFilter<BeaconUpgradedEvent>;

export interface InitializedEventObject {
  version: number;
}
export type InitializedEvent = TypedEvent<[number], InitializedEventObject>;

export type InitializedEventFilter = TypedEventFilter<InitializedEvent>;

export interface TokenPurchasedEventObject {
  caller: string;
  inputToken: string;
  inputAmount: BigNumber;
  actualReturn: BigNumber;
  receiverAddress: string;
}
export type TokenPurchasedEvent = TypedEvent<
  [string, string, BigNumber, BigNumber, string],
  TokenPurchasedEventObject
>;

export type TokenPurchasedEventFilter = TypedEventFilter<TokenPurchasedEvent>;

export interface TokenSoldEventObject {
  caller: string;
  outputToken: string;
  gdAmount: BigNumber;
  contributionAmount: BigNumber;
  actualReturn: BigNumber;
  receiverAddress: string;
}
export type TokenSoldEvent = TypedEvent<
  [string, string, BigNumber, BigNumber, BigNumber, string],
  TokenSoldEventObject
>;

export type TokenSoldEventFilter = TypedEventFilter<TokenSoldEvent>;

export interface UpgradedEventObject {
  implementation: string;
}
export type UpgradedEvent = TypedEvent<[string], UpgradedEventObject>;

export type UpgradedEventFilter = TypedEventFilter<UpgradedEvent>;

export interface ExchangeHelper extends BaseContract {
  connect(signerOrProvider: Signer | Provider | string): this;
  attach(addressOrName: string): this;
  deployed(): Promise<this>;

  interface: ExchangeHelperInterface;

  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: {
    avatar(overrides?: CallOverrides): Promise<[string]>;

    buy(
      _buyPath: string[],
      _tokenAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minDAIAmount: BigNumberish,
      _targetAddress: string,
      overrides?: PayableOverrides & { from?: string }
    ): Promise<ContractTransaction>;

    cDaiAddress(overrides?: CallOverrides): Promise<[string]>;

    daiAddress(overrides?: CallOverrides): Promise<[string]>;

    dao(overrides?: CallOverrides): Promise<[string]>;

    initialize(
      _ns: string,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    nameService(overrides?: CallOverrides): Promise<[string]>;

    nativeToken(overrides?: CallOverrides): Promise<[string]>;

    proxiableUUID(overrides?: CallOverrides): Promise<[string]>;

    sell(
      _sellPath: string[],
      _gdAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minTokenReturn: BigNumberish,
      _targetAddress: string,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    setAddresses(
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    updateAvatar(
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    upgradeTo(
      newImplementation: string,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    upgradeToAndCall(
      newImplementation: string,
      data: BytesLike,
      overrides?: PayableOverrides & { from?: string }
    ): Promise<ContractTransaction>;
  };

  avatar(overrides?: CallOverrides): Promise<string>;

  buy(
    _buyPath: string[],
    _tokenAmount: BigNumberish,
    _minReturn: BigNumberish,
    _minDAIAmount: BigNumberish,
    _targetAddress: string,
    overrides?: PayableOverrides & { from?: string }
  ): Promise<ContractTransaction>;

  cDaiAddress(overrides?: CallOverrides): Promise<string>;

  daiAddress(overrides?: CallOverrides): Promise<string>;

  dao(overrides?: CallOverrides): Promise<string>;

  initialize(
    _ns: string,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  nameService(overrides?: CallOverrides): Promise<string>;

  nativeToken(overrides?: CallOverrides): Promise<string>;

  proxiableUUID(overrides?: CallOverrides): Promise<string>;

  sell(
    _sellPath: string[],
    _gdAmount: BigNumberish,
    _minReturn: BigNumberish,
    _minTokenReturn: BigNumberish,
    _targetAddress: string,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  setAddresses(
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  updateAvatar(
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  upgradeTo(
    newImplementation: string,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  upgradeToAndCall(
    newImplementation: string,
    data: BytesLike,
    overrides?: PayableOverrides & { from?: string }
  ): Promise<ContractTransaction>;

  callStatic: {
    avatar(overrides?: CallOverrides): Promise<string>;

    buy(
      _buyPath: string[],
      _tokenAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minDAIAmount: BigNumberish,
      _targetAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    cDaiAddress(overrides?: CallOverrides): Promise<string>;

    daiAddress(overrides?: CallOverrides): Promise<string>;

    dao(overrides?: CallOverrides): Promise<string>;

    initialize(_ns: string, overrides?: CallOverrides): Promise<void>;

    nameService(overrides?: CallOverrides): Promise<string>;

    nativeToken(overrides?: CallOverrides): Promise<string>;

    proxiableUUID(overrides?: CallOverrides): Promise<string>;

    sell(
      _sellPath: string[],
      _gdAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minTokenReturn: BigNumberish,
      _targetAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setAddresses(overrides?: CallOverrides): Promise<void>;

    updateAvatar(overrides?: CallOverrides): Promise<void>;

    upgradeTo(
      newImplementation: string,
      overrides?: CallOverrides
    ): Promise<void>;

    upgradeToAndCall(
      newImplementation: string,
      data: BytesLike,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "AdminChanged(address,address)"(
      previousAdmin?: null,
      newAdmin?: null
    ): AdminChangedEventFilter;
    AdminChanged(
      previousAdmin?: null,
      newAdmin?: null
    ): AdminChangedEventFilter;

    "BeaconUpgraded(address)"(
      beacon?: string | null
    ): BeaconUpgradedEventFilter;
    BeaconUpgraded(beacon?: string | null): BeaconUpgradedEventFilter;

    "Initialized(uint8)"(version?: null): InitializedEventFilter;
    Initialized(version?: null): InitializedEventFilter;

    "TokenPurchased(address,address,uint256,uint256,address)"(
      caller?: string | null,
      inputToken?: string | null,
      inputAmount?: null,
      actualReturn?: null,
      receiverAddress?: string | null
    ): TokenPurchasedEventFilter;
    TokenPurchased(
      caller?: string | null,
      inputToken?: string | null,
      inputAmount?: null,
      actualReturn?: null,
      receiverAddress?: string | null
    ): TokenPurchasedEventFilter;

    "TokenSold(address,address,uint256,uint256,uint256,address)"(
      caller?: string | null,
      outputToken?: string | null,
      gdAmount?: null,
      contributionAmount?: null,
      actualReturn?: null,
      receiverAddress?: string | null
    ): TokenSoldEventFilter;
    TokenSold(
      caller?: string | null,
      outputToken?: string | null,
      gdAmount?: null,
      contributionAmount?: null,
      actualReturn?: null,
      receiverAddress?: string | null
    ): TokenSoldEventFilter;

    "Upgraded(address)"(implementation?: string | null): UpgradedEventFilter;
    Upgraded(implementation?: string | null): UpgradedEventFilter;
  };

  estimateGas: {
    avatar(overrides?: CallOverrides): Promise<BigNumber>;

    buy(
      _buyPath: string[],
      _tokenAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minDAIAmount: BigNumberish,
      _targetAddress: string,
      overrides?: PayableOverrides & { from?: string }
    ): Promise<BigNumber>;

    cDaiAddress(overrides?: CallOverrides): Promise<BigNumber>;

    daiAddress(overrides?: CallOverrides): Promise<BigNumber>;

    dao(overrides?: CallOverrides): Promise<BigNumber>;

    initialize(
      _ns: string,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    nameService(overrides?: CallOverrides): Promise<BigNumber>;

    nativeToken(overrides?: CallOverrides): Promise<BigNumber>;

    proxiableUUID(overrides?: CallOverrides): Promise<BigNumber>;

    sell(
      _sellPath: string[],
      _gdAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minTokenReturn: BigNumberish,
      _targetAddress: string,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    setAddresses(overrides?: Overrides & { from?: string }): Promise<BigNumber>;

    updateAvatar(overrides?: Overrides & { from?: string }): Promise<BigNumber>;

    upgradeTo(
      newImplementation: string,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    upgradeToAndCall(
      newImplementation: string,
      data: BytesLike,
      overrides?: PayableOverrides & { from?: string }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    avatar(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    buy(
      _buyPath: string[],
      _tokenAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minDAIAmount: BigNumberish,
      _targetAddress: string,
      overrides?: PayableOverrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    cDaiAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    daiAddress(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    dao(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    initialize(
      _ns: string,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    nameService(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    nativeToken(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    proxiableUUID(overrides?: CallOverrides): Promise<PopulatedTransaction>;

    sell(
      _sellPath: string[],
      _gdAmount: BigNumberish,
      _minReturn: BigNumberish,
      _minTokenReturn: BigNumberish,
      _targetAddress: string,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    setAddresses(
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    updateAvatar(
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    upgradeTo(
      newImplementation: string,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    upgradeToAndCall(
      newImplementation: string,
      data: BytesLike,
      overrides?: PayableOverrides & { from?: string }
    ): Promise<PopulatedTransaction>;
  };
}