@ardier16/q-js-sdk/lib/contracts/tokeneconomics/ValidationRewardPoolsInstance.d.ts

Typescript Library to interact with Q System Contracts

import Web3 from 'web3';
import { TransactionReceipt } from 'web3-eth/types';
import { QNonPayableTx, QPayableTx, ValidatorPoolInfo, ValidatorProperties } from '../../types';
import { ValidationRewardPools } from '../../web3-contracts/ValidationRewardPools';
import { SystemContractInstance } from '../SystemContractInstance';
/**
 * Validation reward pools instance to interact with Validation reward pools contract.
 * See [onchain documentation](@system-contracts-repo/@network/ValidationRewardPools/) for more details.
 * An instance of this class for a deployed network can be obtained via {@link ContractRegistryInstance.validationRewardPools}
 */
export declare class ValidationRewardPoolsInstance extends SystemContractInstance<ValidationRewardPools> {
    static readonly registryKey = "tokeneconomics.validationRewardPools";
    constructor(web3: Web3, address: string);
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#validatorproperties)
     */
    validatorProperties(address: string): Promise<ValidatorProperties>;
    /**
     * Checks whether a user has CompoundRateKeeper
     * @param address user
     * @returns CRKeeper existence for given address
     */
    compoundRateKeeperExists(address: string): Promise<boolean>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#setdelegatorsshare)
     */
    setDelegatorsShare(qsv: string, txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#increase)
     */
    increase(address: string, txOptions?: QPayableTx): Promise<TransactionReceipt>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#updatevalidatorscompoundrate)
     */
    updateValidatorsCompoundRate(address: string, txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#reserveadditionalfunds)
     */
    reserveAdditionalFunds(validator: string, txOptions?: QPayableTx): Promise<TransactionReceipt>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#getcompoundrate)
     */
    getCompoundRate(address: string): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#getlastupdateofcompoundrate)
     */
    getLastUpdateOfCompoundRate(address: string): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#getbalance)
     */
    getValidatorBalance(address: string): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#getdelegatedstake)
     */
    getDelegatedStake(address: string): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#getdelegatorsshare)
     */
    getDelegatorsShare(address: string): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/ValidationRewardPools/#getpoolinfo)
     */
    getPoolInfo(address: string): Promise<ValidatorPoolInfo>;
}