Struct StrategyBaseInstance

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

A StrategyBase instance.

Contains type-safe methods for interacting with an on-chain instance of the
[`StrategyBase`](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> StrategyBaseInstance<T, P, N>

Instantiation and getters/setters.

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

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

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

pub async fn deploy( provider: P, _strategyManager: Address, ) -> Result<StrategyBaseInstance<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, _strategyManager: Address, ) -> 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> StrategyBaseInstance<T, &P, N>

pub fn with_cloned_provider(self) -> StrategyBaseInstance<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> StrategyBaseInstance<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 deposit( &self, token: Address, amount: U256, ) -> SolCallBuilder<T, &P, depositCall, N>

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

pub fn explanation(&self) -> SolCallBuilder<T, &P, explanationCall, N>

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

pub fn initialize( &self, _underlyingToken: Address, _pauserRegistry: Address, ) -> SolCallBuilder<T, &P, initializeCall, N>

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

pub fn pause( &self, newPausedStatus: U256, ) -> SolCallBuilder<T, &P, pauseCall, N>

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

pub fn pauseAll(&self) -> SolCallBuilder<T, &P, pauseAllCall, N>

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

pub fn paused_0(&self, index: u8) -> SolCallBuilder<T, &P, paused_0Call, N>

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

pub fn paused_1(&self) -> SolCallBuilder<T, &P, paused_1Call, N>

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

pub fn pauserRegistry(&self) -> SolCallBuilder<T, &P, pauserRegistryCall, N>

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

pub fn setPauserRegistry( &self, newPauserRegistry: Address, ) -> SolCallBuilder<T, &P, setPauserRegistryCall, N>

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

pub fn shares(&self, user: Address) -> SolCallBuilder<T, &P, sharesCall, N>

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

pub fn sharesToUnderlying( &self, amountShares: U256, ) -> SolCallBuilder<T, &P, sharesToUnderlyingCall, N>

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

pub fn sharesToUnderlyingView( &self, amountShares: U256, ) -> SolCallBuilder<T, &P, sharesToUnderlyingViewCall, N>

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

pub fn strategyManager(&self) -> SolCallBuilder<T, &P, strategyManagerCall, N>

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

pub fn totalShares(&self) -> SolCallBuilder<T, &P, totalSharesCall, N>

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

pub fn underlyingToShares( &self, amountUnderlying: U256, ) -> SolCallBuilder<T, &P, underlyingToSharesCall, N>

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

pub fn underlyingToSharesView( &self, amountUnderlying: U256, ) -> SolCallBuilder<T, &P, underlyingToSharesViewCall, N>

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

pub fn underlyingToken(&self) -> SolCallBuilder<T, &P, underlyingTokenCall, N>

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

pub fn unpause( &self, newPausedStatus: U256, ) -> SolCallBuilder<T, &P, unpauseCall, N>

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

pub fn userUnderlying( &self, user: Address, ) -> SolCallBuilder<T, &P, userUnderlyingCall, N>

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

pub fn userUnderlyingView( &self, user: Address, ) -> SolCallBuilder<T, &P, userUnderlyingViewCall, N>

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

pub fn withdraw( &self, recipient: Address, token: Address, amountShares: U256, ) -> SolCallBuilder<T, &P, withdrawCall, N>

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

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> StrategyBaseInstance<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 Initialized_filter(&self) -> Event<T, &P, Initialized, N>

Creates a new event filter for the Initialized event.

pub fn Paused_filter(&self) -> Event<T, &P, Paused, N>

Creates a new event filter for the Paused event.

pub fn PauserRegistrySet_filter(&self) -> Event<T, &P, PauserRegistrySet, N>

Creates a new event filter for the PauserRegistrySet event.

pub fn Unpaused_filter(&self) -> Event<T, &P, Unpaused, N>

Creates a new event filter for the Unpaused event.

Trait Implementations

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

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

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

Formats the value using the given formatter.