Class TransactionBuilder<C>

Type Parameters

C extends object = object

Hierarchy

TransactionBuilder

Methods

`Static` make

make<C>(transactionOptions?: TransactionOptions): TransactionBuilder<C>
Type Parameters
- C extends object = object
Parameters
- Optional transactionOptions: TransactionOptions
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:45

splitUsingKey

splitUsingKey(key: string, include?: boolean): [TransactionBuilder<object>, TransactionBuilder<object>]
Parameters
- key: string
- include: boolean = true
Returns [TransactionBuilder<object>, TransactionBuilder<object>]
- Defined in packages/js/src/utils/TransactionBuilder.ts:79

splitBeforeKey

splitBeforeKey(key: string): [TransactionBuilder<object>, TransactionBuilder<object>]
Parameters
- key: string
Returns [TransactionBuilder<object>, TransactionBuilder<object>]
- Defined in packages/js/src/utils/TransactionBuilder.ts:98

splitAfterKey

splitAfterKey(key: string): [TransactionBuilder<object>, TransactionBuilder<object>]
Parameters
- key: string
Returns [TransactionBuilder<object>, TransactionBuilder<object>]
- Defined in packages/js/src/utils/TransactionBuilder.ts:102

getInstructionsWithSigners

getInstructionsWithSigners(): InstructionWithSigners[]
Returns InstructionWithSigners[]
- Defined in packages/js/src/utils/TransactionBuilder.ts:106

getInstructions

getInstructions(): TransactionInstruction[]
Returns TransactionInstruction[]
- Defined in packages/js/src/utils/TransactionBuilder.ts:110

getInstructionCount

getInstructionCount(): number
Returns number
- Defined in packages/js/src/utils/TransactionBuilder.ts:114

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in packages/js/src/utils/TransactionBuilder.ts:118

getSigners

getSigners(): Signer[]
Returns Signer[]
- Defined in packages/js/src/utils/TransactionBuilder.ts:122

setTransactionOptions

setTransactionOptions(transactionOptions: TransactionOptions): TransactionBuilder<C>
Parameters
- transactionOptions: TransactionOptions
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:129

getTransactionOptions

getTransactionOptions(): undefined | TransactionOptions
Returns undefined | TransactionOptions
- Defined in packages/js/src/utils/TransactionBuilder.ts:137

setFeePayer

setFeePayer(feePayer: Signer): TransactionBuilder<C>
Parameters
- feePayer: Signer
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:141

getFeePayer

getFeePayer(): undefined | Signer
Returns undefined | Signer
- Defined in packages/js/src/utils/TransactionBuilder.ts:147

setContext

setContext(context: C): TransactionBuilder<C>
Parameters
- context: C
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:151

getContext

getContext(): C
Returns C
- Defined in packages/js/src/utils/TransactionBuilder.ts:157

when

when(condition: boolean, callback: ((tx: TransactionBuilder<C>) => TransactionBuilder<C>)): TransactionBuilder<C>
Parameters
- condition: boolean
- callback: ((tx: TransactionBuilder<C>) => TransactionBuilder<C>)
  - - (tx: TransactionBuilder<C>): TransactionBuilder<C>
    - Parameters
      
      tx: TransactionBuilder<C>
      
      Returns TransactionBuilder<C>
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:161

unless

unless(condition: boolean, callback: ((tx: TransactionBuilder<C>) => TransactionBuilder<C>)): TransactionBuilder<C>
Parameters
- condition: boolean
- callback: ((tx: TransactionBuilder<C>) => TransactionBuilder<C>)
  - - (tx: TransactionBuilder<C>): TransactionBuilder<C>
    - Parameters
      
      tx: TransactionBuilder<C>
      
      Returns TransactionBuilder<C>
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:168

toTransaction

toTransaction(blockhashWithExpiryBlockHeight: Readonly<{
blockhash: string;
lastValidBlockHeight: number;
}>, options?: TransactionOptions): Transaction
Parameters
- blockhashWithExpiryBlockHeight: Readonly<{
  blockhash: string;
  lastValidBlockHeight: number;
  }>
