@wttp/site
Version:
Web3 Transfer Protocol (WTTP) - Site Contracts and deployment tools
209 lines • 11.6 kB
TypeScript
import type { BaseContract, BytesLike, FunctionFragment, Result, Interface, EventFragment, AddressLike, ContractRunner, ContractMethod, Listener } from "ethers";
import type { TypedContractEvent, TypedDeferredTopicFilter, TypedEventLog, TypedLogDescription, TypedListener, TypedContractMethod } from "../common";
export interface BaseWTTPPermissionsInterface extends Interface {
getFunction(nameOrSignature: "DEFAULT_ADMIN_ROLE" | "changeSiteAdmin" | "createResourceRole" | "getRoleAdmin" | "getSiteAdminRole" | "grantRole" | "hasRole" | "renounceRole" | "revokeRole" | "supportsInterface"): FunctionFragment;
getEvent(nameOrSignatureOrTopic: "ResourceRoleCreated" | "RoleAdminChanged" | "RoleGranted" | "RoleRevoked" | "SiteAdminChanged"): EventFragment;
encodeFunctionData(functionFragment: "DEFAULT_ADMIN_ROLE", values?: undefined): string;
encodeFunctionData(functionFragment: "changeSiteAdmin", values: [BytesLike]): string;
encodeFunctionData(functionFragment: "createResourceRole", values: [BytesLike]): string;
encodeFunctionData(functionFragment: "getRoleAdmin", values: [BytesLike]): string;
encodeFunctionData(functionFragment: "getSiteAdminRole", values?: undefined): string;
encodeFunctionData(functionFragment: "grantRole", values: [BytesLike, AddressLike]): string;
encodeFunctionData(functionFragment: "hasRole", values: [BytesLike, AddressLike]): string;
encodeFunctionData(functionFragment: "renounceRole", values: [BytesLike, AddressLike]): string;
encodeFunctionData(functionFragment: "revokeRole", values: [BytesLike, AddressLike]): string;
encodeFunctionData(functionFragment: "supportsInterface", values: [BytesLike]): string;
decodeFunctionResult(functionFragment: "DEFAULT_ADMIN_ROLE", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "changeSiteAdmin", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "createResourceRole", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getRoleAdmin", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "getSiteAdminRole", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "grantRole", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "hasRole", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "renounceRole", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "revokeRole", data: BytesLike): Result;
decodeFunctionResult(functionFragment: "supportsInterface", data: BytesLike): Result;
}
export declare namespace ResourceRoleCreatedEvent {
type InputTuple = [role: BytesLike];
type OutputTuple = [role: string];
interface OutputObject {
role: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace RoleAdminChangedEvent {
type InputTuple = [
role: BytesLike,
previousAdminRole: BytesLike,
newAdminRole: BytesLike
];
type OutputTuple = [
role: string,
previousAdminRole: string,
newAdminRole: string
];
interface OutputObject {
role: string;
previousAdminRole: string;
newAdminRole: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace RoleGrantedEvent {
type InputTuple = [
role: BytesLike,
account: AddressLike,
sender: AddressLike
];
type OutputTuple = [role: string, account: string, sender: string];
interface OutputObject {
role: string;
account: string;
sender: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace RoleRevokedEvent {
type InputTuple = [
role: BytesLike,
account: AddressLike,
sender: AddressLike
];
type OutputTuple = [role: string, account: string, sender: string];
interface OutputObject {
role: string;
account: string;
sender: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export declare namespace SiteAdminChangedEvent {
type InputTuple = [oldSiteAdmin: BytesLike, newSiteAdmin: BytesLike];
type OutputTuple = [oldSiteAdmin: string, newSiteAdmin: string];
interface OutputObject {
oldSiteAdmin: string;
newSiteAdmin: string;
}
type Event = TypedContractEvent<InputTuple, OutputTuple, OutputObject>;
type Filter = TypedDeferredTopicFilter<Event>;
type Log = TypedEventLog<Event>;
type LogDescription = TypedLogDescription<Event>;
}
export interface BaseWTTPPermissions extends BaseContract {
connect(runner?: ContractRunner | null): BaseWTTPPermissions;
waitForDeployment(): Promise<this>;
interface: BaseWTTPPermissionsInterface;
queryFilter<TCEvent extends TypedContractEvent>(event: TCEvent, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TypedEventLog<TCEvent>>>;
queryFilter<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TypedEventLog<TCEvent>>>;
on<TCEvent extends TypedContractEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<this>;
on<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<this>;
once<TCEvent extends TypedContractEvent>(event: TCEvent, listener: TypedListener<TCEvent>): Promise<this>;
once<TCEvent extends TypedContractEvent>(filter: TypedDeferredTopicFilter<TCEvent>, listener: TypedListener<TCEvent>): Promise<this>;
listeners<TCEvent extends TypedContractEvent>(event: TCEvent): Promise<Array<TypedListener<TCEvent>>>;
listeners(eventName?: string): Promise<Array<Listener>>;
removeAllListeners<TCEvent extends TypedContractEvent>(event?: TCEvent): Promise<this>;
DEFAULT_ADMIN_ROLE: TypedContractMethod<[], [string], "view">;
changeSiteAdmin: TypedContractMethod<[
_newSiteAdmin: BytesLike
], [
void
], "nonpayable">;
createResourceRole: TypedContractMethod<[
_role: BytesLike
], [
void
], "nonpayable">;
getRoleAdmin: TypedContractMethod<[role: BytesLike], [string], "view">;
getSiteAdminRole: TypedContractMethod<[], [string], "view">;
grantRole: TypedContractMethod<[
role: BytesLike,
account: AddressLike
], [
void
], "nonpayable">;
hasRole: TypedContractMethod<[
role: BytesLike,
account: AddressLike
], [
boolean
], "view">;
renounceRole: TypedContractMethod<[
role: BytesLike,
callerConfirmation: AddressLike
], [
void
], "nonpayable">;
revokeRole: TypedContractMethod<[
role: BytesLike,
account: AddressLike
], [
void
], "nonpayable">;
supportsInterface: TypedContractMethod<[
interfaceId: BytesLike
], [
boolean
], "view">;
getFunction<T extends ContractMethod = ContractMethod>(key: string | FunctionFragment): T;
getFunction(nameOrSignature: "DEFAULT_ADMIN_ROLE"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "changeSiteAdmin"): TypedContractMethod<[_newSiteAdmin: BytesLike], [void], "nonpayable">;
getFunction(nameOrSignature: "createResourceRole"): TypedContractMethod<[_role: BytesLike], [void], "nonpayable">;
getFunction(nameOrSignature: "getRoleAdmin"): TypedContractMethod<[role: BytesLike], [string], "view">;
getFunction(nameOrSignature: "getSiteAdminRole"): TypedContractMethod<[], [string], "view">;
getFunction(nameOrSignature: "grantRole"): TypedContractMethod<[
role: BytesLike,
account: AddressLike
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "hasRole"): TypedContractMethod<[
role: BytesLike,
account: AddressLike
], [
boolean
], "view">;
getFunction(nameOrSignature: "renounceRole"): TypedContractMethod<[
role: BytesLike,
callerConfirmation: AddressLike
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "revokeRole"): TypedContractMethod<[
role: BytesLike,
account: AddressLike
], [
void
], "nonpayable">;
getFunction(nameOrSignature: "supportsInterface"): TypedContractMethod<[interfaceId: BytesLike], [boolean], "view">;
getEvent(key: "ResourceRoleCreated"): TypedContractEvent<ResourceRoleCreatedEvent.InputTuple, ResourceRoleCreatedEvent.OutputTuple, ResourceRoleCreatedEvent.OutputObject>;
getEvent(key: "RoleAdminChanged"): TypedContractEvent<RoleAdminChangedEvent.InputTuple, RoleAdminChangedEvent.OutputTuple, RoleAdminChangedEvent.OutputObject>;
getEvent(key: "RoleGranted"): TypedContractEvent<RoleGrantedEvent.InputTuple, RoleGrantedEvent.OutputTuple, RoleGrantedEvent.OutputObject>;
getEvent(key: "RoleRevoked"): TypedContractEvent<RoleRevokedEvent.InputTuple, RoleRevokedEvent.OutputTuple, RoleRevokedEvent.OutputObject>;
getEvent(key: "SiteAdminChanged"): TypedContractEvent<SiteAdminChangedEvent.InputTuple, SiteAdminChangedEvent.OutputTuple, SiteAdminChangedEvent.OutputObject>;
filters: {
"ResourceRoleCreated(bytes32)": TypedContractEvent<ResourceRoleCreatedEvent.InputTuple, ResourceRoleCreatedEvent.OutputTuple, ResourceRoleCreatedEvent.OutputObject>;
ResourceRoleCreated: TypedContractEvent<ResourceRoleCreatedEvent.InputTuple, ResourceRoleCreatedEvent.OutputTuple, ResourceRoleCreatedEvent.OutputObject>;
"RoleAdminChanged(bytes32,bytes32,bytes32)": TypedContractEvent<RoleAdminChangedEvent.InputTuple, RoleAdminChangedEvent.OutputTuple, RoleAdminChangedEvent.OutputObject>;
RoleAdminChanged: TypedContractEvent<RoleAdminChangedEvent.InputTuple, RoleAdminChangedEvent.OutputTuple, RoleAdminChangedEvent.OutputObject>;
"RoleGranted(bytes32,address,address)": TypedContractEvent<RoleGrantedEvent.InputTuple, RoleGrantedEvent.OutputTuple, RoleGrantedEvent.OutputObject>;
RoleGranted: TypedContractEvent<RoleGrantedEvent.InputTuple, RoleGrantedEvent.OutputTuple, RoleGrantedEvent.OutputObject>;
"RoleRevoked(bytes32,address,address)": TypedContractEvent<RoleRevokedEvent.InputTuple, RoleRevokedEvent.OutputTuple, RoleRevokedEvent.OutputObject>;
RoleRevoked: TypedContractEvent<RoleRevokedEvent.InputTuple, RoleRevokedEvent.OutputTuple, RoleRevokedEvent.OutputObject>;
"SiteAdminChanged(bytes32,bytes32)": TypedContractEvent<SiteAdminChangedEvent.InputTuple, SiteAdminChangedEvent.OutputTuple, SiteAdminChangedEvent.OutputObject>;
SiteAdminChanged: TypedContractEvent<SiteAdminChangedEvent.InputTuple, SiteAdminChangedEvent.OutputTuple, SiteAdminChangedEvent.OutputObject>;
};
}
//# sourceMappingURL=BaseWTTPPermissions.d.ts.map