Struct KrakenTradingRateLimiter

pub struct KrakenTradingRateLimiter { /* private fields */ }

An implementation of the most accurate trading rate limits given by Kraken

Implementations

impl KrakenTradingRateLimiter

Implements the Advanced rate limiting scheme that requires knowing each order’s lifetime.

Detailed documentation is available from several locations, including the overview rate-limiting page, api rate-limiting page and trading rate-limiting page.

pub fn new(user_verification: VerificationTier) -> KrakenTradingRateLimiter

Create a new instance for a user with the given VerificationTier

pub async fn add_order(&mut self)

Wait for the fixed cost of placing an order

pub async fn add_order_batch( &mut self, add_batched_order_request: &AddBatchedOrderRequest, )

Determine the cost and wait appropriately for the given AddBatchedOrderRequest.

The cost of a batch is n / 2, where n is the number of orders in the batch.

pub async fn amend_order( &mut self, tx_id: &Option<String>, client_order_id: &Option<String>, )

Determine the cost of amending an order and wait if necessary

This is inclusive of penalties for orders amended soon after creation or their last amendment.

pub async fn edit_order(&mut self, edit_order_request: &EditOrderRequest)

Determine the cost of editing an order and wait if necessary

This is inclusive of penalties for orders edited soon after creation.

pub async fn cancel_order_tx_id(&mut self, id: &String)

Determine the cost of cancelling the provided order id and wait appropriately

This is inclusive of penalties for orders cancelled soon after creation.

pub async fn cancel_order_user_ref(&mut self, id: &i64)

Determine the cost of cancelling the provided user ref and wait appropriately

This is inclusive of penalties for orders cancelled soon after creation.

pub async fn notify_add_order( &mut self, tx_id: String, placement_time: i64, user_ref: Option<i64>, client_order_id: &Option<String>, )

Notify the rate limiter of a new order being created – this is essential to the rate limiting scheme!

Order lifetimes must be known in order to determine the penalties for editing or cancelling orders that were placed less than 300s ago.

pub async fn notify_amend_order( &mut self, tx_id: &Option<String>, placement_time: i64, client_order_id: &Option<String>, )

Notify the cache that an order was amended at the given time – this is essential to the rate limiting scheme!

Trait Implementations

impl Clone for KrakenTradingRateLimiter

fn clone(&self) -> KrakenTradingRateLimiter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KrakenTradingRateLimiter

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

Formats the value using the given formatter.