@ardier16/q-js-sdk
Version:
Typescript Library to interact with Q System Contracts
27 lines (26 loc) • 1.28 kB
TypeScript
import Web3 from 'web3';
import { PushPayments } from '../../web3-contracts/PushPayments';
import { SystemContractInstance } from '../SystemContractInstance';
import { TransactionReceipt } from 'web3-eth';
import { QNonPayableTx, QPayableTx } from '../../types';
/**
* Push payments instance to interact with Push payments contract.
* See [onchain documentation](@system-contracts-repo/@network/PushPayments/) for more details.
* An instance of this class for a deployed network can be obtained via {@link ContractRegistryInstance.pushPayments}
*/
export declare class PushPaymentsInstance extends SystemContractInstance<PushPayments> {
static readonly registryKey = "tokeneconomics.pushPayments";
constructor(web3: Web3, address: string);
/**
* [External documentation](@system-contracts-repo/@network/PushPayments/#balanceof)
*/
balanceOf(account: string): Promise<string>;
/**
* [External documentation](@system-contracts-repo/@network/PushPayments/#safetransferto)
*/
safeTransferTo(account: string, txOptions?: QPayableTx): Promise<TransactionReceipt>;
/**
* [External documentation](@system-contracts-repo/@network/PushPayments/#withdraw)
*/
withdraw(txOptions?: QNonPayableTx): Promise<TransactionReceipt>;
}