@gooddollar/goodprotocol/types/contracts/MentoInterfaces.sol/IGoodDollarExpansionController.ts

GoodDollar Protocol

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

export interface IGoodDollarExpansionControllerInterface
  extends utils.Interface {
  functions: {
    "initialize(address,address,address,address)": FunctionFragment;
    "mintRewardFromRR(bytes32,address,uint256)": FunctionFragment;
    "mintUBIFromExpansion(bytes32)": FunctionFragment;
    "mintUBIFromInterest(bytes32,uint256)": FunctionFragment;
    "mintUBIFromReserveBalance(bytes32)": FunctionFragment;
    "setAvatar(address)": FunctionFragment;
    "setDistributionHelper(address)": FunctionFragment;
    "setExpansionConfig(bytes32,uint64,uint32)": FunctionFragment;
    "setGoodDollarExchangeProvider(address)": FunctionFragment;
    "setReserve(address)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "initialize"
      | "mintRewardFromRR"
      | "mintUBIFromExpansion"
      | "mintUBIFromInterest"
      | "mintUBIFromReserveBalance"
      | "setAvatar"
      | "setDistributionHelper"
      | "setExpansionConfig"
      | "setGoodDollarExchangeProvider"
      | "setReserve"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "initialize",
    values: [string, string, string, string]
  ): string;
  encodeFunctionData(
    functionFragment: "mintRewardFromRR",
    values: [BytesLike, string, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "mintUBIFromExpansion",
    values: [BytesLike]
  ): string;
  encodeFunctionData(
    functionFragment: "mintUBIFromInterest",
    values: [BytesLike, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "mintUBIFromReserveBalance",
    values: [BytesLike]
  ): string;
  encodeFunctionData(functionFragment: "setAvatar", values: [string]): string;
  encodeFunctionData(
    functionFragment: "setDistributionHelper",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "setExpansionConfig",
    values: [BytesLike, BigNumberish, BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "setGoodDollarExchangeProvider",
    values: [string]
  ): string;
  encodeFunctionData(functionFragment: "setReserve", values: [string]): string;

  decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "mintRewardFromRR",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "mintUBIFromExpansion",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "mintUBIFromInterest",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "mintUBIFromReserveBalance",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "setAvatar", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "setDistributionHelper",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setExpansionConfig",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setGoodDollarExchangeProvider",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "setReserve", data: BytesLike): Result;

  events: {
    "AvatarUpdated(address)": EventFragment;
    "DistributionHelperUpdated(address)": EventFragment;
    "ExpansionConfigSet(bytes32,uint64,uint32)": EventFragment;
    "ExpansionUBIMinted(bytes32,uint256)": EventFragment;
    "GoodDollarExchangeProviderUpdated(address)": EventFragment;
    "InterestUBIMinted(bytes32,uint256)": EventFragment;
    "ReserveUpdated(address)": EventFragment;
    "RewardMinted(bytes32,address,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "AvatarUpdated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "DistributionHelperUpdated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ExpansionConfigSet"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ExpansionUBIMinted"): EventFragment;
  getEvent(
    nameOrSignatureOrTopic: "GoodDollarExchangeProviderUpdated"
  ): EventFragment;
  getEvent(nameOrSignatureOrTopic: "InterestUBIMinted"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ReserveUpdated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "RewardMinted"): EventFragment;
}

export interface AvatarUpdatedEventObject {
  avatar: string;
}
export type AvatarUpdatedEvent = TypedEvent<[string], AvatarUpdatedEventObject>;

export type AvatarUpdatedEventFilter = TypedEventFilter<AvatarUpdatedEvent>;

export interface DistributionHelperUpdatedEventObject {
  distributionHelper: string;
}
export type DistributionHelperUpdatedEvent = TypedEvent<
  [string],
  DistributionHelperUpdatedEventObject
>;

export type DistributionHelperUpdatedEventFilter =
  TypedEventFilter<DistributionHelperUpdatedEvent>;

export interface ExpansionConfigSetEventObject {
  exchangeId: string;
  expansionRate: BigNumber;
  expansionfrequency: number;
}
export type ExpansionConfigSetEvent = TypedEvent<
  [string, BigNumber, number],
  ExpansionConfigSetEventObject
>;

export type ExpansionConfigSetEventFilter =
  TypedEventFilter<ExpansionConfigSetEvent>;

export interface ExpansionUBIMintedEventObject {
  exchangeId: string;
  amount: BigNumber;
}
export type ExpansionUBIMintedEvent = TypedEvent<
  [string, BigNumber],
  ExpansionUBIMintedEventObject
>;

export type ExpansionUBIMintedEventFilter =
  TypedEventFilter<ExpansionUBIMintedEvent>;

export interface GoodDollarExchangeProviderUpdatedEventObject {
  exchangeProvider: string;
}
export type GoodDollarExchangeProviderUpdatedEvent = TypedEvent<
  [string],
  GoodDollarExchangeProviderUpdatedEventObject
>;

export type GoodDollarExchangeProviderUpdatedEventFilter =
  TypedEventFilter<GoodDollarExchangeProviderUpdatedEvent>;

export interface InterestUBIMintedEventObject {
  exchangeId: string;
  amount: BigNumber;
}
export type InterestUBIMintedEvent = TypedEvent<
  [string, BigNumber],
  InterestUBIMintedEventObject
>;

export type InterestUBIMintedEventFilter =
  TypedEventFilter<InterestUBIMintedEvent>;

export interface ReserveUpdatedEventObject {
  reserve: string;
}
export type ReserveUpdatedEvent = TypedEvent<
  [string],
  ReserveUpdatedEventObject
>;

export type ReserveUpdatedEventFilter = TypedEventFilter<ReserveUpdatedEvent>;

export interface RewardMintedEventObject {
  exchangeId: string;
  to: string;
  amount: BigNumber;
}
export type RewardMintedEvent = TypedEvent<
  [string, string, BigNumber],
  RewardMintedEventObject
>;

export type RewardMintedEventFilter = TypedEventFilter<RewardMintedEvent>;

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

  interface: IGoodDollarExpansionControllerInterface;

  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: {
    initialize(
      _goodDollarExchangeProvider: string,
      _distributionHelper: string,
      _reserve: string,
      _avatar: string,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    mintRewardFromRR(
      exchangeId: BytesLike,
      to: string,
      amount: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    mintUBIFromExpansion(
      exchangeId: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    mintUBIFromInterest(
      exchangeId: BytesLike,
      reserveInterest: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    mintUBIFromReserveBalance(
      exchangeId: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

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

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

    setExpansionConfig(
      exchangeId: BytesLike,
      expansionRate: BigNumberish,
      expansionFrequency: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

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

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

  initialize(
    _goodDollarExchangeProvider: string,
    _distributionHelper: string,
    _reserve: string,
    _avatar: string,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  mintRewardFromRR(
    exchangeId: BytesLike,
    to: string,
    amount: BigNumberish,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  mintUBIFromExpansion(
    exchangeId: BytesLike,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  mintUBIFromInterest(
    exchangeId: BytesLike,
    reserveInterest: BigNumberish,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  mintUBIFromReserveBalance(
    exchangeId: BytesLike,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

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

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

  setExpansionConfig(
    exchangeId: BytesLike,
    expansionRate: BigNumberish,
    expansionFrequency: BigNumberish,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

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

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

  callStatic: {
    initialize(
      _goodDollarExchangeProvider: string,
      _distributionHelper: string,
      _reserve: string,
      _avatar: string,
      overrides?: CallOverrides
    ): Promise<void>;

    mintRewardFromRR(
      exchangeId: BytesLike,
      to: string,
      amount: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    mintUBIFromExpansion(
      exchangeId: BytesLike,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    mintUBIFromInterest(
      exchangeId: BytesLike,
      reserveInterest: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    mintUBIFromReserveBalance(
      exchangeId: BytesLike,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    setAvatar(_avatar: string, overrides?: CallOverrides): Promise<void>;

    setDistributionHelper(
      _distributionHelper: string,
      overrides?: CallOverrides
    ): Promise<void>;

    setExpansionConfig(
      exchangeId: BytesLike,
      expansionRate: BigNumberish,
      expansionFrequency: BigNumberish,
      overrides?: CallOverrides
    ): Promise<void>;

    setGoodDollarExchangeProvider(
      _goodDollarExchangeProvider: string,
      overrides?: CallOverrides
    ): Promise<void>;

    setReserve(_reserve: string, overrides?: CallOverrides): Promise<void>;
  };

  filters: {
    "AvatarUpdated(address)"(avatar?: string | null): AvatarUpdatedEventFilter;
    AvatarUpdated(avatar?: string | null): AvatarUpdatedEventFilter;

    "DistributionHelperUpdated(address)"(
      distributionHelper?: string | null
    ): DistributionHelperUpdatedEventFilter;
    DistributionHelperUpdated(
      distributionHelper?: string | null
    ): DistributionHelperUpdatedEventFilter;

    "ExpansionConfigSet(bytes32,uint64,uint32)"(
      exchangeId?: BytesLike | null,
      expansionRate?: null,
      expansionfrequency?: null
    ): ExpansionConfigSetEventFilter;
    ExpansionConfigSet(
      exchangeId?: BytesLike | null,
      expansionRate?: null,
      expansionfrequency?: null
    ): ExpansionConfigSetEventFilter;

    "ExpansionUBIMinted(bytes32,uint256)"(
      exchangeId?: BytesLike | null,
      amount?: null
    ): ExpansionUBIMintedEventFilter;
    ExpansionUBIMinted(
      exchangeId?: BytesLike | null,
      amount?: null
    ): ExpansionUBIMintedEventFilter;

    "GoodDollarExchangeProviderUpdated(address)"(
      exchangeProvider?: string | null
    ): GoodDollarExchangeProviderUpdatedEventFilter;
    GoodDollarExchangeProviderUpdated(
      exchangeProvider?: string | null
    ): GoodDollarExchangeProviderUpdatedEventFilter;

    "InterestUBIMinted(bytes32,uint256)"(
      exchangeId?: BytesLike | null,
      amount?: null
    ): InterestUBIMintedEventFilter;
    InterestUBIMinted(
      exchangeId?: BytesLike | null,
      amount?: null
    ): InterestUBIMintedEventFilter;

    "ReserveUpdated(address)"(
      reserve?: string | null
    ): ReserveUpdatedEventFilter;
    ReserveUpdated(reserve?: string | null): ReserveUpdatedEventFilter;

    "RewardMinted(bytes32,address,uint256)"(
      exchangeId?: BytesLike | null,
      to?: string | null,
      amount?: null
    ): RewardMintedEventFilter;
    RewardMinted(
      exchangeId?: BytesLike | null,
      to?: string | null,
      amount?: null
    ): RewardMintedEventFilter;
  };

  estimateGas: {
    initialize(
      _goodDollarExchangeProvider: string,
      _distributionHelper: string,
      _reserve: string,
      _avatar: string,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    mintRewardFromRR(
      exchangeId: BytesLike,
      to: string,
      amount: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    mintUBIFromExpansion(
      exchangeId: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    mintUBIFromInterest(
      exchangeId: BytesLike,
      reserveInterest: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    mintUBIFromReserveBalance(
      exchangeId: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

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

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

    setExpansionConfig(
      exchangeId: BytesLike,
      expansionRate: BigNumberish,
      expansionFrequency: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

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

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

  populateTransaction: {
    initialize(
      _goodDollarExchangeProvider: string,
      _distributionHelper: string,
      _reserve: string,
      _avatar: string,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    mintRewardFromRR(
      exchangeId: BytesLike,
      to: string,
      amount: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    mintUBIFromExpansion(
      exchangeId: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    mintUBIFromInterest(
      exchangeId: BytesLike,
      reserveInterest: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    mintUBIFromReserveBalance(
      exchangeId: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

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

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

    setExpansionConfig(
      exchangeId: BytesLike,
      expansionRate: BigNumberish,
      expansionFrequency: BigNumberish,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

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

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