@credenza-web3/contracts/typechain-types/contracts/membership/IPFSMetadataMembershipContract.ts

Credenza Contracts

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

export interface IPFSMetadataMembershipContractInterface
  extends utils.Interface {
  functions: {
    "addMembership(address,string,string)": FunctionFragment;
    "addMembership(address,string)": FunctionFragment;
    "addOwner(address)": FunctionFragment;
    "clearOwners()": FunctionFragment;
    "confirmMembership(address)": FunctionFragment;
    "getDescription()": FunctionFragment;
    "getMembershipFile(address)": FunctionFragment;
    "getMembershipMetadata(address)": FunctionFragment;
    "getOwners()": FunctionFragment;
    "getTrustedForwarder()": FunctionFragment;
    "getVersion()": FunctionFragment;
    "isOwner(address)": FunctionFragment;
    "isTrustedForwarder(address)": FunctionFragment;
    "removeMembership(address)": FunctionFragment;
    "removeOwner(address)": FunctionFragment;
    "setDescription(string)": FunctionFragment;
    "setTrustedForwarder(address)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "addMembership(address,string,string)"
      | "addMembership(address,string)"
      | "addOwner"
      | "clearOwners"
      | "confirmMembership"
      | "getDescription"
      | "getMembershipFile"
      | "getMembershipMetadata"
      | "getOwners"
      | "getTrustedForwarder"
      | "getVersion"
      | "isOwner"
      | "isTrustedForwarder"
      | "removeMembership"
      | "removeOwner"
      | "setDescription"
      | "setTrustedForwarder"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "addMembership(address,string,string)",
    values: [
      PromiseOrValue<string>,
      PromiseOrValue<string>,
      PromiseOrValue<string>
    ]
  ): string;
  encodeFunctionData(
    functionFragment: "addMembership(address,string)",
    values: [PromiseOrValue<string>, PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "addOwner",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "clearOwners",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "confirmMembership",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "getDescription",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getMembershipFile",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "getMembershipMetadata",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(functionFragment: "getOwners", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "getTrustedForwarder",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getVersion",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "isOwner",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "isTrustedForwarder",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "removeMembership",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "removeOwner",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "setDescription",
    values: [PromiseOrValue<string>]
  ): string;
  encodeFunctionData(
    functionFragment: "setTrustedForwarder",
    values: [PromiseOrValue<string>]
  ): string;

  decodeFunctionResult(
    functionFragment: "addMembership(address,string,string)",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "addMembership(address,string)",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "addOwner", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "clearOwners",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "confirmMembership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getDescription",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getMembershipFile",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getMembershipMetadata",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "getOwners", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "getTrustedForwarder",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "getVersion", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "isOwner", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "isTrustedForwarder",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "removeMembership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "removeOwner",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setDescription",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setTrustedForwarder",
    data: BytesLike
  ): Result;

  events: {
    "MembershipAdded(address,address)": EventFragment;
    "MembershipRemoved(address,address)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "MembershipAdded"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "MembershipRemoved"): EventFragment;
}

export interface MembershipAddedEventObject {
  owner: string;
  target: string;
}
export type MembershipAddedEvent = TypedEvent<
  [string, string],
  MembershipAddedEventObject
>;

export type MembershipAddedEventFilter = TypedEventFilter<MembershipAddedEvent>;

export interface MembershipRemovedEventObject {
  owner: string;
  target: string;
}
export type MembershipRemovedEvent = TypedEvent<
  [string, string],
  MembershipRemovedEventObject
>;

export type MembershipRemovedEventFilter =
  TypedEventFilter<MembershipRemovedEvent>;

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

  interface: IPFSMetadataMembershipContractInterface;

  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: {
    "addMembership(address,string,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      file: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    "addMembership(address,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    addOwner(
      newOwner: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

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

    confirmMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

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

    getMembershipFile(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<[string]>;

    getMembershipMetadata(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<[string]>;

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

    getTrustedForwarder(
      overrides?: CallOverrides
    ): Promise<[string] & { forwarder: string }>;

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

    isOwner(
      addr: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

    isTrustedForwarder(
      forwarder: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

    removeMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    removeOwner(
      owner: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    setDescription(
      description: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    setTrustedForwarder(
      _forwarder: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;
  };

  "addMembership(address,string,string)"(
    customerAddress: PromiseOrValue<string>,
    metadata: PromiseOrValue<string>,
    file: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  "addMembership(address,string)"(
    customerAddress: PromiseOrValue<string>,
    metadata: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  addOwner(
    newOwner: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

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

  confirmMembership(
    customerAddress: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<boolean>;

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

  getMembershipFile(
    customerAddress: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<string>;

  getMembershipMetadata(
    customerAddress: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<string>;

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

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

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

  isOwner(
    addr: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<boolean>;

  isTrustedForwarder(
    forwarder: PromiseOrValue<string>,
    overrides?: CallOverrides
  ): Promise<boolean>;

  removeMembership(
    customerAddress: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  removeOwner(
    owner: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  setDescription(
    description: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  setTrustedForwarder(
    _forwarder: PromiseOrValue<string>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  callStatic: {
    "addMembership(address,string,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      file: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    "addMembership(address,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    addOwner(
      newOwner: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

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

    confirmMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<boolean>;

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

    getMembershipFile(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<string>;

    getMembershipMetadata(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<string>;

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

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

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

    isOwner(
      addr: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<boolean>;

    isTrustedForwarder(
      forwarder: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<boolean>;

    removeMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    removeOwner(
      owner: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    setDescription(
      description: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;

    setTrustedForwarder(
      _forwarder: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "MembershipAdded(address,address)"(
      owner?: PromiseOrValue<string> | null,
      target?: PromiseOrValue<string> | null
    ): MembershipAddedEventFilter;
    MembershipAdded(
      owner?: PromiseOrValue<string> | null,
      target?: PromiseOrValue<string> | null
    ): MembershipAddedEventFilter;

    "MembershipRemoved(address,address)"(
      owner?: PromiseOrValue<string> | null,
      target?: PromiseOrValue<string> | null
    ): MembershipRemovedEventFilter;
    MembershipRemoved(
      owner?: PromiseOrValue<string> | null,
      target?: PromiseOrValue<string> | null
    ): MembershipRemovedEventFilter;
  };

  estimateGas: {
    "addMembership(address,string,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      file: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    "addMembership(address,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    addOwner(
      newOwner: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

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

    confirmMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    getMembershipFile(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getMembershipMetadata(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

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

    isOwner(
      addr: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    isTrustedForwarder(
      forwarder: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    removeMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    removeOwner(
      owner: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    setDescription(
      description: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    setTrustedForwarder(
      _forwarder: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    "addMembership(address,string,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      file: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    "addMembership(address,string)"(
      customerAddress: PromiseOrValue<string>,
      metadata: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    addOwner(
      newOwner: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

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

    confirmMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    getMembershipFile(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getMembershipMetadata(
      customerAddress: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

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

    isOwner(
      addr: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    isTrustedForwarder(
      forwarder: PromiseOrValue<string>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    removeMembership(
      customerAddress: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    removeOwner(
      owner: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    setDescription(
      description: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    setTrustedForwarder(
      _forwarder: PromiseOrValue<string>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;
  };
}