Struct IPancakeV3PoolInstance

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

A IPancakeV3Pool instance.

Contains type-safe methods for interacting with an on-chain instance of the IPancakeV3Pool 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> IPancakeV3PoolInstance<T, P, N>

Instantiation and getters/setters.

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

Creates a new wrapper around an on-chain IPancakeV3Pool 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> IPancakeV3PoolInstance<T, &P, N>

pub fn with_cloned_provider(self) -> IPancakeV3PoolInstance<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> IPancakeV3PoolInstance<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 factory(&self) -> SolCallBuilder<T, &P, factoryCall, N>

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

pub fn token0(&self) -> SolCallBuilder<T, &P, token0Call, N>

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

pub fn token1(&self) -> SolCallBuilder<T, &P, token1Call, N>

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

pub fn fee(&self) -> SolCallBuilder<T, &P, feeCall, N>

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

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

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

pub fn maxLiquidityPerTick( &self, ) -> SolCallBuilder<T, &P, maxLiquidityPerTickCall, N>

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

pub fn slot0(&self) -> SolCallBuilder<T, &P, slot0Call, N>

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

pub fn feeGrowthGlobal0X128( &self, ) -> SolCallBuilder<T, &P, feeGrowthGlobal0X128Call, N>

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

pub fn feeGrowthGlobal1X128( &self, ) -> SolCallBuilder<T, &P, feeGrowthGlobal1X128Call, N>

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

pub fn protocolFees(&self) -> SolCallBuilder<T, &P, protocolFeesCall, N>

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

pub fn liquidity(&self) -> SolCallBuilder<T, &P, liquidityCall, N>

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

pub fn ticks(&self, tick: I24) -> SolCallBuilder<T, &P, ticksCall, N>

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

pub fn tickBitmap( &self, wordPosition: i16, ) -> SolCallBuilder<T, &P, tickBitmapCall, N>

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

pub fn positions( &self, key: FixedBytes<32>, ) -> SolCallBuilder<T, &P, positionsCall, N>

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

pub fn observations( &self, index: U256, ) -> SolCallBuilder<T, &P, observationsCall, N>

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

impl<T: Transport + Clone, P: Provider<T, N>, N: Network> IPancakeV3PoolInstance<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.

Trait Implementations

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

fn clone(&self) -> IPancakeV3PoolInstance<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 IPancakeV3PoolInstance<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.