@q-dev/q-js-sdk/lib/contracts/defi/SystemBalanceInstance.d.ts

Typescript Library to interact with Q System Contracts

import type { ContractTransaction } from 'ethers';
import { SystemBalanceMock } from '../../ethers-contracts/SystemBalanceMock';
import { SystemContractInstance } from '../SystemContractInstance';
import { QPayableTx, SystemBalanceDetails, QNonPayableTx, SignerOrProvider } from '../../types';
/**
 * [System balance contract instance](@system-contracts-repo/@network/SystemBalance/)
 * An instance of this class for a deployed network can be obtained via {@link ContractRegistryInstance.systemBalance}
 */
/**
 * System balance instance to interact with System balance contract.
 * See [onchain documentation](@system-contracts-repo/@network/SystemBalance/) for more details.
 * An instance of this class for a deployed network can be obtained via {@link ContractRegistryInstance.systemBalance}
 */
export declare class SystemBalanceInstance extends SystemContractInstance<SystemBalanceMock> {
    constructor(signerOrProvider: SignerOrProvider, address: string);
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#getdebt)
     */
    getDebt(): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#getbalance)
     */
    getBalance(): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#getsurplus)
     */
    getSurplus(): Promise<string>;
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#getbalancedetails)
     */
    getBalanceDetails(): Promise<SystemBalanceDetails>;
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#setdebt)
     */
    setDebt(debt: number | string, txOptions?: QNonPayableTx): Promise<ContractTransaction>;
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#increasedebt)
     */
    increaseDebt(debtAmount: string, txOptions?: QPayableTx): Promise<ContractTransaction>;
    /**
     * [External documentation](@system-contracts-repo/@network/SystemBalance/#performnetting)
     */
    performNetting(txOptions?: QNonPayableTx): Promise<ContractTransaction>;
}