Class TransactionBuilder

A builder that helps construct transactions.

Hierarchy

TransactionBuilder

Implements

HasWrappedInstructions

Constructors

constructor

new TransactionBuilder(items?: WrappedInstruction[], options?: TransactionBuilderOptions): TransactionBuilder
Parameters
- Optional items: WrappedInstruction[]
- Optional options: TransactionBuilderOptions
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:50

Properties

`Readonly` items

items: WrappedInstruction[]

`Readonly` options

options: TransactionBuilderOptions

Methods

add

add(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:55

addRemainingAccounts

addRemainingAccounts(accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[], instructionIndex?: number): TransactionBuilder
Parameters
- accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[]
- Optional instructionIndex: number
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:57

append

append(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:54

build

build(context: Pick<Context, "payer" | "transactions">): Transaction
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns Transaction
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:91

buildAndSign

buildAndSign(context: Pick<Context, "rpc" | "payer" | "transactions">): Promise<Transaction>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
Returns Promise<Transaction>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:93

buildWithLatestBlockhash

buildWithLatestBlockhash(context: Pick<Context, "rpc" | "payer" | "transactions">, options?: RpcBaseOptions): Promise<Transaction>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- Optional options: RpcBaseOptions
Returns Promise<Transaction>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:92

confirm

confirm(context: Pick<Context, "rpc" | "payer" | "transactions">, signature: Uint8Array, options?: Partial<RpcConfirmTransactionOptions>): Promise<RpcConfirmTransactionResult>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- signature: Uint8Array
- Optional options: Partial<RpcConfirmTransactionOptions>
Returns Promise<RpcConfirmTransactionResult>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:95

empty

empty(): TransactionBuilder
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:51

fitsInOneTransaction

fitsInOneTransaction(context: Pick<Context, "payer" | "transactions">): boolean
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns boolean
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:90

getBlockhash

getBlockhash(): undefined | string
Returns undefined | string
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:81

getBytesCreatedOnChain

getBytesCreatedOnChain(): number
Returns number
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:86

getFeePayer

getFeePayer(context: Pick<Context, "payer">): Signer
Parameters
- context: Pick<Context, "payer">
Returns Signer
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:76

getInstructions

getInstructions(): Instruction[]
Returns Instruction[]
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:84

getRentCreatedOnChain

getRentCreatedOnChain(context: Pick<Context, "rpc">): Promise<SolAmount>
Parameters
- context: Pick<Context, "rpc">
Returns Promise<SolAmount>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:87

getSigners

getSigners(context: Pick<Context, "payer">): Signer[]
Parameters
- context: Pick<Context, "payer">
Returns Signer[]
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:85

getTransactionSize

getTransactionSize(context: Pick<Context, "payer" | "transactions">): number
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns number
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:88

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 node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:56

minimumTransactionsRequired

minimumTransactionsRequired(context: Pick<Context, "payer" | "transactions">): number
Parameters
- context: Pick<Context, "payer" | "transactions">
Returns number
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:89

`Protected` parseItems

parseItems(input: TransactionBuilderItemsInput): WrappedInstruction[]
Parameters
- input: TransactionBuilderItemsInput
Returns WrappedInstruction[]
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:100

prepend

prepend(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:53

send

send(context: Pick<Context, "rpc" | "payer" | "transactions">, options?: RpcSendTransactionOptions): Promise<Uint8Array>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- Optional options: RpcSendTransactionOptions
Returns Promise<Uint8Array>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:94

sendAndConfirm

sendAndConfirm(context: Pick<Context, "rpc" | "payer" | "transactions">, options?: TransactionBuilderSendAndConfirmOptions): Promise<{
result: RpcConfirmTransactionResult;
signature: Uint8Array;
}>
Parameters
- context: Pick<Context, "rpc" | "payer" | "transactions">
- Optional options: TransactionBuilderSendAndConfirmOptions
Returns Promise<{
result: RpcConfirmTransactionResult;
signature: Uint8Array;
}>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:96

setAddressLookupTables

setAddressLookupTables(addressLookupTables: AddressLookupTableInput[]): TransactionBuilder
Parameters
- addressLookupTables: AddressLookupTableInput[]
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:80

setBlockhash

setBlockhash(blockhash: string | BlockhashWithExpiryBlockHeight): TransactionBuilder
Parameters
- blockhash: string | BlockhashWithExpiryBlockHeight
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:82

setFeePayer

setFeePayer(feePayer: Signer): TransactionBuilder
Parameters
- feePayer: Signer
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:75

setItems

setItems(input: TransactionBuilderItemsInput): TransactionBuilder
Parameters
- input: TransactionBuilderItemsInput
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:52

setLatestBlockhash

setLatestBlockhash(context: Pick<Context, "rpc">, options?: RpcBaseOptions): Promise<TransactionBuilder>
Parameters
- context: Pick<Context, "rpc">
- Optional options: RpcBaseOptions
Returns Promise<TransactionBuilder>
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:83

setVersion

setVersion(version: TransactionVersion): TransactionBuilder
Parameters
- version: TransactionVersion
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:77

splitByIndex

splitByIndex(index: number): [TransactionBuilder, TransactionBuilder]
Parameters
- index: number
Returns [TransactionBuilder, TransactionBuilder]
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:58

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 node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:74

useLegacyVersion

useLegacyVersion(): TransactionBuilder
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:78

useV0

useV0(): TransactionBuilder
Returns TransactionBuilder
- Defined in node_modules/.pnpm/@metaplex-foundation+umi@0.8.10/node_modules/@metaplex-foundation/umi/dist/types/TransactionBuilder.d.ts:79

Class TransactionBuilder

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional items: WrappedInstruction[]

Optional 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">

Optional options: RpcBaseOptions

Returns Promise<Transaction>

confirm

Parameters

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

signature: Uint8Array

Optional 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)

`Optional` items: WrappedInstruction[]

`Optional` options: TransactionBuilderOptions

`Readonly` items

`Readonly` options

`Optional` instructionIndex: number

`Optional` options: RpcBaseOptions

`Optional` options: Partial<RpcConfirmTransactionOptions>

`Protected` parseItems

`Optional` options: RpcSendTransactionOptions

`Optional` options: TransactionBuilderSendAndConfirmOptions

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

`Optional` options: RpcBaseOptions