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 src/provider.ts:58
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(txWithSigners: { signers?: Signer[]; tx: Transaction }[], opts?: ConfirmOptions): Promise<string[]>

Implementation of Provider.sendAll
- Defined in src/provider.ts:176
Similar to send, but for an array of transactions and signers.

Parameters
- txWithSigners: { signers?: Signer[]; tx: Transaction }[]
- Optional opts: ConfirmOptions
Returns Promise<string[]>

sendAndConfirm

sendAndConfirm(tx: Transaction, signers?: Signer[], opts?: ConfirmOptions): Promise<string>

Implementation of Provider.sendAndConfirm
- Defined in src/provider.ts:126
Sends the given transaction, paid for and signed by the provider's wallet.

Parameters
- tx: Transaction
  
  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, signers?: Signer[], commitment?: Commitment, includeAccounts?: boolean | PublicKey[]): Promise<SuccessfulTxSimulationResponse>

Implementation of Provider.simulate
- Defined in src/provider.ts:223
Simulates the given transaction, returning emitted logs from execution.

Parameters
- tx: Transaction
  
  The transaction to send.
- Optional signers: Signer[]
  
  The signers of the transaction.
- Optional commitment: Commitment
- Optional includeAccounts: boolean | PublicKey[]
Returns Promise<SuccessfulTxSimulationResponse>

Static defaultOptions

defaultOptions(): ConfirmOptions

- Defined in src/provider.ts:66
Returns ConfirmOptions

Static env

env(): AnchorProvider

- Defined in src/provider.ts:101
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 src/provider.ts:81
Returns a Provider with a wallet read from the local filesystem.

Parameters
- Optional url: string
  
  The network cluster url.
- Optional opts: ConfirmOptions
  
  The default transaction confirmation options.
  
  (This api is for Node only.)
Returns AnchorProvider

Generated using TypeDoc