Struct ERC20Instance 

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

A ERC20 instance.

Contains type-safe methods for interacting with an on-chain instance of the ERC20 contract located at a given address, using a given provider P.

If the contract bytecode is available (see the 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 for all the available methods.

Implementations

impl<P: Provider<N>, N: Network> ERC20Instance<P, N>

Instantiation and getters/setters.

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

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

See the wrapper’s documentation for more details.

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<P: Clone, N> ERC20Instance<&P, N>

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

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

impl<P: Provider<N>, N: Network> ERC20Instance<P, N>

Function calls.

pub fn call_builder<C: SolCall>(&self, call: &C) -> SolCallBuilder<&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 DOMAIN_SEPARATOR(&self) -> SolCallBuilder<&P, DOMAIN_SEPARATORCall, N>

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

pub fn allowance( &self, owner: Address, spender: Address, ) -> SolCallBuilder<&P, allowanceCall, N>

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

pub fn approve( &self, spender: Address, amount: U256, ) -> SolCallBuilder<&P, approveCall, N>

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

pub fn balanceOf( &self, account: Address, ) -> SolCallBuilder<&P, balanceOfCall, N>

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

pub fn bridgeBurn( &self, account: Address, amount: U256, ) -> SolCallBuilder<&P, bridgeBurnCall, N>

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

pub fn bridgeMint( &self, account: Address, amount: U256, ) -> SolCallBuilder<&P, bridgeMintCall, N>

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

pub fn decimals(&self) -> SolCallBuilder<&P, decimalsCall, N>

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

pub fn decreaseAllowance( &self, spender: Address, subtractedValue: U256, ) -> SolCallBuilder<&P, decreaseAllowanceCall, N>

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

pub fn deposit(&self) -> SolCallBuilder<&P, depositCall, N>

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

pub fn depositTo( &self, account: Address, ) -> SolCallBuilder<&P, depositToCall, N>

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

pub fn increaseAllowance( &self, spender: Address, addedValue: U256, ) -> SolCallBuilder<&P, increaseAllowanceCall, N>

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

pub fn initialize( &self, _name: String, _symbol: String, _decimals: u8, _l2Gateway: Address, _l1Address: Address, ) -> SolCallBuilder<&P, initializeCall, N>

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

pub fn l1Address(&self) -> SolCallBuilder<&P, l1AddressCall, N>

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

pub fn l2Gateway(&self) -> SolCallBuilder<&P, l2GatewayCall, N>

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

pub fn name(&self) -> SolCallBuilder<&P, nameCall, N>

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

pub fn nonces(&self, owner: Address) -> SolCallBuilder<&P, noncesCall, N>

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

pub fn permit( &self, owner: Address, spender: Address, value: U256, deadline: U256, v: u8, r: FixedBytes<32>, s: FixedBytes<32>, ) -> SolCallBuilder<&P, permitCall, N>

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

pub fn symbol(&self) -> SolCallBuilder<&P, symbolCall, N>

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

pub fn totalSupply(&self) -> SolCallBuilder<&P, totalSupplyCall, N>

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

pub fn transfer( &self, recipient: Address, amount: U256, ) -> SolCallBuilder<&P, transferCall, N>

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

pub fn transferAndCall( &self, _to: Address, _value: U256, _data: Bytes, ) -> SolCallBuilder<&P, transferAndCallCall, N>

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

pub fn transferFrom( &self, sender: Address, recipient: Address, amount: U256, ) -> SolCallBuilder<&P, transferFromCall, N>

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

pub fn withdraw(&self, amount: U256) -> SolCallBuilder<&P, withdrawCall, N>

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

pub fn withdrawTo( &self, account: Address, amount: U256, ) -> SolCallBuilder<&P, withdrawToCall, N>

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

impl<P: Provider<N>, N: Network> ERC20Instance<P, N>

Event filters.

pub fn event_filter<E: SolEvent>(&self) -> Event<&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 Approval_filter(&self) -> Event<&P, Approval, N>

Creates a new event filter for the Approval event.

pub fn Transfer_0_filter(&self) -> Event<&P, Transfer_0, N>

Creates a new event filter for the Transfer_0 event.

pub fn Transfer_1_filter(&self) -> Event<&P, Transfer_1, N>

Creates a new event filter for the Transfer_1 event.

Trait Implementations

impl<P: Clone, N: Clone> Clone for ERC20Instance<P, N>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P, N> Debug for ERC20Instance<P, N>

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

Formats the value using the given formatter.