Struct Governor

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

Implementations

impl<M: Middleware> Governor<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 ballot_typehash(&self) -> ContractCall<M, [u8; 32]>

Calls the contract’s BALLOT_TYPEHASH (0xdeaaa7cc) function

pub fn clock_mode(&self) -> ContractCall<M, String>

Calls the contract’s CLOCK_MODE (0x4bf5d7e9) function

pub fn counting_mode(&self) -> ContractCall<M, String>

Calls the contract’s COUNTING_MODE (0xdd4e2ba5) function

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

Calls the contract’s EXTENDED_BALLOT_TYPEHASH (0x2fe3e261) function

pub fn cancel( &self, targets: Vec<Address>, values: Vec<U256>, calldatas: Vec<Bytes>, description_hash: [u8; 32], ) -> ContractCall<M, U256>

Calls the contract’s cancel (0x452115d6) function

pub fn cast_vote(&self, proposal_id: U256, support: u8) -> ContractCall<M, U256>

Calls the contract’s castVote (0x56781388) function

pub fn cast_vote_by_sig( &self, proposal_id: U256, support: u8, v: u8, r: [u8; 32], s: [u8; 32], ) -> ContractCall<M, U256>

Calls the contract’s castVoteBySig (0x3bccf4fd) function

pub fn cast_vote_with_reason( &self, proposal_id: U256, support: u8, reason: String, ) -> ContractCall<M, U256>

Calls the contract’s castVoteWithReason (0x7b3c71d3) function

pub fn cast_vote_with_reason_and_params( &self, proposal_id: U256, support: u8, reason: String, params: Bytes, ) -> ContractCall<M, U256>

Calls the contract’s castVoteWithReasonAndParams (0x5f398a14) function

pub fn cast_vote_with_reason_and_params_by_sig( &self, proposal_id: U256, support: u8, reason: String, params: Bytes, v: u8, r: [u8; 32], s: [u8; 32], ) -> ContractCall<M, U256>

Calls the contract’s castVoteWithReasonAndParamsBySig (0x03420181) function

pub fn clock(&self) -> ContractCall<M, u64>

Calls the contract’s clock (0x91ddadf4) function

pub fn eip_712_domain( &self, ) -> ContractCall<M, ([u8; 1], String, String, U256, Address, [u8; 32], Vec<U256>)>

Calls the contract’s eip712Domain (0x84b0196e) function

pub fn execute( &self, targets: Vec<Address>, values: Vec<U256>, calldatas: Vec<Bytes>, description_hash: [u8; 32], ) -> ContractCall<M, U256>

Calls the contract’s execute (0x2656227d) function

pub fn get_votes( &self, account: Address, timepoint: U256, ) -> ContractCall<M, U256>

Calls the contract’s getVotes (0xeb9019d4) function

pub fn get_votes_with_params( &self, account: Address, timepoint: U256, params: Bytes, ) -> ContractCall<M, U256>

Calls the contract’s getVotesWithParams (0x9a802a6d) function

pub fn has_voted( &self, proposal_id: U256, account: Address, ) -> ContractCall<M, bool>

Calls the contract’s hasVoted (0x43859632) function

pub fn hash_proposal( &self, targets: Vec<Address>, values: Vec<U256>, calldatas: Vec<Bytes>, description_hash: [u8; 32], ) -> ContractCall<M, U256>

Calls the contract’s hashProposal (0xc59057e4) function

pub fn name(&self) -> ContractCall<M, String>

Calls the contract’s name (0x06fdde03) 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 proposal_deadline(&self, proposal_id: U256) -> ContractCall<M, U256>

Calls the contract’s proposalDeadline (0xc01f9e37) function

pub fn proposal_proposer(&self, proposal_id: U256) -> ContractCall<M, Address>

Calls the contract’s proposalProposer (0x143489d0) function

pub fn proposal_snapshot(&self, proposal_id: U256) -> ContractCall<M, U256>

Calls the contract’s proposalSnapshot (0x2d63f693) function

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

Calls the contract’s proposalThreshold (0xb58131b0) function

pub fn propose( &self, targets: Vec<Address>, values: Vec<U256>, calldatas: Vec<Bytes>, description: String, ) -> ContractCall<M, U256>

Calls the contract’s propose (0x7d5e81e2) function

pub fn quorum(&self, timepoint: U256) -> ContractCall<M, U256>

Calls the contract’s quorum (0xf8ce560a) function

pub fn relay( &self, target: Address, value: U256, data: Bytes, ) -> ContractCall<M, ()>

Calls the contract’s relay (0xc28bc2fa) function

pub fn state(&self, proposal_id: U256) -> ContractCall<M, u8>

Calls the contract’s state (0x3e4f49e6) function

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

Calls the contract’s supportsInterface (0x01ffc9a7) function

pub fn version(&self) -> ContractCall<M, String>

Calls the contract’s version (0x54fd4d50) function

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

Calls the contract’s votingDelay (0x3932abb1) function

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

Calls the contract’s votingPeriod (0x02a251a3) function

pub fn eip712_domain_changed_filter( &self, ) -> Event<Arc<M>, M, Eip712DomainChangedFilter>

Gets the contract’s EIP712DomainChanged event

pub fn proposal_canceled_filter( &self, ) -> Event<Arc<M>, M, ProposalCanceledFilter>

Gets the contract’s ProposalCanceled event

pub fn proposal_created_filter(&self) -> Event<Arc<M>, M, ProposalCreatedFilter>

Gets the contract’s ProposalCreated event

pub fn proposal_executed_filter( &self, ) -> Event<Arc<M>, M, ProposalExecutedFilter>

Gets the contract’s ProposalExecuted event

pub fn vote_cast_filter(&self) -> Event<Arc<M>, M, VoteCastFilter>

Gets the contract’s VoteCast event

pub fn vote_cast_with_params_filter( &self, ) -> Event<Arc<M>, M, VoteCastWithParamsFilter>

Gets the contract’s VoteCastWithParams event

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

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 Governor<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 Governor<M>

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

Formats the value using the given formatter.

impl<M> Deref for Governor<M>

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

The resulting type after dereferencing.

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

Dereferences the value.

impl<M> DerefMut for Governor<M>

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

Mutably dereferences the value.

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

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

Converts to this type from the input type.