Struct PermissionControllerInstance

pub struct PermissionControllerInstance<T, P, N = Ethereum> { /* private fields */ }

A PermissionController instance.

Contains type-safe methods for interacting with an on-chain instance of the
[`PermissionController`](self) contract located at a given `address`, using a given
provider `P`.

If the contract bytecode is available (see the [`sol!`](alloy_sol_types::sol!)
documentation on how to provide it), the `deploy` and `deploy_builder` methods can
be used to deploy a new instance of the contract.

See the [module-level documentation](self) for all the available methods.

Implementations

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> PermissionControllerInstance<T, P, N>

Instantiation and getters/setters.

pub const fn new(address: Address, provider: P) -> Self

Creates a new wrapper around an on-chain PermissionController contract instance.

    See the [wrapper's documentation](`PermissionControllerInstance`) for more details.

pub async fn deploy( provider: P, _version: String, ) -> Result<PermissionControllerInstance<T, P, N>>

Deploys this contract using the given provider and constructor arguments, if any.

    Returns a new instance of the contract, if the deployment was successful.

    For more fine-grained control over the deployment process, use [`deploy_builder`] instead.

pub fn deploy_builder(provider: P, _version: String) -> RawCallBuilder<T, P, N>

Creates a RawCallBuilder for deploying this contract using the given provider and constructor arguments, if any.

    This is a simple wrapper around creating a `RawCallBuilder` with the data set to
    the bytecode concatenated with the constructor's ABI-encoded arguments.

pub const fn address(&self) -> &Address

Returns a reference to the address.

pub fn set_address(&mut self, address: Address)

Sets the address.

pub fn at(self, address: Address) -> Self

Sets the address and returns self.

pub const fn provider(&self) -> &P

Returns a reference to the provider.

impl<T, P: Clone, N> PermissionControllerInstance<T, &P, N>

pub fn with_cloned_provider(self) -> PermissionControllerInstance<T, P, N>

Clones the provider and returns a new instance with the cloned provider.

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> PermissionControllerInstance<T, P, N>

Function calls.

pub fn call_builder<C: SolCall>(&self, call: &C) -> SolCallBuilder<T, &P, C, N>

Creates a new call builder using this contract instance’s provider and address.

Note that the call can be any function call, not just those defined in this contract. Prefer using the other methods for building type-safe contract calls.

pub fn acceptAdmin( &self, account: Address, ) -> SolCallBuilder<T, &P, acceptAdminCall, N>

Creates a new call builder for the [acceptAdmin] function.

pub fn addPendingAdmin( &self, account: Address, admin: Address, ) -> SolCallBuilder<T, &P, addPendingAdminCall, N>

Creates a new call builder for the [addPendingAdmin] function.

pub fn canCall( &self, account: Address, caller: Address, target: Address, selector: FixedBytes<4>, ) -> SolCallBuilder<T, &P, canCallCall, N>

Creates a new call builder for the [canCall] function.

pub fn getAdmins( &self, account: Address, ) -> SolCallBuilder<T, &P, getAdminsCall, N>

Creates a new call builder for the [getAdmins] function.

pub fn getAppointeePermissions( &self, account: Address, appointee: Address, ) -> SolCallBuilder<T, &P, getAppointeePermissionsCall, N>

Creates a new call builder for the [getAppointeePermissions] function.

pub fn getAppointees( &self, account: Address, target: Address, selector: FixedBytes<4>, ) -> SolCallBuilder<T, &P, getAppointeesCall, N>

Creates a new call builder for the [getAppointees] function.

pub fn getPendingAdmins( &self, account: Address, ) -> SolCallBuilder<T, &P, getPendingAdminsCall, N>

Creates a new call builder for the [getPendingAdmins] function.

pub fn isAdmin( &self, account: Address, caller: Address, ) -> SolCallBuilder<T, &P, isAdminCall, N>

Creates a new call builder for the [isAdmin] function.

pub fn isPendingAdmin( &self, account: Address, pendingAdmin: Address, ) -> SolCallBuilder<T, &P, isPendingAdminCall, N>

Creates a new call builder for the [isPendingAdmin] function.

pub fn removeAdmin( &self, account: Address, admin: Address, ) -> SolCallBuilder<T, &P, removeAdminCall, N>

Creates a new call builder for the [removeAdmin] function.

pub fn removeAppointee( &self, account: Address, appointee: Address, target: Address, selector: FixedBytes<4>, ) -> SolCallBuilder<T, &P, removeAppointeeCall, N>

Creates a new call builder for the [removeAppointee] function.

pub fn removePendingAdmin( &self, account: Address, admin: Address, ) -> SolCallBuilder<T, &P, removePendingAdminCall, N>

Creates a new call builder for the [removePendingAdmin] function.

pub fn setAppointee( &self, account: Address, appointee: Address, target: Address, selector: FixedBytes<4>, ) -> SolCallBuilder<T, &P, setAppointeeCall, N>

Creates a new call builder for the [setAppointee] function.

pub fn version(&self) -> SolCallBuilder<T, &P, versionCall, N>

Creates a new call builder for the [version] function.

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> PermissionControllerInstance<T, P, N>

Event filters.

pub fn event_filter<E: SolEvent>(&self) -> Event<T, &P, E, N>

Creates a new event filter using this contract instance’s provider and address.

Note that the type can be any event, not just those defined in this contract. Prefer using the other methods for building type-safe event filters.

pub fn AdminRemoved_filter(&self) -> Event<T, &P, AdminRemoved, N>

Creates a new event filter for the AdminRemoved event.

pub fn AdminSet_filter(&self) -> Event<T, &P, AdminSet, N>

Creates a new event filter for the AdminSet event.

pub fn AppointeeRemoved_filter(&self) -> Event<T, &P, AppointeeRemoved, N>

Creates a new event filter for the AppointeeRemoved event.

pub fn AppointeeSet_filter(&self) -> Event<T, &P, AppointeeSet, N>

Creates a new event filter for the AppointeeSet event.

pub fn Initialized_filter(&self) -> Event<T, &P, Initialized, N>

Creates a new event filter for the Initialized event.

pub fn PendingAdminAdded_filter(&self) -> Event<T, &P, PendingAdminAdded, N>

Creates a new event filter for the PendingAdminAdded event.

pub fn PendingAdminRemoved_filter(&self) -> Event<T, &P, PendingAdminRemoved, N>

Creates a new event filter for the PendingAdminRemoved event.

Trait Implementations

impl<T: Clone, P: Clone, N: Clone> Clone for PermissionControllerInstance<T, P, N>

fn clone(&self) -> PermissionControllerInstance<T, P, N>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T, P, N> Debug for PermissionControllerInstance<T, P, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.