@q-dev/q-js-sdk/lib/ethers-contracts/SystemBalance.d.ts

Typescript Library to interact with Q System Contracts

import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common";
export declare namespace SystemBalance {
    type SystemBalanceDetailsStruct = {
        isDebtAuctionPossible: PromiseOrValue<boolean>;
        isSurplusAuctionPossible: PromiseOrValue<boolean>;
        currentDebt: PromiseOrValue<BigNumberish>;
        debtThreshold: PromiseOrValue<BigNumberish>;
        currentSurplus: PromiseOrValue<BigNumberish>;
        surplusThreshold: PromiseOrValue<BigNumberish>;
    };
    type SystemBalanceDetailsStructOutput = [
        boolean,
        boolean,
        BigNumber,
        BigNumber,
        BigNumber,
        BigNumber
    ] & {
        isDebtAuctionPossible: boolean;
        isSurplusAuctionPossible: boolean;
        currentDebt: BigNumber;
        debtThreshold: BigNumber;
        currentSurplus: BigNumber;
        surplusThreshold: BigNumber;
    };
}
export interface SystemBalanceInterface extends utils.Interface {
    functions: {
        "initialize(address,string)": FunctionFragment;
        "increaseDebt(uint256)": FunctionFragment;
        "transferSurplusAuctionAmount(uint256)": FunctionFragment;
        "transferAccruedInterestAmount(uint256)": FunctionFragment;
        "performNetting()": FunctionFragment;
        "getDebt()": FunctionFragment;
        "getBalance()": FunctionFragment;
        "getBalanceDetails()": FunctionFragment;
        "getSurplus()": FunctionFragment;
    };
    getFunction(nameOrSignatureOrTopic: "initialize" | "increaseDebt" | "transferSurplusAuctionAmount" | "transferAccruedInterestAmount" | "performNetting" | "getDebt" | "getBalance" | "getBalanceDetails" | "getSurplus"): FunctionFragment;
    encodeFunctionData(functionFragment: "initialize", values: [PromiseOrValue<string>, PromiseOrValue<string>]): string;
    encodeFunctionData(functionFragment: "increaseDebt", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "transferSurplusAuctionAmount", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "transferAccruedInterestAmount", values: [PromiseOrValue<BigNumberish>]): string;
    encodeFunctionData(functionFragment: "performNetting", values?: undefined): string;
    encodeFunctionData(functionFragment: "getDebt", values?: undefined): string;
    encodeFunctionData(functionFragment: "getBalance", values?: undefined): string;
    encodeFunctionData(functionFragment: "getBalanceDetails", values?: undefined): string;
    encodeFunctionData(functionFragment: "getSurplus", values?: undefined): string;
    decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "increaseDebt", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "transferSurplusAuctionAmount", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "transferAccruedInterestAmount", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "performNetting", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getDebt", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getBalance", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getBalanceDetails", data: BytesLike): Result;
    decodeFunctionResult(functionFragment: "getSurplus", data: BytesLike): Result;
    events: {};
}
export interface SystemBalance extends BaseContract {
    connect(signerOrProvider: Signer | Provider | string): this;
    attach(addressOrName: string): this;
    deployed(): Promise<this>;
    interface: SystemBalanceInterface;
    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: {
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        increaseDebt(_debtAmount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        transferSurplusAuctionAmount(_lot: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        transferAccruedInterestAmount(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        performNetting(overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<ContractTransaction>;
        getDebt(overrides?: CallOverrides): Promise<[BigNumber]>;
        getBalance(overrides?: CallOverrides): Promise<[BigNumber]>;
        getBalanceDetails(overrides?: CallOverrides): Promise<[SystemBalance.SystemBalanceDetailsStructOutput]>;
        getSurplus(overrides?: CallOverrides): Promise<[BigNumber]>;
    };
    initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    increaseDebt(_debtAmount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    transferSurplusAuctionAmount(_lot: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    transferAccruedInterestAmount(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    performNetting(overrides?: Overrides & {
        from?: PromiseOrValue<string>;
    }): Promise<ContractTransaction>;
    getDebt(overrides?: CallOverrides): Promise<BigNumber>;
    getBalance(overrides?: CallOverrides): Promise<BigNumber>;
    getBalanceDetails(overrides?: CallOverrides): Promise<SystemBalance.SystemBalanceDetailsStructOutput>;
    getSurplus(overrides?: CallOverrides): Promise<BigNumber>;
    callStatic: {
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
        increaseDebt(_debtAmount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
        transferSurplusAuctionAmount(_lot: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
        transferAccruedInterestAmount(_amount: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>;
        performNetting(overrides?: CallOverrides): Promise<boolean>;
        getDebt(overrides?: CallOverrides): Promise<BigNumber>;
        getBalance(overrides?: CallOverrides): Promise<BigNumber>;
        getBalanceDetails(overrides?: CallOverrides): Promise<SystemBalance.SystemBalanceDetailsStructOutput>;
        getSurplus(overrides?: CallOverrides): Promise<BigNumber>;
    };
    filters: {};
    estimateGas: {
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        increaseDebt(_debtAmount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        transferSurplusAuctionAmount(_lot: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        transferAccruedInterestAmount(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        performNetting(overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<BigNumber>;
        getDebt(overrides?: CallOverrides): Promise<BigNumber>;
        getBalance(overrides?: CallOverrides): Promise<BigNumber>;
        getBalanceDetails(overrides?: CallOverrides): Promise<BigNumber>;
        getSurplus(overrides?: CallOverrides): Promise<BigNumber>;
    };
    populateTransaction: {
        initialize(_registry: PromiseOrValue<string>, _stc: PromiseOrValue<string>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        increaseDebt(_debtAmount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        transferSurplusAuctionAmount(_lot: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        transferAccruedInterestAmount(_amount: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        performNetting(overrides?: Overrides & {
            from?: PromiseOrValue<string>;
        }): Promise<PopulatedTransaction>;
        getDebt(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getBalance(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getBalanceDetails(overrides?: CallOverrides): Promise<PopulatedTransaction>;
        getSurplus(overrides?: CallOverrides): Promise<PopulatedTransaction>;
    };
}