@ardier16/q-js-sdk/lib/web3-contracts/ValidationRewardPools.d.ts

Typescript Library to interact with Q System Contracts

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

import BN from "bn.js";
import { ContractOptions } from "web3-eth-contract";
import { EventLog } from "web3-core";
import { EventEmitter } from "events";
import {
  Callback,
  PayableTransactionObject,
  NonPayableTransactionObject,
  BlockType,
  ContractEventLog,
  BaseContract,
} from "./types";

interface EventOptions {
  filter?: object;
  fromBlock?: BlockType;
  topics?: string[];
}

export type DelegatorsShareChanged = ContractEventLog<{
  _validatorAddress: string;
  _newDelegatorsShare: string;
  0: string;
  1: string;
}>;
export type RewardTransferedToQVault = ContractEventLog<{
  _claimerAddress: string;
  _rewardAmount: string;
  0: string;
  1: string;
}>;
export type UpdateRate = ContractEventLog<{
  _v: [string, string, string, string, string];
  _oldRate: string;
  _newRate: string;
  _inc: string;
  0: [string, string, string, string, string];
  1: string;
  2: string;
  3: string;
}>;

export interface ValidationRewardPools extends BaseContract {
  constructor(
    jsonInterface: any[],
    address?: string,
    options?: ContractOptions
  ): ValidationRewardPools;
  clone(): ValidationRewardPools;
  methods: {
    validatorsProperties(
      arg0: string
    ): NonPayableTransactionObject<{
      balance: string;
      reservedForClaim: string;
      delegatorsShare: string;
      aggregatedNormalizedStake: string;
      compoundRate: string;
      0: string;
      1: string;
      2: string;
      3: string;
      4: string;
    }>;

    initialize(
      _registry: string,
      _crUpdateMinimumBase: number | string | BN
    ): NonPayableTransactionObject<void>;

    addCompoundRateKeeper(
      _validator: string
    ): NonPayableTransactionObject<void>;

    increase(_validator: string): PayableTransactionObject<void>;

    requestRewardTransfer(
      _validator: string,
      _rewardAmount: number | string | BN
    ): NonPayableTransactionObject<boolean>;

    updateValidatorsCompoundRate(
      _validator: string
    ): NonPayableTransactionObject<string>;

    setDelegatorsShare(
      _newDelegatorsShare: number | string | BN
    ): NonPayableTransactionObject<void>;

    reserveAdditionalFunds(_validator: string): PayableTransactionObject<void>;

    getDelegatorsShare(_addr: string): NonPayableTransactionObject<string>;

    getBalance(_validator: string): NonPayableTransactionObject<string>;

    addAggregatedNormalizedStake(
      _validator: string,
      _stake: number | string | BN
    ): NonPayableTransactionObject<void>;

    subAggregatedNormalizedStake(
      _validator: string,
      _stake: number | string | BN
    ): NonPayableTransactionObject<void>;

    getPoolInfo(
      _validator: string
    ): NonPayableTransactionObject<
      [string, string, string, string, string, string, string]
    >;

    getCompoundRate(_validator: string): NonPayableTransactionObject<string>;

    getDelegatedStake(_validator: string): NonPayableTransactionObject<string>;

    getLastUpdateOfCompoundRate(
      _validator: string
    ): NonPayableTransactionObject<string>;

    getNormalizedAmount(
      _validator: string,
      _targetAmount: number | string | BN
    ): NonPayableTransactionObject<string>;

    getDenormalizedAmount(
      _validator: string,
      _normalizedAmount: number | string | BN
    ): NonPayableTransactionObject<string>;
  };
  events: {
    DelegatorsShareChanged(cb?: Callback<DelegatorsShareChanged>): EventEmitter;
    DelegatorsShareChanged(
      options?: EventOptions,
      cb?: Callback<DelegatorsShareChanged>
    ): EventEmitter;

    RewardTransferedToQVault(
      cb?: Callback<RewardTransferedToQVault>
    ): EventEmitter;
    RewardTransferedToQVault(
      options?: EventOptions,
      cb?: Callback<RewardTransferedToQVault>
    ): EventEmitter;

    UpdateRate(cb?: Callback<UpdateRate>): EventEmitter;
    UpdateRate(options?: EventOptions, cb?: Callback<UpdateRate>): EventEmitter;

    allEvents(options?: EventOptions, cb?: Callback<EventLog>): EventEmitter;
  };

  once(
    event: "DelegatorsShareChanged",
    cb: Callback<DelegatorsShareChanged>
  ): void;
  once(
    event: "DelegatorsShareChanged",
    options: EventOptions,
    cb: Callback<DelegatorsShareChanged>
  ): void;

  once(
    event: "RewardTransferedToQVault",
    cb: Callback<RewardTransferedToQVault>
  ): void;
  once(
    event: "RewardTransferedToQVault",
    options: EventOptions,
    cb: Callback<RewardTransferedToQVault>
  ): void;

  once(event: "UpdateRate", cb: Callback<UpdateRate>): void;
  once(
    event: "UpdateRate",
    options: EventOptions,
    cb: Callback<UpdateRate>
  ): void;
}