pub struct FyndClient<P = RootProvider<Ethereum>>{ /* private fields */ }Expand description
The main entry point for interacting with the Fynd DEX router.
Construct via FyndClientBuilder. All methods are async and require a Tokio runtime.
The type parameter P is the alloy provider used for Ethereum RPC calls. In production code
this is RootProvider<Ethereum> (the default). In tests a mocked provider can be used.
Implementations§
Source§impl<P> FyndClient<P>
impl<P> FyndClient<P>
Sourcepub async fn quote(&self, params: QuoteParams) -> Result<Quote, FyndError>
pub async fn quote(&self, params: QuoteParams) -> Result<Quote, FyndError>
Request a quote for one or more swap orders.
The returned Quote has token_out and receiver populated on each
OrderQuote from the corresponding input Order (matched by index).
Retries automatically on transient failures according to the client’s RetryConfig.
Sourcepub async fn health(&self) -> Result<HealthStatus, FyndError>
pub async fn health(&self) -> Result<HealthStatus, FyndError>
Get the health status of the Fynd RPC server.
Sourcepub async fn swap_payload(
&self,
quote: Quote,
hints: &SigningHints,
) -> Result<SwapPayload, FyndError>
pub async fn swap_payload( &self, quote: Quote, hints: &SigningHints, ) -> Result<SwapPayload, FyndError>
Build a swap payload for a given order quote, ready for signing.
For BackendKind::Fynd quotes, this resolves the sender nonce and EIP-1559 fee
parameters from the RPC node (unless overridden via hints), then constructs an
unsigned EIP-1559 transaction targeting the RouterV3 contract.
BackendKind::Turbine is not yet implemented and returns
FyndError::Protocol.
token_out and receiver are read directly from the quote (populated during
quote()). Pass &SigningHints::default() to auto-resolve all transaction parameters.
Sourcepub async fn execute_swap(
&self,
order: SignedSwap,
options: &ExecutionOptions,
) -> Result<ExecutionReceipt, FyndError>
pub async fn execute_swap( &self, order: SignedSwap, options: &ExecutionOptions, ) -> Result<ExecutionReceipt, FyndError>
Broadcast a signed swap and return an ExecutionReceipt that resolves once the
transaction is mined.
Pass ExecutionOptions::default for standard on-chain submission. Set
ExecutionOptions::dry_run to true to simulate only — the receipt resolves immediately
with values derived from eth_call (settled amount) and eth_estimateGas (gas cost).
For real submissions, this method returns immediately after broadcasting. The inner
future polls every 2 seconds and has no built-in timeout; wrap with
tokio::time::timeout to bound the wait.
Sourcepub async fn info(&self) -> Result<&InstanceInfo, FyndError>
pub async fn info(&self) -> Result<&InstanceInfo, FyndError>
Fetch and cache static instance metadata from GET /v1/info.
The result is fetched at most once per FyndClient instance; subsequent calls return the
cached value without making a network request.
Sourcepub async fn approval(
&self,
params: &ApprovalParams,
hints: &SigningHints,
) -> Result<Option<ApprovalPayload>, FyndError>
pub async fn approval( &self, params: &ApprovalParams, hints: &SigningHints, ) -> Result<Option<ApprovalPayload>, FyndError>
Build an unsigned EIP-1559 approve(spender, amount) transaction for the given token,
or None if the allowance is already sufficient.
- Calls
info()to resolve the spender address fromparams.spender. - If
params.check_allowanceistrue, checks the current ERC-20 allowance and returnsNoneimmediately if it is already sufficient (skipping nonce and fee resolution). - Resolves nonce and EIP-1559 fees via
hints(same semantics asswap_payload). - Encodes the
approve(spender, amount)calldata using the ERC-20 ABI.
Gas defaults to hints.gas_limit().unwrap_or(65_000).
Sourcepub async fn execute_approval(
&self,
approval: SignedApproval,
) -> Result<TxReceipt, FyndError>
pub async fn execute_approval( &self, approval: SignedApproval, ) -> Result<TxReceipt, FyndError>
Broadcast a signed approval transaction and return a TxReceipt that resolves once
the transaction is mined.
This method returns immediately after broadcasting. The inner future polls every 2 seconds
and has no built-in timeout; wrap with tokio::time::timeout to bound the wait.
Auto Trait Implementations§
impl<P = RootProvider> !Freeze for FyndClient<P>
impl<P = RootProvider> !RefUnwindSafe for FyndClient<P>
impl<P> Send for FyndClient<P>
impl<P> Sync for FyndClient<P>
impl<P> Unpin for FyndClient<P>where
P: Unpin,
impl<P> UnsafeUnpin for FyndClient<P>where
P: UnsafeUnpin,
impl<P = RootProvider> !UnwindSafe for FyndClient<P>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more