Skip to main content

BlockchainExecutionClient

Struct BlockchainExecutionClient 

Source
pub struct BlockchainExecutionClient { /* private fields */ }
Expand description

Execution client for blockchain interactions including balance tracking and order execution.

Implementations§

Source§

impl BlockchainExecutionClient

Source

pub fn new( core_client: ExecutionClientCore, config: BlockchainExecutionClientConfig, ) -> Result<Self>

Creates a new BlockchainExecutionClient instance for the specified configuration.

§Errors

Returns an error if transaction limits are missing or invalid, independent verification is missing or conflicts with the configured chain, the deployment manifest or provider topology is invalid, a configured address or token pair is invalid, the router allowlist is empty, or the slippage bounds are inconsistent or not below 100%.

Source

pub async fn preflight( &self, instrument_id: &InstrumentId, ) -> Result<BlockchainPreflightReport>

Runs a read-only execution preflight for the pool selected by instrument_id.

Verifies the RPC chain ID against configuration, deployed bytecode at the router, pool, and token addresses, wallet native and token balances, exact router allowance of the pool’s base (input) token, and current fee conditions. Changes no state.

§Errors

Returns an error if the instrument ID cannot be resolved to a cached Uniswap V3 pool on the client’s chain, or if any RPC call fails. On-chain readiness failures are reported in the returned BlockchainPreflightReport, not as errors.

Source

pub async fn wrap(&mut self, amount_wei: U256) -> Result<B256>

Wraps native currency into the wrapped native token via a WETH deposit() transaction carrying amount_wei of native value.

This is an explicit operator operation; it never runs inside submit_order.

§Errors

Returns an error if the amount is zero, the WETH target is not a deployed ERC-20 contract, the client is not connected, another transaction is in flight, no durable store is configured, the WETH balance does not increase by amount_wei, or any RPC, policy, signing, persistence, or broadcast step fails. A persistence failure after signing, or a failed postcondition after finality, leaves the in-flight slot occupied.

Source

pub async fn approve( &mut self, token: Address, amount: U256, router: Address, ) -> Result<B256>

Approves an allowlisted SwapRouter to spend amount of token via an ERC-20 approve transaction. Zero always revokes the allowance. For nonzero requests, unlimited_approval changes the target to U256::MAX.

This is an explicit operator operation; it never runs inside submit_order.

§Errors

Returns an error if the router or token fails policy and deployment checks, a nonzero allowance was not cleared first, approval simulation returns false or malformed data, the client is not connected, another transaction is in flight, no durable store is configured, the resulting allowance differs from the target, or any RPC, signing, persistence, or broadcast step fails. A persistence failure after signing, or a failed postcondition after finality, leaves the in-flight slot occupied.

Source

pub async fn check_payload_storage( &self, batch_size: usize, ) -> Result<PayloadStorageCheck>

Authenticates every persisted signed transaction in this execution database.

Run this while the execution client is disconnected. The check takes a stable table lock, reads in bounded batches, and returns counts, deployment identity, key IDs, and database roles with direct ownership or SELECT grants.

§Errors

Returns an error for inconsistent storage state, missing keys, or any payload which cannot be opened and authenticated against its durable intent.

Source

pub async fn protect_payload_storage(&self) -> Result<()>

Activates or resumes protected signed-transaction storage for this execution database.

Run this while the execution client is disconnected. A full payload check must succeed before a later execution connection is permitted.

§Errors

Returns an error if the client is connected, an active key or deployment identity is unavailable, or any stored payload cannot be migrated and authenticated.

Source

pub async fn rewrap_payload_storage(&self, batch_size: usize) -> Result<()>

Rewraps all protected payloads in this execution database with the configured active key.

The prior active key must remain configured as a retired key until this method and a subsequent full check both succeed.

§Errors

Returns an error if the client is connected, storage is not protected, required keys are unavailable, or any bounded rewrap batch fails authentication.

Source

pub async fn rollback_payload_storage(&self, batch_size: usize) -> Result<()>

Restores authenticated plaintext payloads and removes protection from this database.

This incident-only operation is resumable. Keep the complete key set configured until it succeeds and the unprotected database passes a full payload check.

§Errors

Returns an error if the client is connected, storage is not protected, required keys are unavailable, or any bounded rollback batch fails authentication.

Trait Implementations§

Source§

impl Debug for BlockchainExecutionClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl ExecutionClient for BlockchainExecutionClient

Source§

fn is_connected(&self) -> bool

Source§

