@q-dev/q-js-sdk
Version:
Typescript Library to interact with Q System Contracts
262 lines (261 loc) • 15.8 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, PromiseOrValue } from "./common";
export declare namespace ARootNodeApprovalVoting {
type AProposalStruct = {
executed: PromiseOrValue<boolean>;
votingStartTime: PromiseOrValue<BigNumberish>;
votingExpiredTime: PromiseOrValue<BigNumberish>;
requiredMajority: PromiseOrValue<BigNumberish>;
callData: PromiseOrValue<BytesLike>;
remark: PromiseOrValue<string>;
};
type AProposalStructOutput = [
boolean,
BigNumber,
BigNumber,
BigNumber,
string,
string
] & {
executed: boolean;
votingStartTime: BigNumber;
votingExpiredTime: BigNumber;
requiredMajority: BigNumber;
callData: string;
remark: string;
};
type ProposalStatsStruct = {
requiredMajority: PromiseOrValue<BigNumberish>;
currentMajority: PromiseOrValue<BigNumberish>;
};
type ProposalStatsStructOutput = [BigNumber, BigNumber] & {
requiredMajority: BigNumber;
currentMajority: BigNumber;
};
}
export interface GenericContractRegistryVotingInterface extends utils.Interface {
functions: {
"approve(uint256)": FunctionFragment;
"createProposal(string,bytes)": FunctionFragment;
"getProposal(uint256)": FunctionFragment;
"getProposalStats(uint256)": FunctionFragment;
"getStatus(uint256)": FunctionFragment;
"initialize(address)": FunctionFragment;
"owner()": FunctionFragment;
"proposalsCount()": FunctionFragment;
"renounceOwnership()": FunctionFragment;
"transferOwnership(address)": FunctionFragment;
"voteCount(uint256)": FunctionFragment;
"voted(uint256,address)": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "approve" | "createProposal" | "getProposal" | "getProposalStats" | "getStatus" | "initialize" | "owner" | "proposalsCount" | "renounceOwnership" | "transferOwnership" | "voteCount" | "voted"): FunctionFragment;
encodeFunctionData(functionFragment: "approve", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "createProposal", values: [PromiseOrValue<string>, PromiseOrValue<BytesLike>]): string;
encodeFunctionData(functionFragment: "getProposal", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "getProposalStats", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "getStatus", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "initialize", values: [PromiseOrValue<string>]): string;
encodeFunctionData(functionFragment: "owner", values?: undefined): string;
encodeFunctionData(functionFragment: "proposalsCount", values?: undefined): string;
encodeFunctionData(functionFragment: "renounceOwnership", values?: undefined): string;
encodeFunctionData(functionFragment: "transferOwnership", values: [PromiseOrValue<string>]): string;
encodeFunctionData(functionFragment: "voteCount", values: [PromiseOrValue<BigNumberish>]): string;
encodeFunctionData(functionFragment: "voted", values: [PromiseOrValue<BigNumberish>, PromiseOrValue<string>]): string;
decodeFunctionResult(functionFragment: "approve", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "createProposal", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getProposal", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getProposalStats", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getStatus", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "owner", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "proposalsCount", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "renounceOwnership", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "transferOwnership", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "voteCount", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "voted", data: BytesLike): Result;
events: {
"OwnershipTransferred(address,address)": EventFragment;
"ProposalCreated(uint256)": EventFragment;
"ProposalExecuted(uint256)": EventFragment;
"RootNodeApproved(uint256,address)": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "OwnershipTransferred"): EventFragment;
getEvent(nameOrSignatureOrTopic: "ProposalCreated"): EventFragment;
getEvent(nameOrSignatureOrTopic: "ProposalExecuted"): EventFragment;
getEvent(nameOrSignatureOrTopic: "RootNodeApproved"): EventFragment;
}
export interface OwnershipTransferredEventObject {
previousOwner: string;
newOwner: string;
}
export declare type OwnershipTransferredEvent = TypedEvent<[
string,
string
], OwnershipTransferredEventObject>;
export declare type OwnershipTransferredEventFilter = TypedEventFilter<OwnershipTransferredEvent>;
export interface ProposalCreatedEventObject {
proposalId: BigNumber;
}
export declare type ProposalCreatedEvent = TypedEvent<[
BigNumber
], ProposalCreatedEventObject>;
export declare type ProposalCreatedEventFilter = TypedEventFilter<ProposalCreatedEvent>;
export interface ProposalExecutedEventObject {
proposalId: BigNumber;
}
export declare type ProposalExecutedEvent = TypedEvent<[
BigNumber
], ProposalExecutedEventObject>;
export declare type ProposalExecutedEventFilter = TypedEventFilter<ProposalExecutedEvent>;
export interface RootNodeApprovedEventObject {
proposalId: BigNumber;
rootNode: string;
}
export declare type RootNodeApprovedEvent = TypedEvent<[
BigNumber,
string
], RootNodeApprovedEventObject>;
export declare type RootNodeApprovedEventFilter = TypedEventFilter<RootNodeApprovedEvent>;
export interface GenericContractRegistryVoting extends BaseContract {
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: GenericContractRegistryVotingInterface;
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: {
approve(id_: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
createProposal(remark_: PromiseOrValue<string>, callData_: PromiseOrValue<BytesLike>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getProposal(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
ARootNodeApprovalVoting.AProposalStructOutput
] & {
proposal_: ARootNodeApprovalVoting.AProposalStructOutput;
}>;
getProposalStats(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[
ARootNodeApprovalVoting.ProposalStatsStructOutput
] & {
stats_: ARootNodeApprovalVoting.ProposalStatsStructOutput;
}>;
getStatus(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[number]>;
initialize(registry_: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
owner(overrides?: CallOverrides): Promise<[string]>;
proposalsCount(overrides?: CallOverrides): Promise<[BigNumber]>;
renounceOwnership(overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
voteCount(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[BigNumber]>;
voted(arg0: PromiseOrValue<BigNumberish>, arg1: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[boolean]>;
};
approve(id_: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
createProposal(remark_: PromiseOrValue<string>, callData_: PromiseOrValue<BytesLike>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
getProposal(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<ARootNodeApprovalVoting.AProposalStructOutput>;
getProposalStats(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<ARootNodeApprovalVoting.ProposalStatsStructOutput>;
getStatus(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<number>;
initialize(registry_: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
owner(overrides?: CallOverrides): Promise<string>;
proposalsCount(overrides?: CallOverrides): Promise<BigNumber>;
renounceOwnership(overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<ContractTransaction>;
voteCount(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
voted(arg0: PromiseOrValue<BigNumberish>, arg1: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
callStatic: {
approve(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<void>;
createProposal(remark_: PromiseOrValue<string>, callData_: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>;
getProposal(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<ARootNodeApprovalVoting.AProposalStructOutput>;
getProposalStats(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<ARootNodeApprovalVoting.ProposalStatsStructOutput>;
getStatus(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<number>;
initialize(registry_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
owner(overrides?: CallOverrides): Promise<string>;
proposalsCount(overrides?: CallOverrides): Promise<BigNumber>;
renounceOwnership(overrides?: CallOverrides): Promise<void>;
transferOwnership(newOwner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>;
voteCount(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
voted(arg0: PromiseOrValue<BigNumberish>, arg1: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
};
filters: {
"OwnershipTransferred(address,address)"(previousOwner?: PromiseOrValue<string> | null, newOwner?: PromiseOrValue<string> | null): OwnershipTransferredEventFilter;
OwnershipTransferred(previousOwner?: PromiseOrValue<string> | null, newOwner?: PromiseOrValue<string> | null): OwnershipTransferredEventFilter;
"ProposalCreated(uint256)"(proposalId?: null): ProposalCreatedEventFilter;
ProposalCreated(proposalId?: null): ProposalCreatedEventFilter;
"ProposalExecuted(uint256)"(proposalId?: null): ProposalExecutedEventFilter;
ProposalExecuted(proposalId?: null): ProposalExecutedEventFilter;
"RootNodeApproved(uint256,address)"(proposalId?: null, rootNode?: null): RootNodeApprovedEventFilter;
RootNodeApproved(proposalId?: null, rootNode?: null): RootNodeApprovedEventFilter;
};
estimateGas: {
approve(id_: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
createProposal(remark_: PromiseOrValue<string>, callData_: PromiseOrValue<BytesLike>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
getProposal(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
getProposalStats(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
getStatus(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
initialize(registry_: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
owner(overrides?: CallOverrides): Promise<BigNumber>;
proposalsCount(overrides?: CallOverrides): Promise<BigNumber>;
renounceOwnership(overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<BigNumber>;
voteCount(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
voted(arg0: PromiseOrValue<BigNumberish>, arg1: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
};
populateTransaction: {
approve(id_: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
createProposal(remark_: PromiseOrValue<string>, callData_: PromiseOrValue<BytesLike>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
getProposal(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
getProposalStats(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
getStatus(id_: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
initialize(registry_: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
owner(overrides?: CallOverrides): Promise<PopulatedTransaction>;
proposalsCount(overrides?: CallOverrides): Promise<PopulatedTransaction>;
renounceOwnership(overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
transferOwnership(newOwner: PromiseOrValue<string>, overrides?: Overrides & {
from?: PromiseOrValue<string>;
}): Promise<PopulatedTransaction>;
voteCount(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
voted(arg0: PromiseOrValue<BigNumberish>, arg1: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
};
}