@cartesi/staking-pool/dist/src/types/IStaking.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,
  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 IStakingInterface extends ethers.utils.Interface {
  functions: {
    "getMaturingBalance(address)": FunctionFragment;
    "getMaturingTimestamp(address)": FunctionFragment;
    "getReleasingBalance(address)": FunctionFragment;
    "getReleasingTimestamp(address)": FunctionFragment;
    "getStakedBalance(address)": FunctionFragment;
    "stake(uint256)": FunctionFragment;
    "unstake(uint256)": FunctionFragment;
    "withdraw(uint256)": FunctionFragment;
  };

  encodeFunctionData(
    functionFragment: "getMaturingBalance",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "getMaturingTimestamp",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "getReleasingBalance",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "getReleasingTimestamp",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "getStakedBalance",
    values: [string]
  ): string;
  encodeFunctionData(functionFragment: "stake", values: [BigNumberish]): string;
  encodeFunctionData(
    functionFragment: "unstake",
    values: [BigNumberish]
  ): string;
  encodeFunctionData(
    functionFragment: "withdraw",
    values: [BigNumberish]
  ): string;

  decodeFunctionResult(
    functionFragment: "getMaturingBalance",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getMaturingTimestamp",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getReleasingBalance",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getReleasingTimestamp",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getStakedBalance",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "stake", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "unstake", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "withdraw", data: BytesLike): Result;

  events: {
    "Stake(address,uint256,uint256)": EventFragment;
    "Unstake(address,uint256,uint256)": EventFragment;
    "Withdraw(address,uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "Stake"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Unstake"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "Withdraw"): EventFragment;
}

export type StakeEvent = TypedEvent<
  [string, BigNumber, BigNumber] & {
    user: string;
    amount: BigNumber;
    maturationDate: BigNumber;
  }
>;

export type UnstakeEvent = TypedEvent<
  [string, BigNumber, BigNumber] & {
    user: string;
    amount: BigNumber;
    maturationDate: BigNumber;
  }
>;

export type WithdrawEvent = TypedEvent<
  [string, BigNumber] & { user: string; amount: BigNumber }
>;

export class IStaking 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: IStakingInterface;

  functions: {
    getMaturingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    getMaturingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    getReleasingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    getReleasingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    getStakedBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber]>;

    stake(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    unstake(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;

    withdraw(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<ContractTransaction>;
  };

  getMaturingBalance(
    _userAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  getMaturingTimestamp(
    _userAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  getReleasingBalance(
    _userAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  getReleasingTimestamp(
    _userAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  getStakedBalance(
    _userAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

  stake(
    _amount: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  unstake(
    _amount: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  withdraw(
    _amount: BigNumberish,
    overrides?: Overrides & { from?: string | Promise<string> }
  ): Promise<ContractTransaction>;

  callStatic: {
    getMaturingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getMaturingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getReleasingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getReleasingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getStakedBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    stake(_amount: BigNumberish, overrides?: CallOverrides): Promise<void>;

    unstake(_amount: BigNumberish, overrides?: CallOverrides): Promise<void>;

    withdraw(_amount: BigNumberish, overrides?: CallOverrides): Promise<void>;
  };

  filters: {
    "Stake(address,uint256,uint256)"(
      user?: string | null,
      amount?: null,
      maturationDate?: null
    ): TypedEventFilter<
      [string, BigNumber, BigNumber],
      { user: string; amount: BigNumber; maturationDate: BigNumber }
    >;

    Stake(
      user?: string | null,
      amount?: null,
      maturationDate?: null
    ): TypedEventFilter<
      [string, BigNumber, BigNumber],
      { user: string; amount: BigNumber; maturationDate: BigNumber }
    >;

    "Unstake(address,uint256,uint256)"(
      user?: string | null,
      amount?: null,
      maturationDate?: null
    ): TypedEventFilter<
      [string, BigNumber, BigNumber],
      { user: string; amount: BigNumber; maturationDate: BigNumber }
    >;

    Unstake(
      user?: string | null,
      amount?: null,
      maturationDate?: null
    ): TypedEventFilter<
      [string, BigNumber, BigNumber],
      { user: string; amount: BigNumber; maturationDate: BigNumber }
    >;

    "Withdraw(address,uint256)"(
      user?: string | null,
      amount?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { user: string; amount: BigNumber }
    >;

    Withdraw(
      user?: string | null,
      amount?: null
    ): TypedEventFilter<
      [string, BigNumber],
      { user: string; amount: BigNumber }
    >;
  };

  estimateGas: {
    getMaturingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getMaturingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getReleasingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getReleasingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    getStakedBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    stake(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    unstake(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;

    withdraw(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    getMaturingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getMaturingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getReleasingBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getReleasingTimestamp(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    getStakedBalance(
      _userAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    stake(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    unstake(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;

    withdraw(
      _amount: BigNumberish,
      overrides?: Overrides & { from?: string | Promise<string> }
    ): Promise<PopulatedTransaction>;
  };
}