UNPKG

@q-dev/q-js-sdk

Version:

Typescript Library to interact with Q System Contracts

26 lines (25 loc) 1.31 kB
import type { ContractTransaction } from 'ethers'; import { PushPayments } from '../../ethers-contracts/PushPayments'; import { SystemContractInstance } from '../SystemContractInstance'; import { QNonPayableTx, QPayableTx, SignerOrProvider } 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(signerOrProvider: SignerOrProvider, 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<ContractTransaction>; /** * [External documentation](@system-contracts-repo/@network/PushPayments/#withdraw) */ withdraw(txOptions?: QNonPayableTx): Promise<ContractTransaction>; }