UNPKG

@ardier16/q-js-sdk

Version:

Typescript Library to interact with Q System Contracts

58 lines (57 loc) 2.55 kB
import Web3 from 'web3'; import { TransactionReceipt } from 'web3-eth'; import { ERC20 } from '../../../web3-contracts/ERC20'; import { QNonPayableTx } from '../../../types'; import { SystemContractInstance } from '../../SystemContractInstance'; /** * ERC20 instance to interact with Stablecoin contract. * See [onchain documentation](@system-contracts-repo/@network/ERC20/) for more details. * An instance of this class for a deployed network can be obtained via {@link ContractRegistryInstance.stableCoin} */ export declare class ERC20Instance extends SystemContractInstance<ERC20> { constructor(web3: Web3, address: string); /** * [External documentation](@system-contracts-repo/@network/ERC20/#approve) */ approve(spender: string, amount: string | number, txOptions?: QNonPayableTx): Promise<TransactionReceipt>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#allowance) */ allowance(owner: string, spender: string): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#transfer) */ transfer(recipient: string, amount: string | number, txOptions?: QNonPayableTx): Promise<TransactionReceipt>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#transferfrom) */ transferFrom(sender: string, recipient: string, amount: string | number, txOptions?: QNonPayableTx): Promise<TransactionReceipt>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#balanceof) */ balanceOf(address: string): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#totalsupply) */ totalSupply(): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#name) */ name(): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#symbol) */ symbol(): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#decimals) */ decimals(): Promise<string>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#increaseallowance) */ increaseAllowance(spender: string, amount: string, txOptions?: QNonPayableTx): Promise<TransactionReceipt>; /** * [External documentation](@system-contracts-repo/@network/ERC20/#decreaseallowance) */ decreaseAllowance(spender: string, amount: string, txOptions?: QNonPayableTx): Promise<TransactionReceipt>; }