Skip to main content

BatchSigner

Struct BatchSigner 

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

Coalesces concurrent single-message signing into batched proxy calls under a configurable rate budget. Implements ArchSignerT, so call sites are unchanged.

A local backend is passed straight through — see is_batching.

§Examples

use std::time::Duration;
use cosigner_client::{ArchSigner, ArchSignerT, BatchSigner};

let signer = BatchSigner::spawn(ArchSigner::from_env()?)
    .with_max_rps(8.0)
    .with_max_batch(32)
    .with_deadline(Duration::from_millis(2000));

// Unchanged call site; concurrent calls share one proxy round trip.
let response = signer.sign_message(&message).await?;

Implementations§

Source§

impl BatchSigner

Source

pub fn spawn(inner: ArchSigner) -> Self

Creates the signer and the dispatcher that serves it.

A local inner is passed through directly, with no task, channel, or limiter. For a remote inner the dispatcher task starts with the first queued request; apply the builder setters before then, since they configure a queue that is already in use afterwards.

inner’s own retry budget is cleared: the dispatcher owns retry so that every attempt spends a rate-limiter permit.

Source

pub fn is_batching(&self) -> bool

Returns whether requests are coalesced, i.e. whether the backend is remote.

Worth logging beside the resolved backend: under a local signer the batch metrics stay flat, which otherwise reads as a bug.

Source

pub fn with_max_rps(self, rps: f64) -> Self

Returns this signer with the ceiling on activities per second.

A non-positive or non-finite rate means unlimited.

Source

pub fn with_max_batch(self, n: usize) -> Self

Returns this signer with the largest number of messages per activity.

Source

pub fn with_max_in_flight(self, n: usize) -> Self

Returns this signer with the cap on concurrent in-flight activities.

Source

pub fn with_queue_depth(self, n: usize) -> Self

Returns this signer with the bound on queued requests. Beyond it, signing fails immediately rather than waiting.

Source

pub fn with_deadline(self, deadline: Duration) -> Self

Returns this signer with the per-request deadline. A request still queued when it expires is dropped rather than signed.

Source

pub fn with_retries(self, retries: u32) -> Self

Returns this signer with the dispatcher’s retry budget for a whole batch. Each attempt spends a rate-limiter permit.

Trait Implementations§

Source§

impl ArchSignerT for BatchSigner

Source§

fn pubkey(&self) -> Pubkey

Returns the Arch account key this signer signs for.
Source§

fn sign_message<'life0, 'life1, 'async_trait>( &'life0 self, message: &'life1 ArchMessage, ) -> Pin<Box<dyn Future<Output = Result<SignResponse, SignError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs the message’s BIP322 digest. Read more
Source§

fn sign_messages<'life0, 'life1, 'async_trait>( &'life0 self, messages: &'life1 [ArchMessage], ) -> Pin<Box<dyn Future<Output = Result<Vec<Result<SignResponse, SignError>>, SignError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs every message in messages, returning one result per input in input order. Read more
Source§

fn sign_transaction<'life0, 'async_trait>( &'life0 self, message: ArchMessage, ) -> Pin<Box<dyn Future<Output = Result<RuntimeTransaction, SignError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Signs a transaction whose only required signer is this signer. Read more
Source§

fn sign_transaction_mixed<'life0, 'life1, 'async_trait>( &'life0 self, message: ArchMessage, local_cosigners: &'life1 [UntweakedKeypair], ) -> Pin<Box<dyn Future<Output = Result<RuntimeTransaction, SignError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs a transaction with this signer plus local cosigner keypairs. Read more
Source§

impl Debug for BatchSigner

Source§

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

Formats the value using the given formatter. 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
Source§

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

Source§

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.

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

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

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

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 = 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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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