Class AnchorProvider

The network and wallet context used to send transactions paid for and signed by the provider.

Hierarchy

AnchorProvider

Implements

Provider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new AnchorProvider(connection: Connection, wallet: Wallet, opts?: ConfirmOptions): AnchorProvider

- Defined in packages/anchor/src/provider.ts:63
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

Properties

Readonly connection

connection: Connection

Readonly opts

opts: ConfirmOptions = ...

Readonly publicKey

publicKey: PublicKey

Readonly wallet

wallet: Wallet

Methods

sendAll

sendAll<T>(txWithSigners: { signers?: Signer[]; tx: T }[], opts?: ConfirmOptions): Promise<string[]>

Implementation of Provider.sendAll
- Defined in packages/anchor/src/provider.ts:201
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: Transaction | VersionedTransaction, signers?: Signer[], opts?: ConfirmOptions): Promise<string>

Implementation of Provider.sendAndConfirm
- Defined in packages/anchor/src/provider.ts:134
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: ConfirmOptions
  
  Transaction confirmation options.
Returns Promise<string>

simulate

simulate(tx: Transaction | VersionedTransaction, signers?: Signer[], commitment?: Commitment, includeAccounts?: boolean | PublicKey[]): Promise<SuccessfulTxSimulationResponse>

Implementation of Provider.simulate
- Defined in packages/anchor/src/provider.ts:291
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

- Defined in packages/anchor/src/provider.ts:71
Returns ConfirmOptions

Static env

env(): AnchorProvider

- Defined in packages/anchor/src/provider.ts:109
Returns a Provider read from the ANCHOR_PROVIDER_URL environment variable

(This api is for Node only.)

Returns AnchorProvider

Static local

local(url?: string, opts?: ConfirmOptions): AnchorProvider

- Defined in packages/anchor/src/provider.ts:86
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

Generated using TypeDoc