@collabland/staking-contracts/src/types/PlanetxStakingV1.ts

Staking contracts supported by Collab.Land

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

export interface PlanetxStakingV1Interface extends utils.Interface {
  functions: {
    "getStakedTokens(address)": FunctionFragment;
    "getStakedTokens(address,address)": FunctionFragment;
    "isContractSupported(address)": FunctionFragment;
    "onERC721Received(address,address,uint256,bytes)": FunctionFragment;
    "owner()": FunctionFragment;
    "renounceOwnership()": FunctionFragment;
    "setSupportedContract(address,bool)": FunctionFragment;
    "stake(address,uint256[])": FunctionFragment;
    "stakeCountsPerContract(address)": FunctionFragment;
    "transferOwnership(address)": FunctionFragment;
    "unstake(address,uint256[])": FunctionFragment;
    "vaults(address,uint256)": FunctionFragment;
  };

  getFunction(
    nameOrSignatureOrTopic:
      | "getStakedTokens(address)"
      | "getStakedTokens(address,address)"
      | "isContractSupported"
      | "onERC721Received"
      | "owner"
      | "renounceOwnership"
      | "setSupportedContract"
      | "stake"
      | "stakeCountsPerContract"
      | "transferOwnership"
      | "unstake"
      | "vaults"
  ): FunctionFragment;

  encodeFunctionData(
    functionFragment: "getStakedTokens(address)",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "getStakedTokens(address,address)",
    values: [string, string]
  ): string;
  encodeFunctionData(
    functionFragment: "isContractSupported",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "onERC721Received",
    values: [string, string, BigNumberish, BytesLike]
  ): string;
  encodeFunctionData(functionFragment: "owner", values?: undefined): string;
  encodeFunctionData(
    functionFragment: "renounceOwnership",
    values?: undefined
  ): string;
  encodeFunctionData(
    functionFragment: "setSupportedContract",
    values: [string, boolean]
  ): string;
  encodeFunctionData(
    functionFragment: "stake",
    values: [string, BigNumberish[]]
  ): string;
  encodeFunctionData(
    functionFragment: "stakeCountsPerContract",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "transferOwnership",
    values: [string]
  ): string;
  encodeFunctionData(
    functionFragment: "unstake",
    values: [string, BigNumberish[]]
  ): string;
  encodeFunctionData(
    functionFragment: "vaults",
    values: [string, BigNumberish]
  ): string;

  decodeFunctionResult(
    functionFragment: "getStakedTokens(address)",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "getStakedTokens(address,address)",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "isContractSupported",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "onERC721Received",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "renounceOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "setSupportedContract",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "stake", data: BytesLike): Result;
  decodeFunctionResult(
    functionFragment: "stakeCountsPerContract",
    data: BytesLike
  ): Result;
  decodeFunctionResult(
    functionFragment: "transferOwnership",
    data: BytesLike
  ): Result;
  decodeFunctionResult(functionFragment: "unstake", data: BytesLike): Result;
  decodeFunctionResult(functionFragment: "vaults", data: BytesLike): Result;

  events: {
    "OwnershipTransferred(address,address)": EventFragment;
    "TokensStaked(address,address,uint256[],uint256)": EventFragment;
    "TokensUnstaked(address,address,uint256[],uint256)": EventFragment;
  };

  getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "TokensStaked"): EventFragment;
  getEvent(nameOrSignatureOrTopic: "TokensUnstaked"): EventFragment;
}

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

export type OwnershipTransferredEventFilter =
  TypedEventFilter<OwnershipTransferredEvent>;

export interface TokensStakedEventObject {
  contractAddress: string;
  owner: string;
  tokenIds: BigNumber[];
  timestamp: BigNumber;
}
export type TokensStakedEvent = TypedEvent<
  [string, string, BigNumber[], BigNumber],
  TokensStakedEventObject
>;

export type TokensStakedEventFilter = TypedEventFilter<TokensStakedEvent>;

export interface TokensUnstakedEventObject {
  contractAddress: string;
  owner: string;
  tokenIds: BigNumber[];
  timestamp: BigNumber;
}
export type TokensUnstakedEvent = TypedEvent<
  [string, string, BigNumber[], BigNumber],
  TokensUnstakedEventObject
>;

