UNPKG

@ardier16/q-js-sdk

Version:

Typescript Library to interact with Q System Contracts

30 lines (29 loc) 1.5 kB
import { TransactionReceipt } from 'web3-eth'; import { QNonPayableTx, TimeLockEntry, QPayableTx } from '..'; import { ATimeLockBase } from '../web3-contracts/ATimeLockBase'; import { SystemContractInstance } from './SystemContractInstance'; import BN from 'bn.js'; import Web3 from 'web3'; /** * Abstract Timelock instance to interact with QVault, Saving, RootNodes and Validators contracts. * See [onchain documentation](@system-contracts-repo/@network/ATimeLockBase/) for more details. */ export declare class TimeLockHelperInstance<T extends ATimeLockBase> extends SystemContractInstance<T> { constructor(web3: Web3, abi: string, address: string); /** * [External documentation](@system-contracts-repo/@network/ATimeLockBase/#depositonbehalfof) */ depositOnBehalfOf(account: string, start: number | string | BN, end: number | string | BN, txOptions?: QPayableTx): Promise<TransactionReceipt>; /** * [External documentation](@system-contracts-repo/@network/ATimeLockBase/#gettimelocks) */ getTimeLocks(account: string): Promise<TimeLockEntry[]>; /** * [External documentation](@system-contracts-repo/@network/ATimeLockBase/#getminimumbalance) */ getMinimumBalance(account: string, timestamp: number | BN | string): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ATimeLockBase/#purgetimelocks) */ purgeTimeLocks(account: string, txOptions?: QNonPayableTx): Promise<TransactionReceipt>; }