Struct alloy_contract::ContractInstance

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

A handle to an Ethereum contract at a specific address.

A contract is an abstraction of an executable program on Ethereum. Every deployed contract has an address, which is used to connect to it so that it may receive messages (transactions).

Implementations

impl<T, P, N> ContractInstance<T, P, N>

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

Creates a new contract from the provided address, provider, and interface.

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

Returns a reference to the contract’s address.

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

Sets the contract’s address.

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

Returns a new contract instance at address.

pub const fn abi(&self) -> &JsonAbi

Returns a reference to the contract’s ABI.

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

Returns a reference to the contract’s provider.

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

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

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

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

pub fn function( &self, name: &str, args: &[DynSolValue], ) -> Result<CallBuilder<T, &P, Function, N>>

Returns a transaction builder for the provided function name.

If there are multiple functions with the same name due to overloading, consider using the ContractInstance::function_from_selector method instead, since this will use the first match.

pub fn function_from_selector( &self, selector: &Selector, args: &[DynSolValue], ) -> Result<CallBuilder<T, &P, Function, N>>

Returns a transaction builder for the provided function selector.

pub const fn event<E: SolEvent>(&self, filter: Filter) -> Event<T, &P, E, N>

Returns an Event builder with the provided filter.

Methods from Deref<Target = Interface>

pub fn encode_input(&self, name: &str, args: &[DynSolValue]) -> Result<Vec<u8>>

Returns the ABI encoded data (including the selector) for the provided function and arguments.

Note

If the function exists multiple times and you want to use one of the overloaded versions, consider using Self::encode_input_with_selector.

pub fn encode_input_with_selector( &self, selector: &Selector, args: &[DynSolValue], ) -> Result<Vec<u8>>

Returns the ABI encoded data (including the selector) for the function with the provided selector and arguments.

pub fn decode_input( &self, name: &str, data: &[u8], validate: bool, ) -> Result<Vec<DynSolValue>>

ABI-decodes the given data according to the function’s types.

Note

If the function exists multiple times and you want to use one of the overloaded versions, consider using Self::decode_input_with_selector.

pub fn decode_input_with_selector( &self, selector: &Selector, data: &[u8], validate: bool, ) -> Result<Vec<DynSolValue>>

Decode the provided ABI encoded bytes as the input of the provided function selector.

pub fn decode_output( &self, name: &str, data: &[u8], validate: bool, ) -> Result<Vec<DynSolValue>>

Decode the provided ABI encoded bytes as the output of the first function with the given name.

Note

If there are multiple functions with the same name, consider using Self::decode_output_with_selector

pub fn decode_output_with_selector( &self, selector: &Selector, data: &[u8], validate: bool, ) -> Result<Vec<DynSolValue>>

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

pub fn abi(&self) -> &JsonAbi

Returns a reference to the contract’s ABI.

Trait Implementations

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

fn clone(&self) -> ContractInstance<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 ContractInstance<T, P, N>

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

Formats the value using the given formatter.

impl<T, P, N> Deref for ContractInstance<T, P, N>

type Target = Interface

The resulting type after dereferencing.

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

Dereferences the value.