UNPKG

@q-dev/q-js-sdk

Version:

Typescript Library to interact with Q System Contracts

317 lines (316 loc) 21.2 kB
import type { BaseContract, BigNumber, BigNumberish, BytesLike, CallOverrides, ContractTransaction, Overrides, PopulatedTransaction, Signer, utils } from "ethers"; import type { FunctionFragment, Result } from "@ethersproject/abi"; import type { Listener, Provider } from "@ethersproject/providers"; import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "./common"; export declare namespace IContractRegistry { type PairStruct = { key: PromiseOrValue<string>; contractAddress: PromiseOrValue<string>; }; type PairStructOutput = [string, string] & { key: string; contractAddress: string; }; } export interface ContractRegistryInterface extends utils.Interface { functions: { "MAX_CALLS()": FunctionFragment; "VERSION()": FunctionFragment; "__ContractRegistryUpgrader_init()": FunctionFragment; "contains(string)": FunctionFragment; "getAddress(string)": FunctionFragment; "getContracts()": FunctionFragment; "getImplementation(address)": FunctionFragment; "getMaintainers()": FunctionFragment; "initialize(address[],string[],address[])": FunctionFragment; "isInitialized(uint256)": FunctionFragment; "leaveMaintainers()": FunctionFragment; "multicall(bytes[])": FunctionFragment; "mustGetAddress(string)": FunctionFragment; "proxyAdmin()": FunctionFragment; "removeKey(string)": FunctionFragment; "removeKeys(string[])": FunctionFragment; "setAddress(string,address)": FunctionFragment; "setAddresses(string[],address[])": FunctionFragment; "setMaintainer(address)": FunctionFragment; "upgradeContract(address,address)": FunctionFragment; "upgradeContractAndCall(address,address,bytes)": FunctionFragment; }; getFunction(nameOrSignatureOrTopic: "MAX_CALLS" | "VERSION" | "__ContractRegistryUpgrader_init" | "contains" | "getAddress" | "getContracts" | "getImplementation" | "getMaintainers" | "initialize" | "isInitialized" | "leaveMaintainers" | "multicall" | "mustGetAddress" | "proxyAdmin" | "removeKey" | "removeKeys" | "setAddress" | "setAddresses" | "setMaintainer" | "upgradeContract" | "upgradeContractAndCall"): FunctionFragment; encodeFunctionData(functionFragment: "MAX_CALLS", values?: undefined): string; encodeFunctionData(functionFragment: "VERSION", values?: undefined): string; encodeFunctionData(functionFragment: "__ContractRegistryUpgrader_init", values?: undefined): string; encodeFunctionData(functionFragment: "contains", values: [PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "getAddress", values: [PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "getContracts", values?: undefined): string; encodeFunctionData(functionFragment: "getImplementation", values: [PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "getMaintainers", values?: undefined): string; encodeFunctionData(functionFragment: "initialize", values: [ PromiseOrValue<string>[], PromiseOrValue<string>[], PromiseOrValue<string>[] ]): string; encodeFunctionData(functionFragment: "isInitialized", values: [PromiseOrValue<BigNumberish>]): string; encodeFunctionData(functionFragment: "leaveMaintainers", values?: undefined): string; encodeFunctionData(functionFragment: "multicall", values: [PromiseOrValue<BytesLike>[]]): string; encodeFunctionData(functionFragment: "mustGetAddress", values: [PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "proxyAdmin", values?: undefined): string; encodeFunctionData(functionFragment: "removeKey", values: [PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "removeKeys", values: [PromiseOrValue<string>[]]): string; encodeFunctionData(functionFragment: "setAddress", values: [PromiseOrValue<string>, PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "setAddresses", values: [PromiseOrValue<string>[], PromiseOrValue<string>[]]): string; encodeFunctionData(functionFragment: "setMaintainer", values: [PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "upgradeContract", values: [PromiseOrValue<string>, PromiseOrValue<string>]): string; encodeFunctionData(functionFragment: "upgradeContractAndCall", values: [ PromiseOrValue<string>, PromiseOrValue<string>, PromiseOrValue<BytesLike> ]): string; decodeFunctionResult(functionFragment: "MAX_CALLS", data: BytesLike): Result; decodeFunctionResult(functionFragment: "VERSION", data: BytesLike): Result; decodeFunctionResult(functionFragment: "__ContractRegistryUpgrader_init", data: BytesLike): Result; decodeFunctionResult(functionFragment: "contains", data: BytesLike): Result; decodeFunctionResult(functionFragment: "getAddress", data: BytesLike): Result; decodeFunctionResult(functionFragment: "getContracts", data: BytesLike): Result; decodeFunctionResult(functionFragment: "getImplementation", data: BytesLike): Result; decodeFunctionResult(functionFragment: "getMaintainers", data: BytesLike): Result; decodeFunctionResult(functionFragment: "initialize", data: BytesLike): Result; decodeFunctionResult(functionFragment: "isInitialized", data: BytesLike): Result; decodeFunctionResult(functionFragment: "leaveMaintainers", data: BytesLike): Result; decodeFunctionResult(functionFragment: "multicall", data: BytesLike): Result; decodeFunctionResult(functionFragment: "mustGetAddress", data: BytesLike): Result; decodeFunctionResult(functionFragment: "proxyAdmin", data: BytesLike): Result; decodeFunctionResult(functionFragment: "removeKey", data: BytesLike): Result; decodeFunctionResult(functionFragment: "removeKeys", data: BytesLike): Result; decodeFunctionResult(functionFragment: "setAddress", data: BytesLike): Result; decodeFunctionResult(functionFragment: "setAddresses", data: BytesLike): Result; decodeFunctionResult(functionFragment: "setMaintainer", data: BytesLike): Result; decodeFunctionResult(functionFragment: "upgradeContract", data: BytesLike): Result; decodeFunctionResult(functionFragment: "upgradeContractAndCall", data: BytesLike): Result; events: {}; } export interface ContractRegistry extends BaseContract { connect(signerOrProvider: Signer | Provider | string): this; attach(addressOrName: string): this; deployed(): Promise<this>; interface: ContractRegistryInterface; 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: { MAX_CALLS(overrides?: CallOverrides): Promise<[BigNumber]>; VERSION(overrides?: CallOverrides): Promise<[BigNumber]>; __ContractRegistryUpgrader_init(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; contains(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[boolean]>; getAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[string]>; getContracts(overrides?: CallOverrides): Promise<[IContractRegistry.PairStructOutput[]]>; getImplementation(proxy_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; getMaintainers(overrides?: CallOverrides): Promise<[string[]]>; initialize(maintainerList_: PromiseOrValue<string>[], keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; isInitialized(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[boolean]>; leaveMaintainers(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; multicall(data_: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; mustGetAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[string]>; proxyAdmin(overrides?: CallOverrides): Promise<[string]>; removeKey(key_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; removeKeys(keys_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; setAddress(key_: PromiseOrValue<string>, address_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; setAddresses(keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; setMaintainer(maintainer_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; upgradeContract(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; upgradeContractAndCall(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, data_: PromiseOrValue<BytesLike>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; }; MAX_CALLS(overrides?: CallOverrides): Promise<BigNumber>; VERSION(overrides?: CallOverrides): Promise<BigNumber>; __ContractRegistryUpgrader_init(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; contains(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>; getAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>; getContracts(overrides?: CallOverrides): Promise<IContractRegistry.PairStructOutput[]>; getImplementation(proxy_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; getMaintainers(overrides?: CallOverrides): Promise<string[]>; initialize(maintainerList_: PromiseOrValue<string>[], keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; isInitialized(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>; leaveMaintainers(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; multicall(data_: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; mustGetAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>; proxyAdmin(overrides?: CallOverrides): Promise<string>; removeKey(key_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; removeKeys(keys_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; setAddress(key_: PromiseOrValue<string>, address_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; setAddresses(keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; setMaintainer(maintainer_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; upgradeContract(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; upgradeContractAndCall(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, data_: PromiseOrValue<BytesLike>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<ContractTransaction>; callStatic: { MAX_CALLS(overrides?: CallOverrides): Promise<BigNumber>; VERSION(overrides?: CallOverrides): Promise<BigNumber>; __ContractRegistryUpgrader_init(overrides?: CallOverrides): Promise<void>; contains(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>; getAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>; getContracts(overrides?: CallOverrides): Promise<IContractRegistry.PairStructOutput[]>; getImplementation(proxy_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>; getMaintainers(overrides?: CallOverrides): Promise<string[]>; initialize(maintainerList_: PromiseOrValue<string>[], keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: CallOverrides): Promise<void>; isInitialized(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<boolean>; leaveMaintainers(overrides?: CallOverrides): Promise<void>; multicall(data_: PromiseOrValue<BytesLike>[], overrides?: CallOverrides): Promise<string[]>; mustGetAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<string>; proxyAdmin(overrides?: CallOverrides): Promise<string>; removeKey(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>; removeKeys(keys_: PromiseOrValue<string>[], overrides?: CallOverrides): Promise<void>; setAddress(key_: PromiseOrValue<string>, address_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>; setAddresses(keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: CallOverrides): Promise<void>; setMaintainer(maintainer_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>; upgradeContract(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<void>; upgradeContractAndCall(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, data_: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<void>; }; filters: {}; estimateGas: { MAX_CALLS(overrides?: CallOverrides): Promise<BigNumber>; VERSION(overrides?: CallOverrides): Promise<BigNumber>; __ContractRegistryUpgrader_init(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; contains(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>; getAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>; getContracts(overrides?: CallOverrides): Promise<BigNumber>; getImplementation(proxy_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; getMaintainers(overrides?: CallOverrides): Promise<BigNumber>; initialize(maintainerList_: PromiseOrValue<string>[], keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; isInitialized(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>; leaveMaintainers(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; multicall(data_: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; mustGetAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>; proxyAdmin(overrides?: CallOverrides): Promise<BigNumber>; removeKey(key_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; removeKeys(keys_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; setAddress(key_: PromiseOrValue<string>, address_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; setAddresses(keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; setMaintainer(maintainer_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; upgradeContract(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; upgradeContractAndCall(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, data_: PromiseOrValue<BytesLike>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<BigNumber>; }; populateTransaction: { MAX_CALLS(overrides?: CallOverrides): Promise<PopulatedTransaction>; VERSION(overrides?: CallOverrides): Promise<PopulatedTransaction>; __ContractRegistryUpgrader_init(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; contains(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>; getAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>; getContracts(overrides?: CallOverrides): Promise<PopulatedTransaction>; getImplementation(proxy_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; getMaintainers(overrides?: CallOverrides): Promise<PopulatedTransaction>; initialize(maintainerList_: PromiseOrValue<string>[], keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; isInitialized(arg0: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<PopulatedTransaction>; leaveMaintainers(overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; multicall(data_: PromiseOrValue<BytesLike>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; mustGetAddress(key_: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>; proxyAdmin(overrides?: CallOverrides): Promise<PopulatedTransaction>; removeKey(key_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; removeKeys(keys_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; setAddress(key_: PromiseOrValue<string>, address_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; setAddresses(keys_: PromiseOrValue<string>[], addresses_: PromiseOrValue<string>[], overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; setMaintainer(maintainer_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; upgradeContract(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; upgradeContractAndCall(proxy_: PromiseOrValue<string>, newImplementation_: PromiseOrValue<string>, data_: PromiseOrValue<BytesLike>, overrides?: Overrides & { from?: PromiseOrValue<string>; }): Promise<PopulatedTransaction>; }; }