Struct IStablecoinDEXInstance 

pub struct IStablecoinDEXInstance<P, N = Ethereum> {
    address: Address,
    provider: P,
    _network: PhantomData<N>,
}

A IStablecoinDEX instance.

Contains type-safe methods for interacting with an on-chain instance of the IStablecoinDEX 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: PhantomData<N>

Implementations

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

Instantiation and getters/setters.

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

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

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

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

impl<P: Provider<N>, N: Network> IStablecoinDEXInstance<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 createPair(&self, base: Address) -> SolCallBuilder<&P, createPairCall, N>

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

pub fn place( &self, token: Address, amount: u128, isBid: bool, tick: i16, ) -> SolCallBuilder<&P, placeCall, N>

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

pub fn placeFlip( &self, token: Address, amount: u128, isBid: bool, tick: i16, flipTick: i16, ) -> SolCallBuilder<&P, placeFlipCall, N>

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

pub fn cancel(&self, orderId: u128) -> SolCallBuilder<&P, cancelCall, N>

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

pub fn cancelStaleOrder( &self, orderId: u128, ) -> SolCallBuilder<&P, cancelStaleOrderCall, N>

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

pub fn swapExactAmountIn( &self, tokenIn: Address, tokenOut: Address, amountIn: u128, minAmountOut: u128, ) -> SolCallBuilder<&P, swapExactAmountInCall, N>

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

pub fn swapExactAmountOut( &self, tokenIn: Address, tokenOut: Address, amountOut: u128, maxAmountIn: u128, ) -> SolCallBuilder<&P, swapExactAmountOutCall, N>

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

pub fn quoteSwapExactAmountIn( &self, tokenIn: Address, tokenOut: Address, amountIn: u128, ) -> SolCallBuilder<&P, quoteSwapExactAmountInCall, N>

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

pub fn quoteSwapExactAmountOut( &self, tokenIn: Address, tokenOut: Address, amountOut: u128, ) -> SolCallBuilder<&P, quoteSwapExactAmountOutCall, N>

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

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

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

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

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

pub fn getOrder(&self, orderId: u128) -> SolCallBuilder<&P, getOrderCall, N>

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

pub fn getTickLevel( &self, base: Address, tick: i16, isBid: bool, ) -> SolCallBuilder<&P, getTickLevelCall, N>

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

pub fn pairKey( &self, tokenA: Address, tokenB: Address, ) -> SolCallBuilder<&P, pairKeyCall, N>

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

pub fn nextOrderId(&self) -> SolCallBuilder<&P, nextOrderIdCall, N>

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

pub fn books(&self, pairKey: FixedBytes<32>) -> SolCallBuilder<&P, booksCall, N>

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

pub fn MIN_TICK(&self) -> SolCallBuilder<&P, MIN_TICKCall, N>

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

pub fn MAX_TICK(&self) -> SolCallBuilder<&P, MAX_TICKCall, N>

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

pub fn TICK_SPACING(&self) -> SolCallBuilder<&P, TICK_SPACINGCall, N>

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

pub fn PRICE_SCALE(&self) -> SolCallBuilder<&P, PRICE_SCALECall, N>

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

pub fn MIN_ORDER_AMOUNT(&self) -> SolCallBuilder<&P, MIN_ORDER_AMOUNTCall, N>

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

pub fn MIN_PRICE(&self) -> SolCallBuilder<&P, MIN_PRICECall, N>

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

pub fn MAX_PRICE(&self) -> SolCallBuilder<&P, MAX_PRICECall, N>

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

pub fn tickToPrice(&self, tick: i16) -> SolCallBuilder<&P, tickToPriceCall, N>

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

pub fn priceToTick(&self, price: u32) -> SolCallBuilder<&P, priceToTickCall, N>

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

impl<P: Provider<N>, N: Network> IStablecoinDEXInstance<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 PairCreated_filter(&self) -> Event<&P, PairCreated, N>

Creates a new event filter for the PairCreated event.

pub fn OrderPlaced_filter(&self) -> Event<&P, OrderPlaced, N>

Creates a new event filter for the OrderPlaced event.

pub fn OrderFilled_filter(&self) -> Event<&P, OrderFilled, N>

Creates a new event filter for the OrderFilled event.

pub fn OrderCancelled_filter(&self) -> Event<&P, OrderCancelled, N>

Creates a new event filter for the OrderCancelled event.

Trait Implementations

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

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