@river-build/generated/dev/typings/IChannel.ts

## How to generate contract types

/* 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,
  PromiseOrValue,
} from "./common";

export declare namespace IChannelBase {
  export type RolePermissionsStruct = {
    roleId: PromiseOrValue<BigNumberish>;
    permissions: PromiseOrValue<string>[];
  };

  export type RolePermissionsStructOutput = [BigNumber, string[]] & {
    roleId: BigNumber;
    permissions: string[];
  };

  export type ChannelStruct = {
    id: PromiseOrValue<BytesLike>;
    disabled: PromiseOrValue<boolean>;
    metadata: PromiseOrValue<string>;
    roleIds: PromiseOrValue<BigNumberish>[];
  };

  export type ChannelStructOutput = [string, boolean, string, BigNumber[]] & {
    id: string;
    disabled: boolean;
    metadata: string;
    roleIds: BigNumber[];
  };
}

export interface IChannelInterface extends utils.Interface {
  functions: {
    "addRoleToChannel(bytes32,uint256)": FunctionFragment;
    "createChannel(bytes32,string,uint256[])": FunctionFragment;
    "createChannelWithOverridePermissions(bytes32,string,(uint256,string[])[])": FunctionFragment;
    "getChannel(bytes32)": FunctionFragment;
    "getChannels()": FunctionFragment;
    "getRolesByChannel(bytes32)": FunctionFragment;
    "removeChannel(bytes32)": FunctionFragment;
    "removeRoleFromChannel(bytes32,uint256)": FunctionFragment;
    "updateChannel(bytes32,string,bool)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "addRoleToChannel"
      | "createChannel"
      | "createChannelWithOverridePermissions"
      | "getChannel"
      | "getChannels"
      | "getRolesByChannel"
      | "removeChannel"
      | "removeRoleFromChannel"
      | "updateChannel"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "addRoleToChannel",
    values: [PromiseOrValue<BytesLike>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "createChannel",
    values: [
      PromiseOrValue<BytesLike>,
      PromiseOrValue<string>,
      PromiseOrValue<BigNumberish>[]
    ]
  ): string;
  encodeFunctionData(
    functionFragment: "createChannelWithOverridePermissions",
    values: [
      PromiseOrValue<BytesLike>,
      PromiseOrValue<string>,
      IChannelBase.RolePermissionsStruct[]
    ]
  ): string;
  encodeFunctionData(
    functionFragment: "getChannel",
    values: [PromiseOrValue<BytesLike>]
  ): string;
  encodeFunctionData(
    functionFragment: "getChannels",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "getRolesByChannel",
    values: [PromiseOrValue<BytesLike>]
  ): string;
  encodeFunctionData(
    functionFragment: "removeChannel",
    values: [PromiseOrValue<BytesLike>]
  ): string;
  encodeFunctionData(
    functionFragment: "removeRoleFromChannel",
    values: [PromiseOrValue<BytesLike>, PromiseOrValue<BigNumberish>]
  ): string;
  encodeFunctionData(
    functionFragment: "updateChannel",
    values: [
      PromiseOrValue<BytesLike>,
      PromiseOrValue<string>,
      PromiseOrValue<boolean>
    ]
  ): string;

  decodeFunctionResult(
    functionFragment: "addRoleToChannel",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "createChannel",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "createChannelWithOverridePermissions",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "getChannel", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "getChannels",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getRolesByChannel",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "removeChannel",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "removeRoleFromChannel",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "updateChannel",
    data: BytesLike
  ): Result;

  events: {
    "ChannelCreated(address,bytes32)": EventFragment;
    "ChannelRemoved(address,bytes32)": EventFragment;
    "ChannelRoleAdded(address,bytes32,uint256)": EventFragment;
    "ChannelRoleRemoved(address,bytes32,uint256)": EventFragment;
    "ChannelUpdated(address,bytes32)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "ChannelCreated"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ChannelRemoved"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ChannelRoleAdded"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ChannelRoleRemoved"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ChannelUpdated"): EventFragment;
}

export interface ChannelCreatedEventObject {
  caller: string;
  channelId: string;
}
export type ChannelCreatedEvent = TypedEvent<
  [string, string],
  ChannelCreatedEventObject
>;

export type ChannelCreatedEventFilter = TypedEventFilter<ChannelCreatedEvent>;

export interface ChannelRemovedEventObject {
  caller: string;
  channelId: string;
}
export type ChannelRemovedEvent = TypedEvent<
  [string, string],
  ChannelRemovedEventObject
>;

export type ChannelRemovedEventFilter = TypedEventFilter<ChannelRemovedEvent>;

export interface ChannelRoleAddedEventObject {
  caller: string;
  channelId: string;
  roleId: BigNumber;
}
export type ChannelRoleAddedEvent = TypedEvent<
  [string, string, BigNumber],
  ChannelRoleAddedEventObject
>;

export type ChannelRoleAddedEventFilter =
  TypedEventFilter<ChannelRoleAddedEvent>;

export interface ChannelRoleRemovedEventObject {
  caller: string;
  channelId: string;
  roleId: BigNumber;
}
export type ChannelRoleRemovedEvent = TypedEvent<
  [string, string, BigNumber],
  ChannelRoleRemovedEventObject
>;

export type ChannelRoleRemovedEventFilter =
  TypedEventFilter<ChannelRoleRemovedEvent>;

export interface ChannelUpdatedEventObject {
  caller: string;
  channelId: string;
}
export type ChannelUpdatedEvent = TypedEvent<
  [string, string],
  ChannelUpdatedEventObject
>;

export type ChannelUpdatedEventFilter = TypedEventFilter<ChannelUpdatedEvent>;

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

  interface: IChannelInterface;

  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: {
    addRoleToChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    createChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      roleIds: PromiseOrValue<BigNumberish>[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    createChannelWithOverridePermissions(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      rolePermissions: IChannelBase.RolePermissionsStruct[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    getChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<
      [IChannelBase.ChannelStructOutput] & {
        channel: IChannelBase.ChannelStructOutput;
      }
    >;

    getChannels(
      overrides?: CallOverrides
    ): Promise<
      [IChannelBase.ChannelStructOutput[]] & {
        channels: IChannelBase.ChannelStructOutput[];
      }
    >;

    getRolesByChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<[BigNumber[]] & { roleIds: BigNumber[] }>;

    removeChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    removeRoleFromChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;

    updateChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      disabled: PromiseOrValue<boolean>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<ContractTransaction>;
  };

  addRoleToChannel(
    channelId: PromiseOrValue<BytesLike>,
    roleId: PromiseOrValue<BigNumberish>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  createChannel(
    channelId: PromiseOrValue<BytesLike>,
    metadata: PromiseOrValue<string>,
    roleIds: PromiseOrValue<BigNumberish>[],
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  createChannelWithOverridePermissions(
    channelId: PromiseOrValue<BytesLike>,
    metadata: PromiseOrValue<string>,
    rolePermissions: IChannelBase.RolePermissionsStruct[],
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  getChannel(
    channelId: PromiseOrValue<BytesLike>,
    overrides?: CallOverrides
  ): Promise<IChannelBase.ChannelStructOutput>;

  getChannels(
    overrides?: CallOverrides
  ): Promise<IChannelBase.ChannelStructOutput[]>;

  getRolesByChannel(
    channelId: PromiseOrValue<BytesLike>,
    overrides?: CallOverrides
  ): Promise<BigNumber[]>;

  removeChannel(
    channelId: PromiseOrValue<BytesLike>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  removeRoleFromChannel(
    channelId: PromiseOrValue<BytesLike>,
    roleId: PromiseOrValue<BigNumberish>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  updateChannel(
    channelId: PromiseOrValue<BytesLike>,
    metadata: PromiseOrValue<string>,
    disabled: PromiseOrValue<boolean>,
    overrides?: Overrides & { from?: PromiseOrValue<string> }
  ): Promise<ContractTransaction>;

  callStatic: {
    addRoleToChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;

    createChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      roleIds: PromiseOrValue<BigNumberish>[],
      overrides?: CallOverrides
    ): Promise<void>;

    createChannelWithOverridePermissions(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      rolePermissions: IChannelBase.RolePermissionsStruct[],
      overrides?: CallOverrides
    ): Promise<void>;

    getChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<IChannelBase.ChannelStructOutput>;

    getChannels(
      overrides?: CallOverrides
    ): Promise<IChannelBase.ChannelStructOutput[]>;

    getRolesByChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<BigNumber[]>;

    removeChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<void>;

    removeRoleFromChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: CallOverrides
    ): Promise<void>;

    updateChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      disabled: PromiseOrValue<boolean>,
      overrides?: CallOverrides
    ): Promise<void>;
  };

  filters: {
    "ChannelCreated(address,bytes32)"(
      caller?: PromiseOrValue<string> | null,
      channelId?: null
    ): ChannelCreatedEventFilter;
    ChannelCreated(
      caller?: PromiseOrValue<string> | null,
      channelId?: null
    ): ChannelCreatedEventFilter;

    "ChannelRemoved(address,bytes32)"(
      caller?: PromiseOrValue<string> | null,
      channelId?: null
    ): ChannelRemovedEventFilter;
    ChannelRemoved(
      caller?: PromiseOrValue<string> | null,
      channelId?: null
    ): ChannelRemovedEventFilter;

    "ChannelRoleAdded(address,bytes32,uint256)"(
      caller?: PromiseOrValue<string> | null,
      channelId?: null,
      roleId?: null
    ): ChannelRoleAddedEventFilter;
    ChannelRoleAdded(
      caller?: PromiseOrValue<string> | null,
      channelId?: null,
      roleId?: null
    ): ChannelRoleAddedEventFilter;

    "ChannelRoleRemoved(address,bytes32,uint256)"(
      caller?: PromiseOrValue<string> | null,
      channelId?: null,
      roleId?: null
    ): ChannelRoleRemovedEventFilter;
    ChannelRoleRemoved(
      caller?: PromiseOrValue<string> | null,
      channelId?: null,
      roleId?: null
    ): ChannelRoleRemovedEventFilter;

    "ChannelUpdated(address,bytes32)"(
      caller?: PromiseOrValue<string> | null,
      channelId?: null
    ): ChannelUpdatedEventFilter;
    ChannelUpdated(
      caller?: PromiseOrValue<string> | null,
      channelId?: null
    ): ChannelUpdatedEventFilter;
  };

  estimateGas: {
    addRoleToChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    createChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      roleIds: PromiseOrValue<BigNumberish>[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    createChannelWithOverridePermissions(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      rolePermissions: IChannelBase.RolePermissionsStruct[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    getChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    getRolesByChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    removeChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    removeRoleFromChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;

    updateChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      disabled: PromiseOrValue<boolean>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    addRoleToChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    createChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      roleIds: PromiseOrValue<BigNumberish>[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    createChannelWithOverridePermissions(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      rolePermissions: IChannelBase.RolePermissionsStruct[],
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    getChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    getRolesByChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    removeChannel(
      channelId: PromiseOrValue<BytesLike>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    removeRoleFromChannel(
      channelId: PromiseOrValue<BytesLike>,
      roleId: PromiseOrValue<BigNumberish>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;

    updateChannel(
      channelId: PromiseOrValue<BytesLike>,
      metadata: PromiseOrValue<string>,
      disabled: PromiseOrValue<boolean>,
      overrides?: Overrides & { from?: PromiseOrValue<string> }
    ): Promise<PopulatedTransaction>;
  };
}