export type TokensUnstakedEventFilter = TypedEventFilter<TokensUnstakedEvent>;

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

  interface: PlanetxStakingV1Interface;

  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: {
    "getStakedTokens(address)"(
      user: string,
      overrides?: CallOverrides
    ): Promise<
      [string[], BigNumber[][]] & {
        contracts: string[];
        tokenIds: BigNumber[][];
      }
    >;

    "getStakedTokens(address,address)"(
      user: string,
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber[]] & { tokenIds: BigNumber[] }>;

    isContractSupported(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<[boolean]>;

    onERC721Received(
      arg0: string,
      arg1: string,
      arg2: BigNumberish,
      arg3: BytesLike,
      overrides?: CallOverrides
    ): Promise<[string]>;

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

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

    setSupportedContract(
      contractAddress: string,
      isSupported: boolean,
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    stake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    stakeCountsPerContract(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<[BigNumber] & { totalStaked: BigNumber }>;

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

    unstake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: Overrides & { from?: string }
    ): Promise<ContractTransaction>;

    vaults(
      contractAddress: string,
      tokenId: BigNumberish,
      overrides?: CallOverrides
    ): Promise<[string, BigNumber] & { owner: string; stakedAt: BigNumber }>;
  };

  "getStakedTokens(address)"(
    user: string,
    overrides?: CallOverrides
  ): Promise<
    [string[], BigNumber[][]] & { contracts: string[]; tokenIds: BigNumber[][] }
  >;

  "getStakedTokens(address,address)"(
    user: string,
    contractAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber[]>;

  isContractSupported(
    contractAddress: string,
    overrides?: CallOverrides
  ): Promise<boolean>;

  onERC721Received(
    arg0: string,
    arg1: string,
    arg2: BigNumberish,
    arg3: BytesLike,
    overrides?: CallOverrides
  ): Promise<string>;

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

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

  setSupportedContract(
    contractAddress: string,
    isSupported: boolean,
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  stake(
    contractAddress: string,
    tokenIds: BigNumberish[],
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  stakeCountsPerContract(
    contractAddress: string,
    overrides?: CallOverrides
  ): Promise<BigNumber>;

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

  unstake(
    contractAddress: string,
    tokenIds: BigNumberish[],
    overrides?: Overrides & { from?: string }
  ): Promise<ContractTransaction>;

  vaults(
    contractAddress: string,
    tokenId: BigNumberish,
    overrides?: CallOverrides
  ): Promise<[string, BigNumber] & { owner: string; stakedAt: BigNumber }>;

  callStatic: {
    "getStakedTokens(address)"(
      user: string,
      overrides?: CallOverrides
    ): Promise<
      [string[], BigNumber[][]] & {
        contracts: string[];
        tokenIds: BigNumber[][];
      }
    >;

    "getStakedTokens(address,address)"(
      user: string,
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber[]>;

    isContractSupported(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<boolean>;

    onERC721Received(
      arg0: string,
      arg1: string,
      arg2: BigNumberish,
      arg3: BytesLike,
      overrides?: CallOverrides
    ): Promise<string>;

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

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

    setSupportedContract(
      contractAddress: string,
      isSupported: boolean,
      overrides?: CallOverrides
    ): Promise<void>;

    stake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: CallOverrides
    ): Promise<void>;

    stakeCountsPerContract(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    unstake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: CallOverrides
    ): Promise<void>;

    vaults(
      contractAddress: string,
      tokenId: BigNumberish,
      overrides?: CallOverrides
    ): Promise<[string, BigNumber] & { owner: string; stakedAt: BigNumber }>;
  };

  filters: {
    "OwnershipTransferred(address,address)"(
      previousOwner?: string | null,
      newOwner?: string | null
    ): OwnershipTransferredEventFilter;
    OwnershipTransferred(
      previousOwner?: string | null,
      newOwner?: string | null
    ): OwnershipTransferredEventFilter;

    "TokensStaked(address,address,uint256[],uint256)"(
      contractAddress?: string | null,
      owner?: string | null,
      tokenIds?: null,
      timestamp?: null
    ): TokensStakedEventFilter;
    TokensStaked(
      contractAddress?: string | null,
      owner?: string | null,
      tokenIds?: null,
      timestamp?: null
    ): TokensStakedEventFilter;

    "TokensUnstaked(address,address,uint256[],uint256)"(
      contractAddress?: string | null,
      owner?: string | null,
      tokenIds?: null,
      timestamp?: null
    ): TokensUnstakedEventFilter;
    TokensUnstaked(
      contractAddress?: string | null,
      owner?: string | null,
      tokenIds?: null,
      timestamp?: null
    ): TokensUnstakedEventFilter;
  };

  estimateGas: {
    "getStakedTokens(address)"(
      user: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    "getStakedTokens(address,address)"(
      user: string,
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    isContractSupported(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

    onERC721Received(
      arg0: string,
      arg1: string,
      arg2: BigNumberish,
      arg3: BytesLike,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

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

    setSupportedContract(
      contractAddress: string,
      isSupported: boolean,
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    stake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    stakeCountsPerContract(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<BigNumber>;

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

    unstake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: Overrides & { from?: string }
    ): Promise<BigNumber>;

    vaults(
      contractAddress: string,
      tokenId: BigNumberish,
      overrides?: CallOverrides
    ): Promise<BigNumber>;
  };

  populateTransaction: {
    "getStakedTokens(address)"(
      user: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    "getStakedTokens(address,address)"(
      user: string,
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    isContractSupported(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

    onERC721Received(
      arg0: string,
      arg1: string,
      arg2: BigNumberish,
      arg3: BytesLike,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

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

    setSupportedContract(
      contractAddress: string,
      isSupported: boolean,
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    stake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    stakeCountsPerContract(
      contractAddress: string,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;

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

    unstake(
      contractAddress: string,
      tokenIds: BigNumberish[],
      overrides?: Overrides & { from?: string }
    ): Promise<PopulatedTransaction>;

    vaults(
      contractAddress: string,
      tokenId: BigNumberish,
      overrides?: CallOverrides
    ): Promise<PopulatedTransaction>;
  };
}