Class TransactionBuilder

A builder that helps construct transactions.

Hierarchy

TransactionBuilder

Implements

HasWrappedInstructions

Constructors

constructor

new TransactionBuilder(items?: WrappedInstruction[], options?: TransactionBuilderOptions): TransactionBuilder
Parameters
- items: WrappedInstruction[] = []
- options: TransactionBuilderOptions = {}
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:76

Properties

`Readonly` items

items: WrappedInstruction[] = []

`Readonly` options

options: TransactionBuilderOptions = {}

Methods

add

add(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:103

addRemainingAccounts

addRemainingAccounts(accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[], instructionIndex?: number): TransactionBuilder
Parameters
- accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[]
- Optional instructionIndex: number
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:117

append

append(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:96

build

build(context: Pick<Context, "payer" | "transactions">): Transaction
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns Transaction
- Defined in packages/umi/src/TransactionBuilder.ts:276

buildAndSign

buildAndSign(context: Pick<Context, "rpc" | "payer" | "transactions">): Promise<Transaction>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
Returns Promise<Transaction>
- Defined in packages/umi/src/TransactionBuilder.ts:307

buildWithLatestBlockhash

buildWithLatestBlockhash(context: Pick<Context, "rpc" | "payer" | "transactions">, options?: RpcBaseOptions): Promise<Transaction>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- options: RpcBaseOptions = {}
Returns Promise<Transaction>
- Defined in packages/umi/src/TransactionBuilder.ts:296

confirm

confirm(context: Pick<Context, "rpc" | "payer" | "transactions">, signature: Uint8Array, options?: Partial<RpcConfirmTransactionOptions>): Promise<RpcConfirmTransactionResult>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- signature: Uint8Array
- options: Partial<RpcConfirmTransactionOptions> = {}
Returns Promise<RpcConfirmTransactionResult>
- Defined in packages/umi/src/TransactionBuilder.ts:324

empty

empty(): TransactionBuilder
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:81

fitsInOneTransaction

fitsInOneTransaction(context: Pick<Context, "payer" | "transactions">): boolean
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns boolean
- Defined in packages/umi/src/TransactionBuilder.ts:270

getBlockhash

getBlockhash(): undefined | string
Returns undefined | string
- Defined in packages/umi/src/TransactionBuilder.ts:216

getBytesCreatedOnChain

getBytesCreatedOnChain(): number
Returns number
- Defined in packages/umi/src/TransactionBuilder.ts:246

getFeePayer

getFeePayer(context: Pick<Context, "payer">): Signer
Parameters
- context: Pick<Context, "payer">
Returns Signer
- Defined in packages/umi/src/TransactionBuilder.ts:191

getInstructions

getInstructions(): Instruction[]
Returns Instruction[]
- Defined in packages/umi/src/TransactionBuilder.ts:235

getRentCreatedOnChain

getRentCreatedOnChain(context: Pick<Context, "rpc">): Promise<SolAmount>
Parameters
- context: Pick<Context, "rpc">
Returns Promise<SolAmount>
- Defined in packages/umi/src/TransactionBuilder.ts:250

getSigners

getSigners(context: Pick<Context, "payer">): Signer[]
Parameters
- context: Pick<Context, "payer">
Returns Signer[]
- Defined in packages/umi/src/TransactionBuilder.ts:239

getTransactionSize

getTransactionSize(context: Pick<Context, "payer" | "transactions">): number
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns number
- Defined in packages/umi/src/TransactionBuilder.ts:258

mapInstructions

mapInstructions(fn: ((wrappedInstruction: WrappedInstruction, index: number, array: WrappedInstruction[]) => WrappedInstruction)): TransactionBuilder
Parameters
- fn: ((wrappedInstruction: WrappedInstruction, index: number, array: WrappedInstruction[]) => WrappedInstruction)
  - - (wrappedInstruction: WrappedInstruction, index: number, array: WrappedInstruction[]): WrappedInstruction
    - Parameters
      
      wrappedInstruction: WrappedInstruction
      
      index: number
      
      array: WrappedInstruction[]
      
      Returns WrappedInstruction
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:107

minimumTransactionsRequired

minimumTransactionsRequired(context: Pick<Context, "payer" | "transactions">): number
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns number
- Defined in packages/umi/src/TransactionBuilder.ts:264

`Protected` parseItems

parseItems(input: TransactionBuilderItemsInput): WrappedInstruction[]
Parameters
- input: TransactionBuilderItemsInput
Returns WrappedInstruction[]
- Defined in packages/umi/src/TransactionBuilder.ts:364

prepend

prepend(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:89

send

send(context: Pick<Context, "rpc" | "payer" | "transactions">, options?: RpcSendTransactionOptions): Promise<Uint8Array>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- options: RpcSendTransactionOptions = {}
Returns Promise<Uint8Array>
- Defined in packages/umi/src/TransactionBuilder.ts:316

sendAndConfirm

sendAndConfirm(context: Pick<Context, "rpc" | "payer" | "transactions">, options?: TransactionBuilderSendAndConfirmOptions): Promise<{
result: RpcConfirmTransactionResult;
signature: Uint8Array;
}>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- options: TransactionBuilderSendAndConfirmOptions = {}
Returns Promise<{
result: RpcConfirmTransactionResult;
signature: Uint8Array;
}>
- Defined in packages/umi/src/TransactionBuilder.ts:348

setAddressLookupTables

setAddressLookupTables(addressLookupTables: AddressLookupTableInput[]): TransactionBuilder
Parameters
- addressLookupTables: AddressLookupTableInput[]
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:207

setBlockhash

setBlockhash(blockhash: string | BlockhashWithExpiryBlockHeight): TransactionBuilder
Parameters
- blockhash: string | BlockhashWithExpiryBlockHeight
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:222

setFeePayer

setFeePayer(feePayer: Signer): TransactionBuilder
Parameters
- feePayer: Signer
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:187

setItems

setItems(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:85

setLatestBlockhash

setLatestBlockhash(context: Pick<Context, "rpc">, options?: RpcBaseOptions): Promise<TransactionBuilder>
Parameters
- context: Pick<Context, "rpc">
- options: RpcBaseOptions = {}
Returns Promise<TransactionBuilder>
- Defined in packages/umi/src/TransactionBuilder.ts:228

setVersion

setVersion(version: TransactionVersion): TransactionBuilder
Parameters
- version: TransactionVersion
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:195

splitByIndex

splitByIndex(index: number): [TransactionBuilder, TransactionBuilder]
Parameters
- index: number
Returns [TransactionBuilder, TransactionBuilder]
- Defined in packages/umi/src/TransactionBuilder.ts:146

unsafeSplitByTransactionSize

unsafeSplitByTransactionSize(context: Pick<Context, "payer" | "transactions">): TransactionBuilder[]
Split the builder into multiple builders, such that each of them should fit in a single transaction.

This method is unsafe for several reasons:
- Because transactions are atomic, splitting the builder into multiple transactions may cause undesired side effects. For example, if the first transaction succeeds but the second one fails, you may end up with an inconsistent account state. This is why it is recommended to manually split your transactions such that each of them is valid on its own.
- It can only split the instructions of the builder. Meaning that, if the builder has a single instruction that is too big to fit in a single transaction, it will not be able to split it.
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns TransactionBuilder[]
- Defined in packages/umi/src/TransactionBuilder.ts:168

useLegacyVersion

useLegacyVersion(): TransactionBuilder
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:199

useV0

useV0(): TransactionBuilder
Returns TransactionBuilder
- Defined in packages/umi/src/TransactionBuilder.ts:203

Class TransactionBuilder

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

items: WrappedInstruction[] = []

options: TransactionBuilderOptions = {}

Returns TransactionBuilder

Properties

Readonly items

Readonly options

Methods

add

Parameters

input: TransactionBuilderItemsInput

Returns TransactionBuilder

addRemainingAccounts

Parameters

accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[]

Optional instructionIndex: number

Returns TransactionBuilder

append

Parameters

input: TransactionBuilderItemsInput

Returns TransactionBuilder

build

Parameters

context: Pick<Context, "payer" | "transactions">

Returns Transaction

buildAndSign

Parameters

context: Pick<Context, "rpc" | "payer" | "transactions">

Returns Promise<Transaction>

buildWithLatestBlockhash

Parameters

context: Pick<Context, "rpc" | "payer" | "transactions">

options: RpcBaseOptions = {}

Returns Promise<Transaction>

confirm

Parameters

context: Pick<Context, "rpc" | "payer" | "transactions">

signature: Uint8Array

options: Partial<RpcConfirmTransactionOptions> = {}

Returns Promise<RpcConfirmTransactionResult>

empty

Returns TransactionBuilder

fitsInOneTransaction

Parameters

context: Pick<Context, "payer" | "transactions">

Returns boolean

getBlockhash

Returns undefined | string

getBytesCreatedOnChain

Returns number

getFeePayer

Parameters

context: Pick<Context, "payer">

Returns Signer

getInstructions

Returns Instruction[]

getRentCreatedOnChain

Parameters

context: Pick<Context, "rpc">

Returns Promise<SolAmount>

getSigners

Parameters

context: Pick<Context, "payer">

Returns Signer[]

getTransactionSize

Parameters

context: Pick<Context, "payer" | "transactions">

Returns number

mapInstructions

Parameters

fn: ((wrappedInstruction: WrappedInstruction, index: number, array: WrappedInstruction[]) => WrappedInstruction)

`Readonly` items

`Readonly` options

`Optional` instructionIndex: number

`Protected` parseItems

Returns Promise<{
result: RpcConfirmTransactionResult;
signature: Uint8Array;
}>