- options: TransactionOptions = {}
Returns Transaction
- Defined in packages/js/src/utils/TransactionBuilder.ts:175

sendAndConfirm

sendAndConfirm(metaplex: Metaplex, confirmOptions?: ConfirmOptions): Promise<{
response: SendAndConfirmTransactionResponse;
} & C>
Parameters
- metaplex: Metaplex
- Optional confirmOptions: ConfirmOptions
Returns Promise<{
response: SendAndConfirmTransactionResponse;
} & C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:193

Properties

`Protected` records

records: InstructionWithSigners[] = []

The list of all instructions and their respective signers.

`Protected` transactionOptions

transactionOptions: TransactionOptions

Options used when building the transaction.

`Protected` feePayer

feePayer: undefined | Signer = undefined

The signer to use to pay for transaction fees.

`Protected` context

context: C = ...

Any additional context gathered when creating the transaction builder.

Constructors

constructor

new TransactionBuilder<C>(transactionOptions?: TransactionOptions): TransactionBuilder<C>
Type Parameters
- C extends object = object
Parameters
- transactionOptions: TransactionOptions = {}
Returns TransactionBuilder<C>
- Defined in packages/js/src/utils/TransactionBuilder.ts:41

Class TransactionBuilder<C>

Type Parameters

C extends object = object

Hierarchy

Index

Methods

Properties

Constructors

Methods

Static make

Type Parameters

C extends object = object

Parameters

Optional transactionOptions: TransactionOptions

Returns TransactionBuilder<C>

prepend

Parameters

Rest ...txs: (InstructionWithSigners | TransactionBuilder<object>)[]

Returns TransactionBuilder<C>

append

Parameters

Rest ...txs: (InstructionWithSigners | TransactionBuilder<object>)[]

Returns TransactionBuilder<C>

add

Parameters

Rest ...txs: (InstructionWithSigners | TransactionBuilder<object>)[]

Returns TransactionBuilder<C>

splitUsingKey

Parameters

key: string

include: boolean = true

Returns [TransactionBuilder<object>, TransactionBuilder<object>]

splitBeforeKey

Parameters

key: string

Returns [TransactionBuilder<object>, TransactionBuilder<object>]

splitAfterKey

Parameters

key: string

Returns [TransactionBuilder<object>, TransactionBuilder<object>]

getInstructionsWithSigners

Returns InstructionWithSigners[]

getInstructions

Returns TransactionInstruction[]

getInstructionCount

Returns number

isEmpty

Returns boolean

getSigners

Returns Signer[]

setTransactionOptions

Parameters

transactionOptions: TransactionOptions

Returns TransactionBuilder<C>

getTransactionOptions

Returns undefined | TransactionOptions

setFeePayer

Parameters

feePayer: Signer

Returns TransactionBuilder<C>

getFeePayer

Returns undefined | Signer

setContext

Parameters

context: C

Returns TransactionBuilder<C>

getContext

Returns C

when

Parameters

condition: boolean

callback: ((tx: TransactionBuilder<C>) => TransactionBuilder<C>)

Parameters

tx: TransactionBuilder<C>

Returns TransactionBuilder<C>

Returns TransactionBuilder<C>

unless

Parameters

condition: boolean

callback: ((tx: TransactionBuilder<C>) => TransactionBuilder<C>)

`Static` make

`Optional` transactionOptions: TransactionOptions

`Rest` ...txs: (InstructionWithSigners | TransactionBuilder<object>)[]

`Rest` ...txs: (InstructionWithSigners | TransactionBuilder<object>)[]

`Rest` ...txs: (InstructionWithSigners | TransactionBuilder<object>)[]

blockhashWithExpiryBlockHeight: Readonly<{
blockhash: string;
lastValidBlockHeight: number;
}>

`Optional` confirmOptions: ConfirmOptions

Returns Promise<{
response: SendAndConfirmTransactionResponse;
} & C>

`Protected` records

`Protected` transactionOptions

`Protected` feePayer

`Protected` context