@q-dev/gdk-sdk
Version:
Typescript Library to interact with GDK Contracts
379 lines (378 loc) • 21.3 kB
TypeScript
import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers";
import type { FunctionFragment, Result, EventFragment } from "@ethersproject/abi";
import type { Listener, Provider } from "@ethersproject/providers";
import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent } from "./common";
export declare namespace IQRC20 {
type ConstructorParamsStruct = {
name: string;
symbol: string;
contractURI: string;
decimals: BigNumberish;
totalSupplyCap: BigNumberish;
};
type ConstructorParamsStructOutput = [
string,
string,
string,
number,
BigNumber
] & {
name: string;
symbol: string;
contractURI: string;
decimals: number;
totalSupplyCap: BigNumber;
};
}
export interface QRC20Interface extends utils.Interface {
functions: {
"CHANGE_METADATA_PERMISSION()": FunctionFragment;
"__QRC20_init((string,string,string,uint8,uint256))": FunctionFragment;
"allowance(address,address)": FunctionFragment;
"approve(address,uint256)": FunctionFragment;
"balanceOf(address)": FunctionFragment;
"burnFrom(address,uint256)": FunctionFragment;
"contractURI()": FunctionFragment;
"decimals()": FunctionFragment;
"decreaseAllowance(address,uint256)": FunctionFragment;
"increaseAllowance(address,uint256)": FunctionFragment;
"mintTo(address,uint256)": FunctionFragment;
"name()": FunctionFragment;
"owner()": FunctionFragment;
"renounceOwnership()": FunctionFragment;
"setContractMetadata(string)": FunctionFragment;
"symbol()": FunctionFragment;
"totalSupply()": FunctionFragment;
"totalSupplyCap()": FunctionFragment;
"transfer(address,uint256)": FunctionFragment;
"transferFrom(address,address,uint256)": FunctionFragment;
"transferOwnership(address)": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "CHANGE_METADATA_PERMISSION" | "__QRC20_init" | "allowance" | "approve" | "balanceOf" | "burnFrom" | "contractURI" | "decimals" | "decreaseAllowance" | "increaseAllowance" | "mintTo" | "name" | "owner" | "renounceOwnership" | "setContractMetadata" | "symbol" | "totalSupply" | "totalSupplyCap" | "transfer" | "transferFrom" | "transferOwnership"): FunctionFragment;
encodeFunctionData(functionFragment: "CHANGE_METADATA_PERMISSION", values?: undefined): string;
encodeFunctionData(functionFragment: "__QRC20_init", values: [IQRC20.ConstructorParamsStruct]): string;
encodeFunctionData(functionFragment: "allowance", values: [string, string]): string;
encodeFunctionData(functionFragment: "approve", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "balanceOf", values: [string]): string;
encodeFunctionData(functionFragment: "burnFrom", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "contractURI", values?: undefined): string;
encodeFunctionData(functionFragment: "decimals", values?: undefined): string;
encodeFunctionData(functionFragment: "decreaseAllowance", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "increaseAllowance", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "mintTo", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "name", values?: undefined): string;
encodeFunctionData(functionFragment: "owner", values?: undefined): string;
encodeFunctionData(functionFragment: "renounceOwnership", values?: undefined): string;
encodeFunctionData(functionFragment: "setContractMetadata", values: [string]): string;
encodeFunctionData(functionFragment: "symbol", values?: undefined): string;
encodeFunctionData(functionFragment: "totalSupply", values?: undefined): string;
encodeFunctionData(functionFragment: "totalSupplyCap", values?: undefined): string;
encodeFunctionData(functionFragment: "transfer", values: [string, BigNumberish]): string;
encodeFunctionData(functionFragment: "transferFrom", values: [string, string, BigNumberish]): string;
encodeFunctionData(functionFragment: "transferOwnership", values: [string]): string;
decodeFunctionResult(functionFragment: "CHANGE_METADATA_PERMISSION", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "__QRC20_init", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "allowance", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "approve", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "balanceOf", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "burnFrom", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "contractURI", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "decimals", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "decreaseAllowance", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "increaseAllowance", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "mintTo", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "name", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "renounceOwnership", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "setContractMetadata", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "symbol", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "totalSupply", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "totalSupplyCap", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transfer", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferFrom", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferOwnership", data: BytesLike): Result;
events: {
"Approval(address,address,uint256)": EventFragment;
"ContractURIChanged(string)": EventFragment;
"Initialized(uint8)": EventFragment;
"OwnershipTransferred(address,address)": EventFragment;
"Transfer(address,address,uint256)": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "Approval"): EventFragment;
getEvent(nameOrSignatureOrTopic: "ContractURIChanged"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Transfer"): EventFragment;
}
export interface ApprovalEventObject {
owner: string;
spender: string;
value: BigNumber;
}
export type ApprovalEvent = TypedEvent<[
string,
string,
BigNumber
], ApprovalEventObject>;
export type ApprovalEventFilter = TypedEventFilter<ApprovalEvent>;
export interface ContractURIChangedEventObject {
contractURI: string;
}
export type ContractURIChangedEvent = TypedEvent<[
string
], ContractURIChangedEventObject>;
export type ContractURIChangedEventFilter = TypedEventFilter<ContractURIChangedEvent>;
export interface InitializedEventObject {
version: number;
}
export type InitializedEvent = TypedEvent<[number], InitializedEventObject>;
export type InitializedEventFilter = TypedEventFilter<InitializedEvent>;
export interface OwnershipTransferredEventObject {
previousOwner: string;
newOwner: string;
}
export type OwnershipTransferredEvent = TypedEvent<[
string,
string
], OwnershipTransferredEventObject>;
export type OwnershipTransferredEventFilter = TypedEventFilter<OwnershipTransferredEvent>;
export interface TransferEventObject {
from: string;
to: string;
value: BigNumber;
}
export type TransferEvent = TypedEvent<[
string,
string,
BigNumber
], TransferEventObject>;
export type TransferEventFilter = TypedEventFilter<TransferEvent>;
export interface QRC20 extends BaseContract {
contractName: "QRC20";
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: QRC20Interface;
queryFilter<TEvent extends TypedEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>;
listeners<TEvent extends TypedEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>;
listeners(eventName?: string): Array<Listener>;
removeAllListeners<TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>): this;
removeAllListeners(eventName?: string): this;
off: OnEvent<this>;
on: OnEvent<this>;
once: OnEvent<this>;
removeListener: OnEvent<this>;
functions: {
CHANGE_METADATA_PERMISSION(overrides?: CallOverrides): Promise<[string]>;
__QRC20_init(params_: IQRC20.ConstructorParamsStruct, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<[BigNumber]>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
balanceOf(account: string, overrides?: CallOverrides): Promise<[BigNumber]>;
burnFrom(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
contractURI(overrides?: CallOverrides): Promise<[string]>;
decimals(overrides?: CallOverrides): Promise<[number]>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
mintTo(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
name(overrides?: CallOverrides): Promise<[string]>;
owner(overrides?: CallOverrides): Promise<[string]>;
renounceOwnership(overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
setContractMetadata(contractURI_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
symbol(overrides?: CallOverrides): Promise<[string]>;
totalSupply(overrides?: CallOverrides): Promise<[BigNumber]>;
totalSupplyCap(overrides?: CallOverrides): Promise<[BigNumber]>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
transferOwnership(newOwner: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
};
CHANGE_METADATA_PERMISSION(overrides?: CallOverrides): Promise<string>;
__QRC20_init(params_: IQRC20.ConstructorParamsStruct, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>;
burnFrom(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
contractURI(overrides?: CallOverrides): Promise<string>;
decimals(overrides?: CallOverrides): Promise<number>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
mintTo(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
name(overrides?: CallOverrides): Promise<string>;
owner(overrides?: CallOverrides): Promise<string>;
renounceOwnership(overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
setContractMetadata(contractURI_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
symbol(overrides?: CallOverrides): Promise<string>;
totalSupply(overrides?: CallOverrides): Promise<BigNumber>;
totalSupplyCap(overrides?: CallOverrides): Promise<BigNumber>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
transferOwnership(newOwner: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
callStatic: {
CHANGE_METADATA_PERMISSION(overrides?: CallOverrides): Promise<string>;
__QRC20_init(params_: IQRC20.ConstructorParamsStruct, overrides?: CallOverrides): Promise<void>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
approve(spender: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>;
burnFrom(account_: string, amount_: BigNumberish, overrides?: CallOverrides): Promise<void>;
contractURI(overrides?: CallOverrides): Promise<string>;
decimals(overrides?: CallOverrides): Promise<number>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
mintTo(account_: string, amount_: BigNumberish, overrides?: CallOverrides): Promise<void>;
name(overrides?: CallOverrides): Promise<string>;
owner(overrides?: CallOverrides): Promise<string>;
renounceOwnership(overrides?: CallOverrides): Promise<void>;
setContractMetadata(contractURI_: string, overrides?: CallOverrides): Promise<void>;
symbol(overrides?: CallOverrides): Promise<string>;
totalSupply(overrides?: CallOverrides): Promise<BigNumber>;
totalSupplyCap(overrides?: CallOverrides): Promise<BigNumber>;
transfer(to: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: CallOverrides): Promise<boolean>;
transferOwnership(newOwner: string, overrides?: CallOverrides): Promise<void>;
};
filters: {
"Approval(address,address,uint256)"(owner?: string | null, spender?: string | null, value?: null): ApprovalEventFilter;
Approval(owner?: string | null, spender?: string | null, value?: null): ApprovalEventFilter;
"ContractURIChanged(string)"(contractURI?: null): ContractURIChangedEventFilter;
ContractURIChanged(contractURI?: null): ContractURIChangedEventFilter;
"Initialized(uint8)"(version?: null): InitializedEventFilter;
Initialized(version?: null): InitializedEventFilter;
"OwnershipTransferred(address,address)"(previousOwner?: string | null, newOwner?: string | null): OwnershipTransferredEventFilter;
OwnershipTransferred(previousOwner?: string | null, newOwner?: string | null): OwnershipTransferredEventFilter;
"Transfer(address,address,uint256)"(from?: string | null, to?: string | null, value?: null): TransferEventFilter;
Transfer(from?: string | null, to?: string | null, value?: null): TransferEventFilter;
};
estimateGas: {
CHANGE_METADATA_PERMISSION(overrides?: CallOverrides): Promise<BigNumber>;
__QRC20_init(params_: IQRC20.ConstructorParamsStruct, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<BigNumber>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
balanceOf(account: string, overrides?: CallOverrides): Promise<BigNumber>;
burnFrom(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
contractURI(overrides?: CallOverrides): Promise<BigNumber>;
decimals(overrides?: CallOverrides): Promise<BigNumber>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
mintTo(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
name(overrides?: CallOverrides): Promise<BigNumber>;
owner(overrides?: CallOverrides): Promise<BigNumber>;
renounceOwnership(overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
setContractMetadata(contractURI_: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
symbol(overrides?: CallOverrides): Promise<BigNumber>;
totalSupply(overrides?: CallOverrides): Promise<BigNumber>;
totalSupplyCap(overrides?: CallOverrides): Promise<BigNumber>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
transferOwnership(newOwner: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
};
populateTransaction: {
CHANGE_METADATA_PERMISSION(overrides?: CallOverrides): Promise<PopulatedTransaction>;
__QRC20_init(params_: IQRC20.ConstructorParamsStruct, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
allowance(owner: string, spender: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
approve(spender: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
balanceOf(account: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
burnFrom(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
contractURI(overrides?: CallOverrides): Promise<PopulatedTransaction>;
decimals(overrides?: CallOverrides): Promise<PopulatedTransaction>;
decreaseAllowance(spender: string, subtractedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
increaseAllowance(spender: string, addedValue: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
mintTo(account_: string, amount_: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
name(overrides?: CallOverrides): Promise<PopulatedTransaction>;
owner(overrides?: CallOverrides): Promise<PopulatedTransaction>;
renounceOwnership(overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
setContractMetadata(contractURI_: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
symbol(overrides?: CallOverrides): Promise<PopulatedTransaction>;
totalSupply(overrides?: CallOverrides): Promise<PopulatedTransaction>;
totalSupplyCap(overrides?: CallOverrides): Promise<PopulatedTransaction>;
transfer(to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
transferFrom(from: string, to: string, amount: BigNumberish, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
transferOwnership(newOwner: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
};
}