Struct IMaverickPoolInstance

pub struct IMaverickPoolInstance<T, P, N = Ethereum> {
    address: Address,
    provider: P,
    _network_transport: PhantomData<(N, T)>,
}

A IMaverickPool instance.

Contains type-safe methods for interacting with an on-chain instance of the IMaverickPool 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.

Fields

address: Address

provider: P

_network_transport: PhantomData<(N, T)>

Implementations

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

Instantiation and getters/setters.

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

Creates a new wrapper around an on-chain IMaverickPool 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<T, P: Clone, N> IMaverickPoolInstance<T, &P, N>

pub fn with_cloned_provider(self) -> IMaverickPoolInstance<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> IMaverickPoolInstance<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 fee(&self) -> SolCallBuilder<T, &P, feeCall, N>

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

pub fn lookback(&self) -> SolCallBuilder<T, &P, lookbackCall, N>

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

pub fn tickSpacing(&self) -> SolCallBuilder<T, &P, tickSpacingCall, N>

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

pub fn tokenA(&self) -> SolCallBuilder<T, &P, tokenACall, N>

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

pub fn tokenB(&self) -> SolCallBuilder<T, &P, tokenBCall, N>

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

pub fn factory(&self) -> SolCallBuilder<T, &P, factoryCall, N>

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

pub fn binMap(&self, tick: i32) -> SolCallBuilder<T, &P, binMapCall, N>

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

pub fn binPositions( &self, tick: i32, kind: U256, ) -> SolCallBuilder<T, &P, binPositionsCall, N>

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

pub fn binBalanceA(&self) -> SolCallBuilder<T, &P, binBalanceACall, N>

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

pub fn binBalanceB(&self) -> SolCallBuilder<T, &P, binBalanceBCall, N>

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

pub fn getTwa(&self) -> SolCallBuilder<T, &P, getTwaCall, N>

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

pub fn getCurrentTwa(&self) -> SolCallBuilder<T, &P, getCurrentTwaCall, N>

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

pub fn getState(&self) -> SolCallBuilder<T, &P, getStateCall, N>

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

pub fn getBin(&self, binId: u128) -> SolCallBuilder<T, &P, getBinCall, N>

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

pub fn balanceOf( &self, tokenId: U256, binId: u128, ) -> SolCallBuilder<T, &P, balanceOfCall, N>

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

pub fn tokenAScale(&self) -> SolCallBuilder<T, &P, tokenAScaleCall, N>

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

pub fn tokenBScale(&self) -> SolCallBuilder<T, &P, tokenBScaleCall, N>

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

pub fn swap( &self, recipient: Address, amount: U256, tokenAIn: bool, exactOutput: bool, sqrtPriceLimit: U256, data: Bytes, ) -> SolCallBuilder<T, &P, swapCall, N>

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

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

Creates a new event filter for the Swap event.

pub fn AddLiquidity_filter(&self) -> Event<T, &P, AddLiquidity, N>

Creates a new event filter for the AddLiquidity event.

pub fn MigrateBinsUpStack_filter(&self) -> Event<T, &P, MigrateBinsUpStack, N>

Creates a new event filter for the MigrateBinsUpStack event.

pub fn TransferLiquidity_filter(&self) -> Event<T, &P, TransferLiquidity, N>

Creates a new event filter for the TransferLiquidity event.

pub fn RemoveLiquidity_filter(&self) -> Event<T, &P, RemoveLiquidity, N>

Creates a new event filter for the RemoveLiquidity event.

pub fn BinMerged_filter(&self) -> Event<T, &P, BinMerged, N>

Creates a new event filter for the BinMerged event.

pub fn BinMoved_filter(&self) -> Event<T, &P, BinMoved, N>

Creates a new event filter for the BinMoved event.

pub fn ProtocolFeeCollected_filter( &self, ) -> Event<T, &P, ProtocolFeeCollected, N>

Creates a new event filter for the ProtocolFeeCollected event.

pub fn SetProtocolFeeRatio_filter(&self) -> Event<T, &P, SetProtocolFeeRatio, N>

Creates a new event filter for the SetProtocolFeeRatio event.

Trait Implementations

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

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

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

Formats the value using the given formatter.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.