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

import type BN from "bn.js";
import type { ContractOptions } from "web3-eth-contract";
import type { EventLog } from "web3-core";
import type { EventEmitter } from "events";
import type {
  Callback,
  PayableTransactionObject,
  NonPayableTransactionObject,
  BlockType,
  ContractEventLog,
  BaseContract,
} from "./types";

export interface EventOptions {
  filter?: object;
  fromBlock?: BlockType;
  topics?: string[];
}

export type ContractSponsorRemoved = ContractEventLog<{
  contractAddress: string;
  0: string;
}>;
export type ContractSponsorSet = ContractEventLog<{
  contractAddress: string;
  sponsor: string;
  0: string;
  1: string;
}>;
export type ContractSponsorshipConfirmed = ContractEventLog<{
  contractAddress: string;
  sponsor: string;
  0: string;
  1: string;
}>;

export interface ContractHelpers extends BaseContract {
  constructor(
    jsonInterface: any[],
    address?: string,
    options?: ContractOptions
  ): ContractHelpers;
  clone(): ContractHelpers;
  methods: {
    allowed(
      contractAddress: string,
      user: string
    ): NonPayableTransactionObject<boolean>;

    allowlistEnabled(
      contractAddress: string
    ): NonPayableTransactionObject<boolean>;

    confirmSponsorship(
      contractAddress: string
    ): NonPayableTransactionObject<void>;

    contractOwner(contractAddress: string): NonPayableTransactionObject<string>;

    hasPendingSponsor(
      contractAddress: string
    ): NonPayableTransactionObject<boolean>;

    hasSponsor(contractAddress: string): NonPayableTransactionObject<boolean>;

    removeSponsor(contractAddress: string): NonPayableTransactionObject<void>;

    selfSponsoredEnable(
      contractAddress: string
    ): NonPayableTransactionObject<void>;

    setSponsor(
      contractAddress: string,
      sponsor: string
    ): NonPayableTransactionObject<void>;

    setSponsoringFeeLimit(
      contractAddress: string,
      feeLimit: number | string | BN
    ): NonPayableTransactionObject<void>;

    setSponsoringMode(
      contractAddress: string,
      mode: number | string | BN
    ): NonPayableTransactionObject<void>;

    setSponsoringRateLimit(
      contractAddress: string,
      rateLimit: number | string | BN
    ): NonPayableTransactionObject<void>;

    sponsor(
      contractAddress: string
    ): NonPayableTransactionObject<[boolean, [string, string]]>;

    sponsoringEnabled(
      contractAddress: string
    ): NonPayableTransactionObject<boolean>;

    sponsoringFeeLimit(
      contractAddress: string
    ): NonPayableTransactionObject<string>;

    sponsoringRateLimit(
      contractAddress: string
    ): NonPayableTransactionObject<string>;

    supportsInterface(
      interfaceID: string | number[]
    ): NonPayableTransactionObject<boolean>;

    toggleAllowed(
      contractAddress: string,
      user: string,
      isAllowed: boolean
    ): NonPayableTransactionObject<void>;

    toggleAllowlist(
      contractAddress: string,
      enabled: boolean
    ): NonPayableTransactionObject<void>;
  };
  events: {
    ContractSponsorRemoved(cb?: Callback<ContractSponsorRemoved>): EventEmitter;
    ContractSponsorRemoved(
      options?: EventOptions,
      cb?: Callback<ContractSponsorRemoved>
    ): EventEmitter;

    ContractSponsorSet(cb?: Callback<ContractSponsorSet>): EventEmitter;
    ContractSponsorSet(
      options?: EventOptions,
      cb?: Callback<ContractSponsorSet>
    ): EventEmitter;

    ContractSponsorshipConfirmed(
      cb?: Callback<ContractSponsorshipConfirmed>
    ): EventEmitter;
    ContractSponsorshipConfirmed(
      options?: EventOptions,
      cb?: Callback<ContractSponsorshipConfirmed>
    ): EventEmitter;

    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
  };

  once(
    event: "ContractSponsorRemoved",
    cb: Callback<ContractSponsorRemoved>
  ): void;
  once(
    event: "ContractSponsorRemoved",
    options: EventOptions,
    cb: Callback<ContractSponsorRemoved>
  ): void;

  once(event: "ContractSponsorSet", cb: Callback<ContractSponsorSet>): void;
  once(
    event: "ContractSponsorSet",
    options: EventOptions,
    cb: Callback<ContractSponsorSet>
  ): void;

  once(
    event: "ContractSponsorshipConfirmed",
    cb: Callback<ContractSponsorshipConfirmed>
  ): void;
  once(
    event: "ContractSponsorshipConfirmed",
    options: EventOptions,
    cb: Callback<ContractSponsorshipConfirmed>
  ): void;
}