Struct TransactionBuilder

pub struct TransactionBuilder<'a> { /* private fields */ }

Composable Tx builder for Drift program

Alternatively, use DriftClient::init_tx for simpler instantiation.

use drift_rs::{types::Context, TransactionBuilder, Wallet};

let wallet = Wallet::from_seed_bs58("seed");
let client = DriftClient::new(Context::DevNet, "api.example.com", wallet).await.unwrap();
let account_data = client.get_account(wallet.default_sub_account()).await.unwrap();

let tx = TransactionBuilder::new(client.program_data, wallet.default_sub_account(), account_data.into())
    .cancel_all_orders()
    .place_orders(&[
        NewOrder::default().build(),
        NewOrder::default().build(),
    ])
    .legacy()
    .build();

let signature = client.sign_and_send(tx, &wallet).await?;

Implementations

impl<'a> TransactionBuilder<'a>

pub fn new<'b>( program_data: &'b ProgramData, sub_account: Pubkey, user: Cow<'b, User>, delegated: bool, ) -> Self

where 'b: 'a,

Initialize a new TransactionBuilder for default signer

• program_data - program data from chain
• sub_account - drift sub-account address
• user - drift sub-account data
• delegated - set true to build tx for delegated signing

pub fn force_include_markets( &mut self, readable: &[MarketId], writeable: &[MarketId], )

force given markets to be included in the final tx accounts list (ensure to call before building ixs)

pub fn legacy(self) -> Self

Use legacy tx mode

pub fn lookup_tables(self, lookup_tables: &[AddressLookupTableAccount]) -> Self

Extend the tx lookup tables (always includes the defacto drift LUTs)

pub fn with_priority_fee( self, microlamports_per_cu: u64, cu_limit: Option<u32>, ) -> Self

Set the priority fee of the tx

• microlamports_per_cu - the price per unit of compute in µ-lamports

pub fn add_ix(self, ix: Instruction) -> Self

Append an ix to the Tx

pub fn deposit( self, amount: u64, spot_market_index: u16, user_token_account: Pubkey, reduce_only: Option<bool>, ) -> Self

Deposit collateral into account

pub fn withdraw( self, amount: u64, spot_market_index: u16, user_token_account: Pubkey, reduce_only: Option<bool>, ) -> Self

Withdraw collateral from the account

pub fn place_orders(self, orders: Vec<OrderParams>) -> Self

Place new orders for account

• orders list of orders to place

pub fn cancel_all_orders(self) -> Self

Cancel all orders for account

pub fn cancel_orders( self, market: (u16, MarketType), direction: Option<PositionDirection>, ) -> Self

Cancel account’s orders matching some criteria

• market - tuple of market index and type (spot or perp)
• direction - long or short

pub fn cancel_orders_by_id(self, order_ids: Vec<u32>) -> Self

Cancel orders given ids

pub fn cancel_orders_by_user_id(self, user_order_ids: Vec<u8>) -> Self

Cancel orders by given user ids

pub fn modify_orders(self, orders: &[(u32, ModifyOrderParams)]) -> Self

Modify existing order(s) by order id

pub fn modify_orders_by_user_id( self, orders: &[(u8, ModifyOrderParams)], ) -> Self

Modify existing order(s) by user order id

pub fn place_and_make( self, order: OrderParams, taker_info: &(Pubkey, User), taker_order_id: u32, referrer: Option<Pubkey>, fulfillment_type: Option<SpotFulfillmentType>, ) -> Self

Add a place and make instruction

• order - the order to place
• taker_info - taker account address and data
• taker_order_id - the id of the taker’s order to match with
• referrer - pubkey of the taker’s referrer account, if any
• fulfillment_type - type of fill for spot orders, ignored for perp orders

pub fn place_and_take( self, order: OrderParams, maker_info: Option<(Pubkey, User)>, referrer: Option<Pubkey>, fulfillment_type: Option<SpotFulfillmentType>, success_condition: Option<u32>, ) -> Self

Add a place and take instruction

• order - the order to place
• maker_info - pubkey of the maker/counter-party to take against and account data
• referrer - pubkey of the maker’s referrer account, if any
• fulfillment_type - type of fill for spot orders, ignored for perp orders

pub fn place_and_make_swift_order( self, maker_order: OrderParams, signed_order_info: &SignedOrderInfo, taker_account: &User, taker_account_referrer: &Pubkey, ) -> Self

Place and try to fill (make) against the swift order (Perps only)

• maker_order - order params defined by the maker, e.g. partial or full fill
• signed_order_info - the signed swift order info (i.e from taker)
• taker_account - taker account data
• taker_account_referrer - taker account referrer key

pub fn place_swift_order( self, signed_order_info: &SignedOrderInfo, taker_account: &User, ) -> Self

Place a swift order (Perps only)

☢️ this Ix will not fill by itself. The caller should add a subsequent Ix e.g. with JIT proxy, to atomically place and fill the order or see place_and_make_swift_order

• signed_order_info - the signed swift order info
• taker_account - taker subaccount data

pub fn set_max_initial_margin_ratio( self, margin_ratio: u32, sub_account_id: u16, ) -> Self

Set the subaccount’s max initial margin ratio.

• sub_account_id - index of the subaccount
• margin_ratio - new margin ratio in MARGIN_PRECISION

MARGIN_PRECISION => 1x leverage MARGIN_PRECISION * 10 => .1x leverage MARGIN_PRECISION / 10 => 10x leverage

pub fn build(self) -> VersionedMessage

Build the transaction message ready for signing and sending

pub fn program_data(&self) -> &ProgramData

pub fn account_data(&self) -> &Cow<'_, User>