Skip to main content

LighterRawHttpClient

Struct LighterRawHttpClient 

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

Raw HTTP client for Lighter REST API operations.

This client owns the transport, base URL, default headers, and rate limit. Methods map directly to venue endpoints and return venue response models without converting to Nautilus domain types.

Implementations§

Source§

impl LighterRawHttpClient

Source

pub fn new( environment: LighterEnvironment, base_url: Option<String>, timeout_secs: u64, proxy_url: Option<String>, ) -> LighterHttpResult<Self>

Creates a new LighterRawHttpClient.

§Errors

Returns an error if the underlying HTTP client cannot be created.

Source

pub fn new_with_quotas( environment: LighterEnvironment, base_url: Option<String>, timeout_secs: u64, proxy_url: Option<String>, default_quota: Quota, tx_rate_limiter: Option<Arc<LighterTxRateLimiter>>, ) -> LighterHttpResult<Self>

Creates a new LighterRawHttpClient with an explicit read quota and an optional shared transaction limiter.

default_quota governs the REST read bucket (LIGHTER_REST_BUCKET), resolved from the client’s configured rest_quota_per_min (detected tier only logs hints). tx_rate_limiter paces sendTx / sendTxBatch; the execution client shares one limiter across this and the WebSocket sendTx path so their combined rate honours the single venue tx bucket. The data client passes None (it sends no transactions).

§Errors

Returns an error if the underlying HTTP client cannot be created.

Source

pub fn base_url(&self) -> &str

Returns the configured REST base URL.

Source

pub const fn environment(&self) -> LighterEnvironment

Returns the configured Lighter environment.

Source

pub fn set_base_url(&mut self, base_url: &str)

Overrides the REST base URL. Intended for mock-server tests.

Source

pub fn set_retry_manager( &mut self, retry_manager: RetryManager<LighterHttpError>, )

Overrides the retry manager. Intended for mock-server tests that need shorter backoff than [create_http_retry_manager] produces.

Source

pub async fn get_order_books( &self, query: &LighterOrderBooksQuery, ) -> LighterHttpResult<LighterOrderBooks>

Calls GET /api/v1/orderBooks.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_order_book_details( &self, query: &LighterOrderBookDetailsQuery, ) -> LighterHttpResult<LighterOrderBookDetails>

Calls GET /api/v1/orderBookDetails.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_order_book_orders( &self, query: &LighterOrderBookOrdersQuery, ) -> LighterHttpResult<LighterOrderBookOrders>

Calls GET /api/v1/orderBookOrders.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_recent_trades( &self, query: &LighterRecentTradesQuery, ) -> LighterHttpResult<LighterTrades>

Calls GET /api/v1/recentTrades.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_trades( &self, query: &LighterTradesQuery, ) -> LighterHttpResult<LighterTrades>

Calls GET /api/v1/trades.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_candles( &self, query: &LighterCandlesQuery, ) -> LighterHttpResult<LighterCandles>

Calls GET /api/v1/candles.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_fundings( &self, query: &LighterFundingsQuery, ) -> LighterHttpResult<LighterFundings>

Calls GET /api/v1/fundings.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_account( &self, query: &LighterAccountQuery, ) -> LighterHttpResult<LighterAccountsResponse>

Calls GET /api/v1/account.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_account_active_orders( &self, query: &LighterAccountActiveOrdersQuery, ) -> LighterHttpResult<LighterOrders>

Calls GET /api/v1/accountActiveOrders.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_account_inactive_orders( &self, query: &LighterAccountInactiveOrdersQuery, ) -> LighterHttpResult<LighterOrders>

Calls GET /api/v1/accountInactiveOrders.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_next_nonce( &self, query: &LighterNextNonceQuery, ) -> LighterHttpResult<LighterNextNonce>

Calls GET /api/v1/nextNonce.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn get_maker_only_api_keys( &self, query: &LighterMakerOnlyApiKeysQuery, ) -> LighterHttpResult<LighterMakerOnlyApiKeys>

Calls GET /api/v1/getMakerOnlyApiKeys.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn send_tx( &self, request: &LighterSendTxRequest, ) -> LighterHttpResult<LighterSendTxResponse>

Calls POST /api/v1/sendTx.

§Errors

Returns an error if the request fails or the response is invalid.

Source

pub async fn send_tx_batch( &self, request: &LighterSendTxBatchRequest, ) -> LighterHttpResult<LighterSendTxBatchResponse>

Calls POST /api/v1/sendTxBatch.

§Errors

Returns an error if the request fails or the response is invalid.

Trait Implementations§

Source§

impl Clone for LighterRawHttpClient

Source§

fn clone(&self) -> LighterRawHttpClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LighterRawHttpClient

Source§

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

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

impl Default for LighterRawHttpClient

Source§

fn default() -> Self

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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<T> Ungil for T
where T: Send,

§

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