Class TransactionBuilder

constructor

• new TransactionBuilder(
      items?: WrappedInstruction[],
      options?: TransactionBuilderOptions,
  ): TransactionBuilder

  Parameters

  • items: WrappedInstruction[] = []
  • options: TransactionBuilderOptions = {}

  Returns TransactionBuilder

Readonlyitems

Readonlyoptions

add

• add(input: TransactionBuilderItemsInput): TransactionBuilder

  Parameters

  • input: TransactionBuilderItemsInput

  Returns TransactionBuilder

addRemainingAccounts

• addRemainingAccounts(
      accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[],
      instructionIndex?: number,
  ): TransactionBuilder

  Parameters

  • accountMeta: AccountMeta | SignerMeta | (AccountMeta | SignerMeta)[]
  • OptionalinstructionIndex: number

  Returns TransactionBuilder

append

• append(input: TransactionBuilderItemsInput): TransactionBuilder

  Parameters

  • input: TransactionBuilderItemsInput

  Returns TransactionBuilder

build

• build(context: Pick<Context, "transactions" | "payer">): Transaction

  Parameters

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

  Returns Transaction

buildAndSign

• buildAndSign(
      context: Pick<Context, "transactions" | "rpc" | "payer">,
  ): Promise<Transaction>

  Parameters

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

  Returns Promise<Transaction>

buildWithLatestBlockhash

• buildWithLatestBlockhash(
      context: Pick<Context, "transactions" | "rpc" | "payer">,
      options?: RpcBaseOptions,
  ): Promise<Transaction>

  Parameters

  • context: Pick<Context, "transactions" | "rpc" | "payer">
  • options: RpcBaseOptions = {}

  Returns Promise<Transaction>

confirm

• confirm(
      context: Pick<Context, "transactions" | "rpc" | "payer">,
      signature: TransactionSignature,
      options?: Partial<RpcConfirmTransactionOptions>,
  ): Promise<RpcConfirmTransactionResult>

  Parameters

  • context: Pick<Context, "transactions" | "rpc" | "payer">
  • signature: TransactionSignature
  • options: Partial<RpcConfirmTransactionOptions> = {}

  Returns Promise<RpcConfirmTransactionResult>

empty

• empty(): TransactionBuilder

  Returns TransactionBuilder

fitsInOneTransaction

• fitsInOneTransaction(context: Pick<Context, "transactions" | "payer">): boolean

  Parameters

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

  Returns boolean

getBlockhash

• getBlockhash(): undefined | string

  Returns undefined | string

getBytesCreatedOnChain

• getBytesCreatedOnChain(): number

  Returns number

getFeePayer

• getFeePayer(context: Pick<Context, "payer">): Signer

  Parameters

  • context: Pick<Context, "payer">

  Returns Signer

getInstructions

• getInstructions(): Instruction[]

  Returns Instruction[]

getRentCreatedOnChain

• getRentCreatedOnChain(context: Pick<Context, "rpc">): Promise<SolAmount>

  Parameters

  • context: Pick<Context, "rpc">

  Returns Promise<SolAmount>

getSigners

• getSigners(context: Pick<Context, "payer">): Signer[]

  Parameters

  • context: Pick<Context, "payer">

  Returns Signer[]

getTransactionSize

• getTransactionSize(context: Pick<Context, "transactions" | "payer">): number

  Parameters

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

  Returns number

mapInstructions

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

  Parameters

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

  Returns TransactionBuilder

minimumTransactionsRequired

• minimumTransactionsRequired(
      context: Pick<Context, "transactions" | "payer">,
  ): number

  Parameters

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

  Returns number

prepend

• prepend(input: TransactionBuilderItemsInput): TransactionBuilder

  Parameters

  • input: TransactionBuilderItemsInput

  Returns TransactionBuilder

send

• send(
      context: Pick<Context, "transactions" | "rpc" | "payer">,
      options?: RpcSendTransactionOptions,
  ): Promise<TransactionSignature>

  Parameters

  • context: Pick<Context, "transactions" | "rpc" | "payer">
  • options: RpcSendTransactionOptions = {}

  Returns Promise<TransactionSignature>

sendAndConfirm

• sendAndConfirm(
      context: Pick<Context, "transactions" | "rpc" | "payer">,
      options?: TransactionBuilderSendAndConfirmOptions,
  ): Promise<
      { result: RpcConfirmTransactionResult; signature: TransactionSignature },
  >

  Parameters

  • context: Pick<Context, "transactions" | "rpc" | "payer">
  • options: TransactionBuilderSendAndConfirmOptions = {}

  Returns Promise<
      { result: RpcConfirmTransactionResult; signature: TransactionSignature },
  >

setAddressLookupTables

• setAddressLookupTables(
      addressLookupTables: AddressLookupTableInput[],
  ): TransactionBuilder

  Parameters

  • addressLookupTables: AddressLookupTableInput[]

  Returns TransactionBuilder

setBlockhash

• setBlockhash(
      blockhash: string | BlockhashWithExpiryBlockHeight,
  ): TransactionBuilder

  Parameters

  • blockhash: string | BlockhashWithExpiryBlockHeight

  Returns TransactionBuilder

setFeePayer

• setFeePayer(feePayer: Signer): TransactionBuilder

  Parameters

  • feePayer: Signer

  Returns TransactionBuilder

setItems

• setItems(input: TransactionBuilderItemsInput): TransactionBuilder

  Parameters

  • input: TransactionBuilderItemsInput

  Returns TransactionBuilder

setLatestBlockhash

• setLatestBlockhash(
      context: Pick<Context, "rpc">,
      options?: RpcBaseOptions,
  ): Promise<TransactionBuilder>

  Parameters

  • context: Pick<Context, "rpc">
  • options: RpcBaseOptions = {}

  Returns Promise<TransactionBuilder>

setVersion

• setVersion(version: TransactionVersion): TransactionBuilder

  Parameters

  • version: TransactionVersion

  Returns TransactionBuilder

splitByIndex

• splitByIndex(index: number): [TransactionBuilder, TransactionBuilder]

  Parameters

  • index: number

  Returns [TransactionBuilder, TransactionBuilder]

unsafeSplitByTransactionSize

• unsafeSplitByTransactionSize(
      context: Pick<Context, "transactions" | "payer">,
  ): 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, "transactions" | "payer">

  Returns TransactionBuilder[]

useLegacyVersion

• useLegacyVersion(): TransactionBuilder

  Returns TransactionBuilder

useV0

• useV0(): TransactionBuilder

  Returns TransactionBuilder