Struct TimelockController

pub struct TimelockController<M>(/* private fields */);

Implementations

impl<M: Middleware> TimelockController<M>

pub fn new<T: Into<Address>>(address: T, client: Arc<M>) -> Self

Creates a new contract instance with the specified ethers client at address. The contract derefs to a ethers::Contract object.

pub fn deploy<T: Tokenize>( client: Arc<M>, constructor_args: T, ) -> Result<ContractDeployer<M, Self>, ContractError<M>>

Constructs the general purpose Deployer instance based on the provided constructor arguments and sends it. Returns a new instance of a deployer that returns an instance of this contract after sending the transaction

Notes:

• If there are no constructor arguments, you should pass () as the argument.
• The default poll duration is 7 seconds.
• The default number of confirmations is 1 block.

Example

Generate contract bindings with abigen! and deploy a new contract instance.

Note: this requires a bytecode and abi object in the greeter.json artifact.

    abigen!(Greeter, "../greeter.json");

   let greeter_contract = Greeter::deploy(client, "Hello world!".to_string()).unwrap().send().await.unwrap();
   let msg = greeter_contract.greet().call().await.unwrap();

pub fn canceller_role(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s CANCELLER_ROLE (0xb08e51c0) function

pub fn default_admin_role(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s DEFAULT_ADMIN_ROLE (0xa217fddf) function

pub fn executor_role(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s EXECUTOR_ROLE (0x07bd0265) function

pub fn proposer_role(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s PROPOSER_ROLE (0x8f61f4f5) function

pub fn timelock_admin_role(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s TIMELOCK_ADMIN_ROLE (0x0d3cf6fc) function

pub fn cancel(&self, id: [u8; 32]) -> ContractCall<M, ()>

Calls the contract’s cancel (0xc4d252f5) function

pub fn execute( &self, target: Address, value: U256, payload: Bytes, predecessor: [u8; 32], salt: [u8; 32], ) -> ContractCall<M, ()>

Calls the contract’s execute (0x134008d3) function

pub fn execute_batch( &self, targets: Vec<Address>, values: Vec<U256>, payloads: Vec<Bytes>, predecessor: [u8; 32], salt: [u8; 32], ) -> ContractCall<M, ()>

Calls the contract’s executeBatch (0xe38335e5) function

pub fn get_min_delay(&self) -> ContractCall<M, U256>

Calls the contract’s getMinDelay (0xf27a0c92) function

pub fn get_role_admin(&self, role: [u8; 32]) -> ContractCall<M, [u8; 32]>

Calls the contract’s getRoleAdmin (0x248a9ca3) function

pub fn get_timestamp(&self, id: [u8; 32]) -> ContractCall<M, U256>

Calls the contract’s getTimestamp (0xd45c4435) function

pub fn grant_role( &self, role: [u8; 32], account: Address, ) -> ContractCall<M, ()>

Calls the contract’s grantRole (0x2f2ff15d) function

pub fn has_role( &self, role: [u8; 32], account: Address, ) -> ContractCall<M, bool>

Calls the contract’s hasRole (0x91d14854) function

pub fn hash_operation( &self, target: Address, value: U256, data: Bytes, predecessor: [u8; 32], salt: [u8; 32], ) -> ContractCall<M, [u8; 32]>

Calls the contract’s hashOperation (0x8065657f) function

pub fn hash_operation_batch( &self, targets: Vec<Address>, values: Vec<U256>, payloads: Vec<Bytes>, predecessor: [u8; 32], salt: [u8; 32], ) -> ContractCall<M, [u8; 32]>

Calls the contract’s hashOperationBatch (0xb1c5f427) function

pub fn is_operation(&self, id: [u8; 32]) -> ContractCall<M, bool>

Calls the contract’s isOperation (0x31d50750) function

pub fn is_operation_done(&self, id: [u8; 32]) -> ContractCall<M, bool>

Calls the contract’s isOperationDone (0x2ab0f529) function

pub fn is_operation_pending(&self, id: [u8; 32]) -> ContractCall<M, bool>

Calls the contract’s isOperationPending (0x584b153e) function

pub fn is_operation_ready(&self, id: [u8; 32]) -> ContractCall<M, bool>

Calls the contract’s isOperationReady (0x13bc9f20) function

pub fn on_erc1155_batch_received( &self, p0: Address, p1: Address, p2: Vec<U256>, p3: Vec<U256>, p4: Bytes, ) -> ContractCall<M, [u8; 4]>

Calls the contract’s onERC1155BatchReceived (0xbc197c81) function

pub fn on_erc1155_received( &self, p0: Address, p1: Address, p2: U256, p3: U256, p4: Bytes, ) -> ContractCall<M, [u8; 4]>

Calls the contract’s onERC1155Received (0xf23a6e61) function

pub fn on_erc721_received( &self, p0: Address, p1: Address, p2: U256, p3: Bytes, ) -> ContractCall<M, [u8; 4]>

Calls the contract’s onERC721Received (0x150b7a02) function

pub fn renounce_role( &self, role: [u8; 32], account: Address, ) -> ContractCall<M, ()>

Calls the contract’s renounceRole (0x36568abe) function

pub fn revoke_role( &self, role: [u8; 32], account: Address, ) -> ContractCall<M, ()>

Calls the contract’s revokeRole (0xd547741f) function

pub fn schedule( &self, target: Address, value: U256, data: Bytes, predecessor: [u8; 32], salt: [u8; 32], delay: U256, ) -> ContractCall<M, ()>

Calls the contract’s schedule (0x01d5062a) function

pub fn schedule_batch( &self, targets: Vec<Address>, values: Vec<U256>, payloads: Vec<Bytes>, predecessor: [u8; 32], salt: [u8; 32], delay: U256, ) -> ContractCall<M, ()>

Calls the contract’s scheduleBatch (0x8f2a0bb0) function

pub fn supports_interface(&self, interface_id: [u8; 4]) -> ContractCall<M, bool>

Calls the contract’s supportsInterface (0x01ffc9a7) function

pub fn update_delay(&self, new_delay: U256) -> ContractCall<M, ()>

Calls the contract’s updateDelay (0x64d62353) function

pub fn call_executed_filter(&self) -> Event<Arc<M>, M, CallExecutedFilter>

Gets the contract’s CallExecuted event

pub fn call_salt_filter(&self) -> Event<Arc<M>, M, CallSaltFilter>

Gets the contract’s CallSalt event

pub fn call_scheduled_filter(&self) -> Event<Arc<M>, M, CallScheduledFilter>

Gets the contract’s CallScheduled event

pub fn cancelled_filter(&self) -> Event<Arc<M>, M, CancelledFilter>

Gets the contract’s Cancelled event

pub fn min_delay_change_filter(&self) -> Event<Arc<M>, M, MinDelayChangeFilter>

Gets the contract’s MinDelayChange event

pub fn role_admin_changed_filter( &self, ) -> Event<Arc<M>, M, RoleAdminChangedFilter>

Gets the contract’s RoleAdminChanged event

pub fn role_granted_filter(&self) -> Event<Arc<M>, M, RoleGrantedFilter>

Gets the contract’s RoleGranted event

pub fn role_revoked_filter(&self) -> Event<Arc<M>, M, RoleRevokedFilter>

Gets the contract’s RoleRevoked event

pub fn events(&self) -> Event<Arc<M>, M, TimelockControllerEvents>

Returns an Event builder for all the events of this contract.

Methods from Deref<Target = Contract<M>>

pub fn address(&self) -> H160

Returns the contract’s address

pub fn abi(&self) -> &Contract

Returns a reference to the contract’s ABI.

pub fn client(&self) -> B

where B: Clone,

Returns a pointer to the contract’s client.

pub fn client_ref(&self) -> &M

Returns a reference to the contract’s client.

pub fn connect<N>(&self, client: Arc<N>) -> ContractInstance<Arc<N>, N>

where N: Middleware,

Returns a new contract instance using the provided client

Clones self internally

pub fn connect_with<C, N>(&self, client: C) -> ContractInstance<C, N>

where C: Borrow<N>,

Returns a new contract instance using the provided client

Clones self internally

pub fn event_with_filter<D>(&self, filter: Filter) -> Event<B, M, D>

Returns an Event builder with the provided filter.

pub fn event<D>(&self) -> Event<B, M, D>

where D: EthEvent,

Returns an Event builder for the provided event.

pub fn event_for_name<D>(&self, name: &str) -> Result<Event<B, M, D>, Error>

Returns an Event builder with the provided name.

pub fn method_hash<T, D>( &self, signature: [u8; 4], args: T, ) -> Result<FunctionCall<B, M, D>, AbiError>

where T: Tokenize, D: Detokenize,

Returns a transaction builder for the selected function signature. This should be preferred if there are overloaded functions in your smart contract

pub fn method<T, D>( &self, name: &str, args: T, ) -> Result<FunctionCall<B, M, D>, AbiError>

where T: Tokenize, D: Detokenize,

Returns a transaction builder for the provided function name. If there are multiple functions with the same name due to overloading, consider using the method_hash method instead, since this will use the first match.

pub fn at<T>(&self, address: T) -> ContractInstance<B, M>

where T: Into<H160>,

Returns a new contract instance at address.

Clones self internally

Methods from Deref<Target = BaseContract>

pub fn encode<T>(&self, name: &str, args: T) -> Result<Bytes, AbiError>

where T: Tokenize,

Returns the ABI encoded data for the provided function and arguments

If the function exists multiple times and you want to use one of the overloaded versions, consider using encode_with_selector

pub fn encode_with_selector<T>( &self, signature: [u8; 4], args: T, ) -> Result<Bytes, AbiError>

where T: Tokenize,

Returns the ABI encoded data for the provided function selector and arguments

pub fn decode<D, T>(&self, name: &str, bytes: T) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded function arguments with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

pub fn decode_raw<T>( &self, name: &str, bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded function arguments with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

Returns a Token vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_output<D, T>(&self, name: &str, bytes: T) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded function output with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

pub fn decode_output_raw<T>( &self, name: &str, bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded function output with the selected function name.

If the function exists multiple times and you want to use one of the overloaded versions, consider using decode_with_selector

Returns a Token vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_event<D>( &self, name: &str, topics: Vec<H256>, data: Bytes, ) -> Result<D, AbiError>

where D: Detokenize,

Decodes for a given event name, given the log.topics and log.data fields from the transaction receipt

pub fn decode_event_raw( &self, name: &str, topics: Vec<H256>, data: Bytes, ) -> Result<Vec<Token>, AbiError>

Decodes for a given event name, given the log.topics and log.data fields from the transaction receipt

Returns a Token vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_with_selector_raw<T>( &self, signature: [u8; 4], bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

Returns a Token vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_with_selector<D, T>( &self, signature: [u8; 4], bytes: T, ) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

pub fn decode_input_raw<T>(&self, bytes: T) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded input bytes

Returns a Token vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn decode_input<D, T>(&self, bytes: T) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decodes the provided ABI encoded input bytes

pub fn decode_output_with_selector<D, T>( &self, signature: [u8; 4], bytes: T, ) -> Result<D, AbiError>

where D: Detokenize, T: AsRef<[u8]>,

Decode the provided ABI encoded bytes as the output of the provided function selector

pub fn decode_output_with_selector_raw<T>( &self, signature: [u8; 4], bytes: T, ) -> Result<Vec<Token>, AbiError>

where T: AsRef<[u8]>,

Decodes the provided ABI encoded bytes with the selected function selector

Returns a Token vector, which lets you decode function arguments dynamically without knowing the return type.

pub fn abi(&self) -> &Contract

Returns a reference to the contract’s ABI

Trait Implementations

impl<M> Clone for TimelockController<M>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for TimelockController<M>

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

Formats the value using the given formatter.

impl<M> Deref for TimelockController<M>

type Target = ContractInstance<Arc<M>, M>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<M> DerefMut for TimelockController<M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<M: Middleware> From<ContractInstance<Arc<M>, M>> for TimelockController<M>

fn from(contract: Contract<M>) -> Self

Converts to this type from the input type.