@ardier16/q-js-sdk
Version:
Typescript Library to interact with Q System Contracts
46 lines (45 loc) • 2.12 kB
TypeScript
import Web3 from 'web3';
import { SystemBalanceMock } from '../../web3-contracts/SystemBalanceMock';
import { SystemContractInstance } from '../SystemContractInstance';
import { TransactionReceipt } from 'web3-eth';
import { QPayableTx, SystemBalanceDetails, QNonPayableTx } 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(web3: Web3, 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<TransactionReceipt>;
/**
* [External documentation](@system-contracts-repo/@network/SystemBalance/#increasedebt)
*/
increaseDebt(debtAmount: string, txOptions?: QPayableTx): Promise<TransactionReceipt>;
/**
* [External documentation](@system-contracts-repo/@network/SystemBalance/#performnetting)
*/
performNetting(txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
}