@gooddollar/goodprotocol/types/contracts/utils/OneTimePayments.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 OneTimePaymentsInterface extends utils.Interface {
  functions: {
    "avatar()": FunctionFragment;
    "cancel(address)": FunctionFragment;
    "dao()": FunctionFragment;
    "hasPayment(address)": FunctionFragment;
    "nameService()": FunctionFragment;
    "nativeToken()": FunctionFragment;
    "onTokenTransfer(address,uint256,bytes)": FunctionFragment;
    "payments(address)": FunctionFragment;
    "updateAvatar()": FunctionFragment;
    "withdraw(address,bytes)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "avatar"
      | "cancel"
      | "dao"
      | "hasPayment"
      | "nameService"
      | "nativeToken"
      | "onTokenTransfer"
      | "payments"
      | "updateAvatar"
      | "withdraw"
  ): FunctionFragment;

  encodeFunctionData(functionFragment: "avatar", values?: undefined): string;
  encodeFunctionData(functionFragment: "cancel", values: [string]): string;
  encodeFunctionData(functionFragment: "dao", values?: undefined): string;
  encodeFunctionData(functionFragment: "hasPayment", values: [string]): string;
  encodeFunctionData(
    functionFragment: "nameService",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "nativeToken",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "onTokenTransfer",
    values: [string, BigNumberish, BytesLike]
  ): string;
  encodeFunctionData(functionFragment: "payments", values: [string]): string;
  encodeFunctionData(
    functionFragment: "updateAvatar",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "withdraw",
    values: [string, BytesLike]
  ): string;

  decodeFunctionResult(functionFragment: "avatar", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "cancel", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "dao", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "hasPayment", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "nameService",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "nativeToken",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "onTokenTransfer",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "payments", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "updateAvatar",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "withdraw", data: BytesLike): Result;

  events: {
    "PaymentCancel(address,address,uint256)": EventFragment;
    "PaymentDeposit(address,address,uint256)": EventFragment;
    "PaymentWithdraw(address,address,address,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "PaymentCancel"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "PaymentDeposit"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "PaymentWithdraw"): EventFragment;
}

export interface PaymentCancelEventObject {
  from: string;
  paymentId: string;
  amount: BigNumber;
}
export type PaymentCancelEvent = TypedEvent<
  [string, string, BigNumber],
  PaymentCancelEventObject
>;

export type PaymentCancelEventFilter = TypedEventFilter<PaymentCancelEvent>;

export interface PaymentDepositEventObject {
  from: string;
  paymentId: string;
  amount: BigNumber;
}
export type PaymentDepositEvent = TypedEvent<
  [string, string, BigNumber],
  PaymentDepositEventObject
>;

export type PaymentDepositEventFilter = TypedEventFilter<PaymentDepositEvent>;

export interface PaymentWithdrawEventObject {
  from: string;
  to: string;
  paymentId: string;
  amount: BigNumber;
}
export type PaymentWithdrawEvent = TypedEvent<
  [string, string, string, BigNumber],
  PaymentWithdrawEventObject
>;

export type PaymentWithdrawEventFilter = TypedEventFilter<PaymentWithdrawEvent>;

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

  interface: OneTimePaymentsInterface;

  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]>;

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

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

    hasPayment(
      paymentId: string,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

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

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

    onTokenTransfer(
      sender: string,
      value: BigNumberish,
      data: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    payments(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<
      [boolean, BigNumber, string] & {
        hasPayment: boolean;
        paymentAmount: BigNumber;
        paymentSender: string;
      }
    >;

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

    withdraw(
      paymentId: string,
      signature: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;
  };

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

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

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

  hasPayment(paymentId: string, overrides?: CallOverrides): Promise<boolean>;

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

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

  onTokenTransfer(
    sender: string,
    value: BigNumberish,
    data: BytesLike,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  payments(
    arg0: string,
    overrides?: CallOverrides
  ): Promise<
    [boolean, BigNumber, string] & {
      hasPayment: boolean;
      paymentAmount: BigNumber;
      paymentSender: string;
    }
  >;

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

  withdraw(
    paymentId: string,
    signature: BytesLike,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

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

    cancel(paymentId: string, overrides?: CallOverrides): Promise<void>;

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

    hasPayment(paymentId: string, overrides?: CallOverrides): Promise<boolean>;

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

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

    onTokenTransfer(
      sender: string,
      value: BigNumberish,
      data: BytesLike,
      overrides?: CallOverrides
    ): Promise<boolean>;

    payments(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<
      [boolean, BigNumber, string] & {
        hasPayment: boolean;
        paymentAmount: BigNumber;
        paymentSender: string;
      }
    >;

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

    withdraw(
      paymentId: string,
      signature: BytesLike,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "PaymentCancel(address,address,uint256)"(
      from?: string | null,
      paymentId?: null,
      amount?: null
    ): PaymentCancelEventFilter;
    PaymentCancel(
      from?: string | null,
      paymentId?: null,
      amount?: null
    ): PaymentCancelEventFilter;

    "PaymentDeposit(address,address,uint256)"(
      from?: string | null,
      paymentId?: null,
      amount?: null
    ): PaymentDepositEventFilter;
    PaymentDeposit(
      from?: string | null,
      paymentId?: null,
      amount?: null
    ): PaymentDepositEventFilter;

    "PaymentWithdraw(address,address,address,uint256)"(
      from?: string | null,
      to?: string | null,
      paymentId?: string | null,
      amount?: null
    ): PaymentWithdrawEventFilter;
    PaymentWithdraw(
      from?: string | null,
      to?: string | null,
      paymentId?: string | null,
      amount?: null
    ): PaymentWithdrawEventFilter;
  };

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

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

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

    hasPayment(
      paymentId: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

    onTokenTransfer(
      sender: string,
      value: BigNumberish,
      data: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    payments(arg0: string, overrides?: CallOverrides): Promise<BigNumber>;

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

    withdraw(
      paymentId: string,
      signature: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;
  };

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

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

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

    hasPayment(
      paymentId: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

    onTokenTransfer(
      sender: string,
      value: BigNumberish,
      data: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    payments(
      arg0: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    withdraw(
      paymentId: string,
      signature: BytesLike,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;
  };
}