Skip to main content

RequestBuilder

Struct RequestBuilder 

Source
pub struct RequestBuilder<'a, C, S: 'a> { /* private fields */ }
Expand description

RequestBuilder provides a builder interface to create and send transactions to a cluster.

Implementations§

Source§

impl<'a, C: Deref<Target = impl Signer> + Clone> RequestBuilder<'a, C, Arc<dyn ThreadSafeSigner>>

Source

pub fn from( program_id: Pubkey, cluster: &str, payer: C, options: Option<CommitmentConfig>, rpc_client: &'a AsyncRpcClient, ) -> Self

Available on crate feature async only.
Source

pub fn signer<T: ThreadSafeSigner>(self, signer: T) -> Self

Available on crate feature async only.
Source

pub async fn signed_transaction(&self) -> Result<Transaction, ClientError>

Available on crate feature async only.
Source

pub async fn send(self) -> Result<Signature, ClientError>

Available on crate feature async only.
Source

pub async fn send_with_spinner_and_config( self, config: RpcSendTransactionConfig, ) -> Result<Signature, ClientError>

Available on crate feature async only.
Source§

impl<C: Deref<Target = impl Signer> + Clone, S: AsSigner> RequestBuilder<'_, C, S>

Source

pub fn payer(self, payer: C) -> Self

Source

pub fn cluster(self, url: &str) -> Self

Source

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

Source

pub fn program(self, program_id: Pubkey) -> Self

Source

pub fn accounts(self, accounts: impl ToAccountMetas) -> Self

Set the accounts to pass to the instruction.

accounts argument can be:

Note that the given accounts are appended to the previous list of accounts instead of overriding the existing ones (if any).

§Example
program
    .request()
    // Regular accounts
    .accounts(accounts::Initialize {
        my_account: my_account_kp.pubkey(),
        payer: program.payer(),
        system_program: system_program::ID,
    })
    // Remaining accounts
    .accounts(vec![AccountMeta {
        pubkey: remaining,
        is_signer: true,
        is_writable: true,
    }])
    .args(instruction::Initialize { field: 42 })
    .send()?;
Source

pub fn options(self, options: CommitmentConfig) -> Self

Source

pub fn args(self, args: impl InstructionData) -> Self

Source

pub fn instructions(&self) -> Vec<Instruction>

Source

pub fn transaction(&self) -> Transaction

Auto Trait Implementations§

§

impl<'a, C, S> Freeze for RequestBuilder<'a, C, S>
where C: Freeze,

§

impl<'a, C, S> !RefUnwindSafe for RequestBuilder<'a, C, S>

§

impl<'a, C, S> Send for RequestBuilder<'a, C, S>
where C: Send, S: Send,

§

impl<'a, C, S> Sync for RequestBuilder<'a, C, S>
where C: Sync, S: Sync,

§

impl<'a, C, S> Unpin for RequestBuilder<'a, C, S>
where C: Unpin, S: Unpin,

§

impl<'a, C, S> UnsafeUnpin for RequestBuilder<'a, C, S>
where C: UnsafeUnpin,

§

impl<'a, C, S> !UnwindSafe for RequestBuilder<'a, C, S>

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

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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