@cartesi/staking-pool/dist/src/types/StakingPoolFactoryImpl.d.ts

PoS Staking Pools

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

import {
  ethers,
  EventFilter,
  Signer,
  BigNumber,
  BigNumberish,
  PopulatedTransaction,
  BaseContract,
  ContractTransaction,
  Overrides,
  PayableOverrides,
  CallOverrides,
} from "ethers";
import { BytesLike } from "@ethersproject/bytes";
import { Listener, Provider } from "@ethersproject/providers";
import { FunctionFragment, EventFragment, Result } from "@ethersproject/abi";
import type { TypedEventFilter, TypedEvent, TypedListener } from "./common";

interface StakingPoolFactoryImplInterface extends ethers.utils.Interface {
  functions: {
    "createFlatRateCommission(uint256)": FunctionFragment;
    "createGasTaxCommission(uint256)": FunctionFragment;
    "feeRaiseTimeout()": FunctionFragment;
    "gasOracle()": FunctionFragment;
    "getPoS()": FunctionFragment;
    "maxFeePercentageRaise()": FunctionFragment;
    "maxGasRaise()": FunctionFragment;
    "owner()": FunctionFragment;
    "pause()": FunctionFragment;
    "paused()": FunctionFragment;
    "pos()": FunctionFragment;
    "priceOracle()": FunctionFragment;
    "referencePool()": FunctionFragment;
    "renounceOwnership()": FunctionFragment;
    "setPoSAddress(address)": FunctionFragment;
    "setReferencePool(address)": FunctionFragment;
    "transferOwnership(address)": FunctionFragment;
    "unpause()": FunctionFragment;
  };

  encodeFunctionData(
    functionFragment: "createFlatRateCommission",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "createGasTaxCommission",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "feeRaiseTimeout",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "gasOracle", values?: undefined): string;
  encodeFunctionData(functionFragment: "getPoS", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "maxFeePercentageRaise",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "maxGasRaise",
    values?: undefined
  ): string;
  encodeFunctionData(functionFragment: "owner", values?: undefined): string;
  encodeFunctionData(functionFragment: "pause", values?: undefined): string;
  encodeFunctionData(functionFragment: "paused", values?: undefined): string;
  encodeFunctionData(functionFragment: "pos", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "priceOracle",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "referencePool",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "renounceOwnership",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "setPoSAddress",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "setReferencePool",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "transferOwnership",
    values: [string]
  ): string;
  encodeFunctionData(functionFragment: "unpause", values?: undefined): string;

  decodeFunctionResult(
    functionFragment: "createFlatRateCommission",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "createGasTaxCommission",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "feeRaiseTimeout",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "gasOracle", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "getPoS", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "maxFeePercentageRaise",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "maxGasRaise",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "pause", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "paused", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "pos", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "priceOracle",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "referencePool",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "renounceOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setPoSAddress",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setReferencePool",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "transferOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "unpause", data: BytesLike): Result;

  events: {
    "NewFlatRateCommissionStakingPool(address,address)": EventFragment;
    "NewGasTaxCommissionStakingPool(address,address)": EventFragment;
    "OwnershipTransferred(address,address)": EventFragment;
    "Paused(address)": EventFragment;
    "PoSAddressChanged(address)": EventFragment;
    "ReferencePoolChanged(address)": EventFragment;
    "Unpaused(address)": EventFragment;
  };

  getEvent(
    nameOrSignatureOrTopic: "NewFlatRateCommissionStakingPool"
  ): EventFragment;
  getEvent(
    nameOrSignatureOrTopic: "NewGasTaxCommissionStakingPool"
  ): EventFragment;
  getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Paused"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "PoSAddressChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "ReferencePoolChanged"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Unpaused"): EventFragment;
}

export type NewFlatRateCommissionStakingPoolEvent = TypedEvent<
  [string, string] & { pool: string; fee: string }
>;

export type NewGasTaxCommissionStakingPoolEvent = TypedEvent<
  [string, string] & { pool: string; fee: string }
>;

export type OwnershipTransferredEvent = TypedEvent<
  [string, string] & { previousOwner: string; newOwner: string }
>;

export type PausedEvent = TypedEvent<[string] & { account: string }>;

export type PoSAddressChangedEvent = TypedEvent<[string] & { _pos: string }>;

export type ReferencePoolChangedEvent = TypedEvent<[string] & { pool: string }>;