fn client_id(&self) -> ClientId

Source§

fn account_id(&self) -> AccountId

Source§

fn venue(&self) -> Venue

Source§

fn handles_order_venue(&self, venue: Venue) -> bool

Returns whether this client can execute orders for the given instrument venue. Read more
Source§

fn oms_type(&self) -> OmsType

Source§

fn get_account(&self) -> Option<AccountAny>

Source§

fn generate_account_state( &self, balances: Vec<AccountBalance>, margins: Vec<MarginBalance>, reported: bool, ts_event: UnixNanos, info: Option<Params>, ) -> Result<()>

Generates and publishes the account state event. Read more
Source§

fn start(&mut self) -> Result<()>

Starts the execution client. Read more
Source§

fn stop(&mut self) -> Result<()>

Stops the execution client. Read more
Source§

fn submit_order(&self, cmd: SubmitOrder) -> Result<()>

Submits a single order command to the execution venue. Read more
Source§

fn submit_order_list(&self, cmd: SubmitOrderList) -> Result<()>

Submits a list of orders to the execution venue. Read more
Source§

fn modify_order(&self, cmd: ModifyOrder) -> Result<()>

Modifies an existing order. Read more
Source§

fn cancel_order(&self, cmd: CancelOrder) -> Result<()>

Cancels a specific order. Read more
Source§

fn cancel_all_orders(&self, cmd: CancelAllOrders) -> Result<()>

Cancels all orders. Read more
Source§

fn batch_cancel_orders(&self, cmd: BatchCancelOrders) -> Result<()>

Cancels a batch of orders. Read more
Source§

fn query_account(&self, cmd: QueryAccount) -> Result<()>

Queries the status of an account. Read more
Source§

fn query_order(&self, cmd: QueryOrder) -> Result<()>

Queries the status of an order. Read more
Source§

fn connect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Connects the client to the execution venue. Read more
Source§

fn disconnect<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<()>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Disconnects the client from the execution venue. Read more
Source§

fn generate_order_status_report<'life0, 'life1, 'async_trait>( &'life0 self, _cmd: &'life1 GenerateOrderStatusReport, ) -> Pin<Box<dyn Future<Output = Result<Option<OrderStatusReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates a single order status report. Read more
Source§

fn generate_order_status_reports<'life0, 'life1, 'async_trait>( &'life0 self, _cmd: &'life1 GenerateOrderStatusReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<OrderStatusReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates multiple order status reports. Read more
Source§

fn generate_fill_reports<'life0, 'async_trait>( &'life0 self, _cmd: GenerateFillReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<FillReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generates fill reports based on execution results. Read more
Source§

fn generate_position_status_reports<'life0, 'life1, 'async_trait>( &'life0 self, _cmd: &'life1 GeneratePositionStatusReports, ) -> Pin<Box<dyn Future<Output = Result<Vec<PositionStatusReport>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Generates position status reports. Read more
Source§

fn generate_mass_status<'life0, 'async_trait>( &'life0 self, _lookback_mins: Option<u64>, ) -> Pin<Box<dyn Future<Output = Result<Option<ExecutionMassStatus>>> + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Generates mass status for executions. Read more
§

fn position_reconciliation_tolerance(&self) -> Decimal

Returns the maximum absolute position difference tolerated during reconciliation.
§

fn provides_bulk_position_coverage(&self, _instrument_id: InstrumentId) -> bool

Returns whether a bulk position status report request provides complete coverage for the given instrument, so that an absent report is evidence the position is flat.
§

fn reset(&mut self) -> Result<(), Error>

Resets the execution client to its initial state. Read more
§

fn dispose(&mut self) -> Result<(), Error>

Disposes of client resources and cleans up. Read more
§

fn batch_modify_orders(&self, cmd: BatchModifyOrders) -> Result<(), Error>

Modifies a batch of orders. Read more
§

fn register_external_order( &self, _client_order_id: ClientOrderId, _venue_order_id: VenueOrderId, _instrument_id: InstrumentId, _strategy_id: StrategyId, _ts_init: UnixNanos, )

Registers an external order for tracking by the execution client. Read more
§

fn on_instrument(&mut self, _instrument: InstrumentAny)

Handles an instrument update received via the message bus. Read more
§

fn calculate_commission( &self, instrument: &InstrumentAny, last_qty: Quantity, last_px: Price, liquidity_side: LiquiditySide, ) -> Result<Option<Money>, Error>

Calculates the commission for a reconciliation fill. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more