Struct anchor_client::RequestBuilder

pub struct RequestBuilder<'a, C> { /* private fields */ }

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

Implementations

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

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

Available on crate feature async only.

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

Available on crate feature async only.

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

Available on crate feature async only.

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

Available on crate feature async only.

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

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

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

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

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

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

Set the accounts to pass to the instruction.

accounts argument can be:

• Any type that implements ToAccountMetas trait
• A vector of AccountMetas (for remaining accounts)

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()?;

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

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

pub fn signer(self, signer: &'a dyn Signer) -> Self

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

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