Struct PaymentPoolInstance 

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

A PaymentPool instance.

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

Instantiation and getters/setters.

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

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

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

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

impl<P: Provider<N>, N: Network> PaymentPoolInstance<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 usdc(&self) -> SolCallBuilder<&P, usdcCall, N>

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

pub fn feeRouter(&self) -> SolCallBuilder<&P, feeRouterCall, N>

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

pub fn getPool( &self, poolId: FixedBytes<32>, ) -> SolCallBuilder<&P, getPoolCall, N>

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

pub fn getAuthorization( &self, poolId: FixedBytes<32>, signer: Address, ) -> SolCallBuilder<&P, getAuthorizationCall, N>

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

pub fn getAuthorizations( &self, poolIds: Vec<FixedBytes<32>>, signers: Vec<Address>, ) -> SolCallBuilder<&P, getAuthorizationsCall, N>

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

pub fn getWatermark( &self, poolId: FixedBytes<32>, signer: Address, provider: Address, ) -> SolCallBuilder<&P, getWatermarkCall, N>

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

pub fn getWatermarks( &self, poolIds: Vec<FixedBytes<32>>, signers: Vec<Address>, providers: Vec<Address>, ) -> SolCallBuilder<&P, getWatermarksCall, N>

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

pub fn getRateBounds(&self) -> SolCallBuilder<&P, getRateBoundsCall, N>

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

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

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

pub fn getPools( &self, owner: Address, offset: U256, limit: U256, ) -> SolCallBuilder<&P, getPoolsCall, N>

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

pub fn openPool(&self, deposit: u64) -> SolCallBuilder<&P, openPoolCall, N>

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

pub fn topUp( &self, poolId: FixedBytes<32>, additionalDeposit: u64, ) -> SolCallBuilder<&P, topUpCall, N>

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

pub fn closePool( &self, poolId: FixedBytes<32>, ) -> SolCallBuilder<&P, closePoolCall, N>

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

pub fn reclaim( &self, poolId: FixedBytes<32>, ) -> SolCallBuilder<&P, reclaimCall, N>

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

pub fn redeemMany( &self, batches: Vec<<PoolBatch as SolType>::RustType>, ) -> SolCallBuilder<&P, redeemManyCall, N>

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

impl<P: Provider<N>, N: Network> PaymentPoolInstance<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 PoolOpened_filter(&self) -> Event<&P, PoolOpened, N>

Creates a new event filter for the PoolOpened event.

pub fn PoolToppedUp_filter(&self) -> Event<&P, PoolToppedUp, N>

Creates a new event filter for the PoolToppedUp event.

pub fn PoolRedeemed_filter(&self) -> Event<&P, PoolRedeemed, N>

Creates a new event filter for the PoolRedeemed event.

pub fn PoolCloseInitiated_filter(&self) -> Event<&P, PoolCloseInitiated, N>

Creates a new event filter for the PoolCloseInitiated event.

pub fn PoolReclaimed_filter(&self) -> Event<&P, PoolReclaimed, N>

Creates a new event filter for the PoolReclaimed event.

pub fn RateBoundsUpdated_filter(&self) -> Event<&P, RateBoundsUpdated, N>

Creates a new event filter for the RateBoundsUpdated event.

Trait Implementations

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.