@q-dev/gdk-sdk
Version:
Typescript Library to interact with GDK Contracts
315 lines (314 loc) • 19.1 kB
TypeScript
import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PayableOverrides, 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 IDAOIntegration {
type ResourceRecordsStruct = {
existingRole: string;
resource: string;
permissions: string[];
};
type ResourceRecordsStructOutput = [string, string, string[]] & {
existingRole: string;
resource: string;
permissions: string[];
};
}
export interface ICPPingModuleInterface extends utils.Interface {
functions: {
"MODULE_RESOURCE()": FunctionFragment;
"__ICPPingModule_init(string,string)": FunctionFragment;
"__ICPPingModule_initAndSetDeps(address,string,string)": FunctionFragment;
"checkPermission(address,string)": FunctionFragment;
"getInjector()": FunctionFragment;
"getLastMessage()": FunctionFragment;
"getResource()": FunctionFragment;
"getResourceRecords()": FunctionFragment;
"implementation()": FunctionFragment;
"messages(uint256)": FunctionFragment;
"nextMessageId()": FunctionFragment;
"permissionManager()": FunctionFragment;
"ping(string)": FunctionFragment;
"proxiableUUID()": FunctionFragment;
"setDependencies(address,bytes)": FunctionFragment;
"setInjector(address)": FunctionFragment;
"supportsInterface(bytes4)": FunctionFragment;
"upgradeTo(address)": FunctionFragment;
"upgradeToAndCall(address,bytes)": FunctionFragment;
};
getFunction(nameOrSignatureOrTopic: "MODULE_RESOURCE" | "__ICPPingModule_init" | "__ICPPingModule_initAndSetDeps" | "checkPermission" | "getInjector" | "getLastMessage" | "getResource" | "getResourceRecords" | "implementation" | "messages" | "nextMessageId" | "permissionManager" | "ping" | "proxiableUUID" | "setDependencies" | "setInjector" | "supportsInterface" | "upgradeTo" | "upgradeToAndCall"): FunctionFragment;
encodeFunctionData(functionFragment: "MODULE_RESOURCE", values?: undefined): string;
encodeFunctionData(functionFragment: "__ICPPingModule_init", values: [string, string]): string;
encodeFunctionData(functionFragment: "__ICPPingModule_initAndSetDeps", values: [string, string, string]): string;
encodeFunctionData(functionFragment: "checkPermission", values: [string, string]): string;
encodeFunctionData(functionFragment: "getInjector", values?: undefined): string;
encodeFunctionData(functionFragment: "getLastMessage", values?: undefined): string;
encodeFunctionData(functionFragment: "getResource", values?: undefined): string;
encodeFunctionData(functionFragment: "getResourceRecords", values?: undefined): string;
encodeFunctionData(functionFragment: "implementation", values?: undefined): string;
encodeFunctionData(functionFragment: "messages", values: [BigNumberish]): string;
encodeFunctionData(functionFragment: "nextMessageId", values?: undefined): string;
encodeFunctionData(functionFragment: "permissionManager", values?: undefined): string;
encodeFunctionData(functionFragment: "ping", values: [string]): string;
encodeFunctionData(functionFragment: "proxiableUUID", values?: undefined): string;
encodeFunctionData(functionFragment: "setDependencies", values: [string, BytesLike]): string;
encodeFunctionData(functionFragment: "setInjector", values: [string]): string;
encodeFunctionData(functionFragment: "supportsInterface", values: [BytesLike]): string;
encodeFunctionData(functionFragment: "upgradeTo", values: [string]): string;
encodeFunctionData(functionFragment: "upgradeToAndCall", values: [string, BytesLike]): string;
decodeFunctionResult(functionFragment: "MODULE_RESOURCE", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "__ICPPingModule_init", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "__ICPPingModule_initAndSetDeps", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "checkPermission", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getInjector", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getLastMessage", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getResource", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getResourceRecords", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "implementation", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "messages", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "nextMessageId", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "permissionManager", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "ping", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "proxiableUUID", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "setDependencies", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "setInjector", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "supportsInterface", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "upgradeTo", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "upgradeToAndCall", data: BytesLike): Result;
events: {
"AdminChanged(address,address)": EventFragment;
"BeaconUpgraded(address)": EventFragment;
"Initialized(uint8)": EventFragment;
"MessageSent(string)": EventFragment;
"Upgraded(address)": EventFragment;
};
getEvent(nameOrSignatureOrTopic: "AdminChanged"): EventFragment;
getEvent(nameOrSignatureOrTopic: "BeaconUpgraded"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Initialized"): EventFragment;
getEvent(nameOrSignatureOrTopic: "MessageSent"): EventFragment;
getEvent(nameOrSignatureOrTopic: "Upgraded"): EventFragment;
}
export interface AdminChangedEventObject {
previousAdmin: string;
newAdmin: string;
}
export type AdminChangedEvent = TypedEvent<[
string,
string
], AdminChangedEventObject>;
export type AdminChangedEventFilter = TypedEventFilter<AdminChangedEvent>;
export interface BeaconUpgradedEventObject {
beacon: string;
}
export type BeaconUpgradedEvent = TypedEvent<[
string
], BeaconUpgradedEventObject>;
export type BeaconUpgradedEventFilter = TypedEventFilter<BeaconUpgradedEvent>;
export interface InitializedEventObject {
version: number;
}
export type InitializedEvent = TypedEvent<[number], InitializedEventObject>;
export type InitializedEventFilter = TypedEventFilter<InitializedEvent>;
export interface MessageSentEventObject {
message: string;
}
export type MessageSentEvent = TypedEvent<[string], MessageSentEventObject>;
export type MessageSentEventFilter = TypedEventFilter<MessageSentEvent>;
export interface UpgradedEventObject {
implementation: string;
}
export type UpgradedEvent = TypedEvent<[string], UpgradedEventObject>;
export type UpgradedEventFilter = TypedEventFilter<UpgradedEvent>;
export interface ICPPingModule extends BaseContract {
contractName: "ICPPingModule";
connect(signerOrProvider: Signer | Provider | string): this;
attach(addressOrName: string): this;
deployed(): Promise<this>;
interface: ICPPingModuleInterface;
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: {
MODULE_RESOURCE(overrides?: CallOverrides): Promise<[string]>;
__ICPPingModule_init(resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
__ICPPingModule_initAndSetDeps(registry_: string, resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
checkPermission(member_: string, permission_: string, overrides?: CallOverrides): Promise<[boolean]>;
getInjector(overrides?: CallOverrides): Promise<[string] & {
injector_: string;
}>;
getLastMessage(overrides?: CallOverrides): Promise<[string]>;
getResource(overrides?: CallOverrides): Promise<[string]>;
getResourceRecords(overrides?: CallOverrides): Promise<[
IDAOIntegration.ResourceRecordsStructOutput[]
] & {
records_: IDAOIntegration.ResourceRecordsStructOutput[];
}>;
implementation(overrides?: CallOverrides): Promise<[string]>;
messages(messageId: BigNumberish, overrides?: CallOverrides): Promise<[string]>;
nextMessageId(overrides?: CallOverrides): Promise<[BigNumber]>;
permissionManager(overrides?: CallOverrides): Promise<[string]>;
ping(message: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
proxiableUUID(overrides?: CallOverrides): Promise<[string]>;
setDependencies(registry_: string, arg1: BytesLike, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
setInjector(injector_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<[boolean]>;
upgradeTo(newImplementation: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
upgradeToAndCall(newImplementation: string, data: BytesLike, overrides?: PayableOverrides & {
from?: string;
}): Promise<ContractTransaction>;
};
MODULE_RESOURCE(overrides?: CallOverrides): Promise<string>;
__ICPPingModule_init(resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
__ICPPingModule_initAndSetDeps(registry_: string, resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
checkPermission(member_: string, permission_: string, overrides?: CallOverrides): Promise<boolean>;
getInjector(overrides?: CallOverrides): Promise<string>;
getLastMessage(overrides?: CallOverrides): Promise<string>;
getResource(overrides?: CallOverrides): Promise<string>;
getResourceRecords(overrides?: CallOverrides): Promise<IDAOIntegration.ResourceRecordsStructOutput[]>;
implementation(overrides?: CallOverrides): Promise<string>;
messages(messageId: BigNumberish, overrides?: CallOverrides): Promise<string>;
nextMessageId(overrides?: CallOverrides): Promise<BigNumber>;
permissionManager(overrides?: CallOverrides): Promise<string>;
ping(message: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
proxiableUUID(overrides?: CallOverrides): Promise<string>;
setDependencies(registry_: string, arg1: BytesLike, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
setInjector(injector_: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<boolean>;
upgradeTo(newImplementation: string, overrides?: Overrides & {
from?: string;
}): Promise<ContractTransaction>;
upgradeToAndCall(newImplementation: string, data: BytesLike, overrides?: PayableOverrides & {
from?: string;
}): Promise<ContractTransaction>;
callStatic: {
MODULE_RESOURCE(overrides?: CallOverrides): Promise<string>;
__ICPPingModule_init(resource_: string, relatedExpertPanelName_: string, overrides?: CallOverrides): Promise<void>;
__ICPPingModule_initAndSetDeps(registry_: string, resource_: string, relatedExpertPanelName_: string, overrides?: CallOverrides): Promise<void>;
checkPermission(member_: string, permission_: string, overrides?: CallOverrides): Promise<boolean>;
getInjector(overrides?: CallOverrides): Promise<string>;
getLastMessage(overrides?: CallOverrides): Promise<string>;
getResource(overrides?: CallOverrides): Promise<string>;
getResourceRecords(overrides?: CallOverrides): Promise<IDAOIntegration.ResourceRecordsStructOutput[]>;
implementation(overrides?: CallOverrides): Promise<string>;
messages(messageId: BigNumberish, overrides?: CallOverrides): Promise<string>;
nextMessageId(overrides?: CallOverrides): Promise<BigNumber>;
permissionManager(overrides?: CallOverrides): Promise<string>;
ping(message: string, overrides?: CallOverrides): Promise<void>;
proxiableUUID(overrides?: CallOverrides): Promise<string>;
setDependencies(registry_: string, arg1: BytesLike, overrides?: CallOverrides): Promise<void>;
setInjector(injector_: string, overrides?: CallOverrides): Promise<void>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<boolean>;
upgradeTo(newImplementation: string, overrides?: CallOverrides): Promise<void>;
upgradeToAndCall(newImplementation: string, data: BytesLike, overrides?: CallOverrides): Promise<void>;
};
filters: {
"AdminChanged(address,address)"(previousAdmin?: null, newAdmin?: null): AdminChangedEventFilter;
AdminChanged(previousAdmin?: null, newAdmin?: null): AdminChangedEventFilter;
"BeaconUpgraded(address)"(beacon?: string | null): BeaconUpgradedEventFilter;
BeaconUpgraded(beacon?: string | null): BeaconUpgradedEventFilter;
"Initialized(uint8)"(version?: null): InitializedEventFilter;
Initialized(version?: null): InitializedEventFilter;
"MessageSent(string)"(message?: null): MessageSentEventFilter;
MessageSent(message?: null): MessageSentEventFilter;
"Upgraded(address)"(implementation?: string | null): UpgradedEventFilter;
Upgraded(implementation?: string | null): UpgradedEventFilter;
};
estimateGas: {
MODULE_RESOURCE(overrides?: CallOverrides): Promise<BigNumber>;
__ICPPingModule_init(resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
__ICPPingModule_initAndSetDeps(registry_: string, resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
checkPermission(member_: string, permission_: string, overrides?: CallOverrides): Promise<BigNumber>;
getInjector(overrides?: CallOverrides): Promise<BigNumber>;
getLastMessage(overrides?: CallOverrides): Promise<BigNumber>;
getResource(overrides?: CallOverrides): Promise<BigNumber>;
getResourceRecords(overrides?: CallOverrides): Promise<BigNumber>;
implementation(overrides?: CallOverrides): Promise<BigNumber>;
messages(messageId: BigNumberish, overrides?: CallOverrides): Promise<BigNumber>;
nextMessageId(overrides?: CallOverrides): Promise<BigNumber>;
permissionManager(overrides?: CallOverrides): Promise<BigNumber>;
ping(message: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
proxiableUUID(overrides?: CallOverrides): Promise<BigNumber>;
setDependencies(registry_: string, arg1: BytesLike, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
setInjector(injector_: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<BigNumber>;
upgradeTo(newImplementation: string, overrides?: Overrides & {
from?: string;
}): Promise<BigNumber>;
upgradeToAndCall(newImplementation: string, data: BytesLike, overrides?: PayableOverrides & {
from?: string;
}): Promise<BigNumber>;
};
populateTransaction: {
MODULE_RESOURCE(overrides?: CallOverrides): Promise<PopulatedTransaction>;
__ICPPingModule_init(resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
__ICPPingModule_initAndSetDeps(registry_: string, resource_: string, relatedExpertPanelName_: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
checkPermission(member_: string, permission_: string, overrides?: CallOverrides): Promise<PopulatedTransaction>;
getInjector(overrides?: CallOverrides): Promise<PopulatedTransaction>;
getLastMessage(overrides?: CallOverrides): Promise<PopulatedTransaction>;
getResource(overrides?: CallOverrides): Promise<PopulatedTransaction>;
getResourceRecords(overrides?: CallOverrides): Promise<PopulatedTransaction>;
implementation(overrides?: CallOverrides): Promise<PopulatedTransaction>;
messages(messageId: BigNumberish, overrides?: CallOverrides): Promise<PopulatedTransaction>;
nextMessageId(overrides?: CallOverrides): Promise<PopulatedTransaction>;
permissionManager(overrides?: CallOverrides): Promise<PopulatedTransaction>;
ping(message: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
proxiableUUID(overrides?: CallOverrides): Promise<PopulatedTransaction>;
setDependencies(registry_: string, arg1: BytesLike, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
setInjector(injector_: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
supportsInterface(interfaceId: BytesLike, overrides?: CallOverrides): Promise<PopulatedTransaction>;
upgradeTo(newImplementation: string, overrides?: Overrides & {
from?: string;
}): Promise<PopulatedTransaction>;
upgradeToAndCall(newImplementation: string, data: BytesLike, overrides?: PayableOverrides & {
from?: string;
}): Promise<PopulatedTransaction>;
};
}