Struct GrpcSubscribeOpts

pub struct GrpcSubscribeOpts {
    pub usermap: bool,
    pub user_stats_map: bool,
    pub user_accounts: Vec<Pubkey>,
    pub on_slot: Option<Box<OnSlotFn>>,
    pub on_account: Option<(AccountFilter, Box<OnAccountFn>)>,
    pub connection_opts: GrpcConnectionOpts,
}

Config options for drift gRPC subscription

  // subscribe to all user and users stats accounts
  let opts = GrpcSubscribeOpts::default()
               .usermap_on() // subscribe to ALL user accounts
               .statsmap_on(); // subscribe to ALL user stats accounts

 // cache specific user accounts only and set a new slot callback
 let first_3_subaccounts = (0_u16..3).into_iter().map(|i| wallet.sub_account(i)).collect();
 let opts = GrpcSubscribeOpts::default()
                .user_accounts(first_3_subaccounts);
                .on_slot(move |new_slot| {}) // slot callback

Fields

usermap: bool

toggle usermap

user_stats_map: bool

toggle user stats map

user_accounts: Vec<Pubkey>

list of user (sub)accounts to subscribe

on_slot: Option<Box<OnSlotFn>>

callback for slot updates

on_account: Option<(AccountFilter, Box<OnAccountFn>)>

custom callback for account updates

connection_opts: GrpcConnectionOpts

Network level connection config

Implementations

impl GrpcSubscribeOpts

pub fn usermap_on(self) -> Self

Cache ALL drift User account updates

useful for e.g. building the DLOB, fast TX building for makers

note: memory requirements ~2GiB

pub fn statsmap_on(self) -> Self

Cache ALL drift UserStats account updates

useful for e.g. fast TX building for makers

pub fn user_accounts(self, users: Vec<Pubkey>) -> Self

Cache account updates for given users only

pub fn on_slot(self, on_slot: impl Fn(Slot) + Send + Sync + 'static) -> Self

Set a callback to invoke on new slot updates

• on_slot - the callback for new slot updates

! on_slot must not block the gRPC task

pub fn on_account( self, filter: AccountFilter, on_account: impl Fn(&AccountUpdate<'_>) + Send + Sync + 'static, ) -> Self

Register a custom callback for account updates

• filter - accounts matching filter will invoke the callback
• on_account - fn to invoke on matching account update

! on_account must not block the gRPC task

pub fn connection_opts(self, opts: GrpcConnectionOpts) -> Self

Set network level connection opts

Trait Implementations

impl Default for GrpcSubscribeOpts

fn default() -> GrpcSubscribeOpts

Returns the “default value” for a type.