export type UnpausedEvent = TypedEvent<[string] & { account: string }>;

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

  listeners<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter?: TypedEventFilter<EventArgsArray, EventArgsObject>
  ): Array<TypedListener<EventArgsArray, EventArgsObject>>;
  off<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  on<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  once<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  removeListener<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>,
    listener: TypedListener<EventArgsArray, EventArgsObject>
  ): this;
  removeAllListeners<EventArgsArray extends Array<any>, EventArgsObject>(
    eventFilter: TypedEventFilter<EventArgsArray, EventArgsObject>
  ): this;

  listeners(eventName?: string): Array<Listener>;
  off(eventName: string, listener: Listener): this;
  on(eventName: string, listener: Listener): this;
  once(eventName: string, listener: Listener): this;
  removeListener(eventName: string, listener: Listener): this;
  removeAllListeners(eventName?: string): this;

  queryFilter<EventArgsArray extends Array<any>, EventArgsObject>(
    event: TypedEventFilter<EventArgsArray, EventArgsObject>,
    fromBlockOrBlockhash?: string | number | undefined,
    toBlock?: string | number | undefined
  ): Promise<Array<TypedEvent<EventArgsArray & EventArgsObject>>>;

  interface: StakingPoolFactoryImplInterface;

  functions: {
    createFlatRateCommission(
      commission: BigNumberish,
      overrides?: PayableOverrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    createGasTaxCommission(
      gas: BigNumberish,
      overrides?: PayableOverrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    feeRaiseTimeout(overrides?: CallOverrides): Promise<[BigNumber]>;

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

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

    maxFeePercentageRaise(overrides?: CallOverrides): Promise<[BigNumber]>;

    maxGasRaise(overrides?: CallOverrides): Promise<[BigNumber]>;

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

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

    paused(overrides?: CallOverrides): Promise<[boolean]>;

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

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

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

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

    setPoSAddress(
      _pos: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    setReferencePool(
      _referencePool: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

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

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

  createFlatRateCommission(
    commission: BigNumberish,
    overrides?: PayableOverrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  createGasTaxCommission(
    gas: BigNumberish,
    overrides?: PayableOverrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

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

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

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

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

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

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

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

  paused(overrides?: CallOverrides): Promise<boolean>;

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

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

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

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

  setPoSAddress(
    _pos: string,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  setReferencePool(
    _referencePool: string,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

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

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

  callStatic: {
    createFlatRateCommission(
      commission: BigNumberish,
      overrides?: CallOverrides
    ): Promise<string>;

    createGasTaxCommission(
      gas: BigNumberish,
      overrides?: CallOverrides
    ): Promise<string>;

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

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

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

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

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

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

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

    paused(overrides?: CallOverrides): Promise<boolean>;

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

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

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

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

    setPoSAddress(_pos: string, overrides?: CallOverrides): Promise<void>;

    setReferencePool(
      _referencePool: string,
      overrides?: CallOverrides
    ): Promise<void>;

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

    unpause(overrides?: CallOverrides): Promise<void>;
  };

  filters: {
    "NewFlatRateCommissionStakingPool(address,address)"(
      pool?: string | null,
      fee?: null
    ): TypedEventFilter<[string, string], { pool: string; fee: string }>;

    NewFlatRateCommissionStakingPool(
      pool?: string | null,
      fee?: null
    ): TypedEventFilter<[string, string], { pool: string; fee: string }>;

    "NewGasTaxCommissionStakingPool(address,address)"(
      pool?: string | null,
      fee?: null
    ): TypedEventFilter<[string, string], { pool: string; fee: string }>;

    NewGasTaxCommissionStakingPool(
      pool?: string | null,
      fee?: null
    ): TypedEventFilter<[string, string], { pool: string; fee: string }>;

    "OwnershipTransferred(address,address)"(
      previousOwner?: string | null,
      newOwner?: string | null
    ): TypedEventFilter<
      [string, string],
      { previousOwner: string; newOwner: string }
    >;

    OwnershipTransferred(
      previousOwner?: string | null,
      newOwner?: string | null
    ): TypedEventFilter<
      [string, string],
      { previousOwner: string; newOwner: string }
    >;

    "Paused(address)"(
      account?: null
    ): TypedEventFilter<[string], { account: string }>;

    Paused(account?: null): TypedEventFilter<[string], { account: string }>;

    "PoSAddressChanged(address)"(
      _pos?: string | null
    ): TypedEventFilter<[string], { _pos: string }>;

    PoSAddressChanged(
      _pos?: string | null
    ): TypedEventFilter<[string], { _pos: string }>;

    "ReferencePoolChanged(address)"(
      pool?: string | null
    ): TypedEventFilter<[string], { pool: string }>;

    ReferencePoolChanged(
      pool?: string | null
    ): TypedEventFilter<[string], { pool: string }>;

    "Unpaused(address)"(
      account?: null
    ): TypedEventFilter<[string], { account: string }>;

    Unpaused(account?: null): TypedEventFilter<[string], { account: string }>;
  };

  estimateGas: {
    createFlatRateCommission(
      commission: BigNumberish,
      overrides?: PayableOverrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    createGasTaxCommission(
      gas: BigNumberish,
      overrides?: PayableOverrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

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

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

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

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

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

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

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

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

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

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

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

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

    setPoSAddress(
      _pos: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    setReferencePool(
      _referencePool: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

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

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

  populateTransaction: {
    createFlatRateCommission(
      commission: BigNumberish,
      overrides?: PayableOverrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    createGasTaxCommission(
      gas: BigNumberish,
      overrides?: PayableOverrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

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

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

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

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

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

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

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

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

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

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

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

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

    setPoSAddress(
      _pos: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    setReferencePool(
      _referencePool: string,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

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

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