Class AnchorProvider

constructor

• new AnchorProvider(connection, wallet, opts?): AnchorProvider

• Parameters

  • connection: Connection

    The cluster connection where the program is deployed.
  • wallet: Wallet

    The wallet used to pay for and sign all transactions.
  • opts: ConfirmOptions = ...

    Transaction confirmation options to use by default.

  Returns AnchorProvider

Readonly connection

Readonly opts

Readonly publicKey

Readonly wallet

sendAll

• sendAll<T>(txWithSigners, opts?): Promise<string[]>

• Similar to send, but for an array of transactions and signers. All transactions need to be of the same type, it doesn't support a mix of VersionedTransactions and Transactions.

  Type Parameters

  • T extends Transaction | VersionedTransaction

  Parameters

  • txWithSigners: {
        signers?: Signer[];
        tx: T;
    }[]

    Array of transactions and signers.
  • Optional opts: ConfirmOptions

    Transaction confirmation options.

  Returns Promise<string[]>

sendAndConfirm

• sendAndConfirm(tx, signers?, opts?): Promise<string>

• Sends the given transaction, paid for and signed by the provider's wallet.

  Parameters

  • tx: Transaction | VersionedTransaction

    The transaction to send.
  • Optional signers: Signer[]

    The signers of the transaction.
  • Optional opts: ConfirmOptionsWithBlockhash

    Transaction confirmation options.

  Returns Promise<string>

simulate

• simulate(tx, signers?, commitment?, includeAccounts?): Promise<SuccessfulTxSimulationResponse>

• Simulates the given transaction, returning emitted logs from execution.

  Parameters

  • tx: Transaction | VersionedTransaction

    The transaction to send.
  • Optional signers: Signer[]

    The signers of the transaction. If unset, the transaction will be simulated with the "sigVerify: false" option. This allows for simulation of transactions without asking the wallet for a signature.
  • Optional commitment: Commitment
  • Optional includeAccounts: boolean | PublicKey[]

  Returns Promise<SuccessfulTxSimulationResponse>

Static defaultOptions

• defaultOptions(): ConfirmOptions

• Returns ConfirmOptions

Static env

• env(): AnchorProvider

• Returns a Provider read from the ANCHOR_PROVIDER_URL environment variable

  (This api is for Node only.)

  Returns AnchorProvider

Static local

• local(url?, opts?): AnchorProvider

• Returns a Provider with a wallet read from the local filesystem.

  Parameters

  • Optional url: string

    The network cluster url.
  • opts: ConfirmOptions = ...

    The default transaction confirmation options.

    (This api is for Node only.)

  Returns AnchorProvider