Class Transaction

constructor

• new Transaction(opts?: TransactionBlockhashCtor): Transaction

• Parameters

  • Optionalopts: TransactionBlockhashCtor

  Returns Transaction

• new Transaction(opts?: TransactionNonceCtor): Transaction

• Parameters

  • Optionalopts: TransactionNonceCtor

  Returns Transaction

• new Transaction(opts?: TransactionCtorFields_DEPRECATED): Transaction

• Parameters

  • Optionalopts: TransactionCtorFields_DEPRECATED

  Returns Transaction

  Deprecated

  TransactionCtorFields has been deprecated and will be removed in a future version. Please supply a TransactionBlockhashCtor instead.

OptionalfeePayer

instructions

OptionallastValidBlockHeight

OptionalminNonceContextSlot

OptionalnonceInfo

OptionalrecentBlockhash

signatures

signature

• get signature(): null | Buffer

• The first (payer) Transaction signature

  Returns null | Buffer

  Buffer of payer's signature

add

• add(
      ...items: (
          TransactionInstruction
          | TransactionInstructionCtorFields
          | Transaction
      )[],
  ): Transaction

• Add one or more instructions to this Transaction

  Parameters

  • ...items: (TransactionInstruction | TransactionInstructionCtorFields | Transaction)[]

    Instructions to add to the Transaction

  Returns Transaction

addSignature

• addSignature(pubkey: PublicKey, signature: Buffer): void

• Add an externally created signature to a transaction. The public key must correspond to either the fee payer or a signer account in the transaction instructions.

  Parameters

  • pubkey: PublicKey

    Public key that will be added to the transaction.
  • signature: Buffer

    An externally created signature to add to the transaction.

  Returns void

compileMessage

• compileMessage(): Message

• Compile transaction data

  Returns Message

getEstimatedFee

• getEstimatedFee(connection: Connection): Promise<null | number>

• Get the estimated fee associated with a transaction

  Parameters

  • connection: Connection

    Connection to RPC Endpoint.

  Returns Promise<null | number>

  The estimated fee for the transaction

partialSign

• partialSign(...signers: Signer[]): void

• Partially sign a transaction with the specified accounts. All accounts must correspond to either the fee payer or a signer account in the transaction instructions.

  All the caveats from the sign method apply to partialSign

  Parameters

  • ...signers: Signer[]

    Array of signers that will sign the transaction

  Returns void

serialize

• serialize(config?: SerializeConfig): Buffer

• Serialize the Transaction in the wire format.

  Parameters

  • Optionalconfig: SerializeConfig

    Config of transaction.

  Returns Buffer

  Signature of transaction in wire format.

serializeMessage

• serializeMessage(): Buffer

• Get a buffer of the Transaction data that need to be covered by signatures

  Returns Buffer

setSigners

• setSigners(...signers: PublicKey[]): void

• Specify the public keys which will be used to sign the Transaction. The first signer will be used as the transaction fee payer account.

  Signatures can be added with either partialSign or addSignature

  Parameters

  • ...signers: PublicKey[]

  Returns void

  Deprecated

  Deprecated since v0.84.0. Only the fee payer needs to be specified and it can be set in the Transaction constructor or with the feePayer property.

sign

• sign(...signers: Signer[]): void

• Sign the Transaction with the specified signers. Multiple signatures may be applied to a Transaction. The first signature is considered "primary" and is used identify and confirm transactions.

  If the Transaction feePayer is not set, the first signer will be used as the transaction fee payer account.

  Transaction fields should not be modified after the first call to sign, as doing so may invalidate the signature and cause the Transaction to be rejected.

  The Transaction must be assigned a valid recentBlockhash before invoking this method

  Parameters

  • ...signers: Signer[]

    Array of signers that will sign the transaction

  Returns void

verifySignatures

• verifySignatures(requireAllSignatures?: boolean): boolean

• Verify signatures of a Transaction Optional parameter specifies if we're expecting a fully signed Transaction or a partially signed one. If no boolean is provided, we expect a fully signed Transaction by default.

  Parameters

  • OptionalrequireAllSignatures: boolean = true

    Require a fully signed Transaction

  Returns boolean

Staticfrom

• from(buffer: number[] | Uint8Array | Buffer): Transaction

• Parse a wire transaction into a Transaction object.

  Parameters

  • buffer: number[] | Uint8Array | Buffer

    Signature of wire Transaction

  Returns Transaction

  Transaction associated with the signature

Staticpopulate

• populate(message: Message, signatures?: string[]): Transaction

• Populate Transaction object from message and signatures

  Parameters

  • message: Message

    Message of transaction
  • signatures: string[] = []

    List of signatures to assign to the transaction

  Returns Transaction

  The populated Transaction