abstractBaseTransaction <TransactionObject>

This base class will likely be subject to further refactoring along the introduction of additional tx types on the Ethereum network.

It is therefore not recommended to use directly.

Index

Constructors

• constructor

Properties

• common
• data
• gasLimit
• nonce
• r
• s
• to
• v
• value

Accessors

• type

Methods

• errorStr
• getBaseFee
• getDataFee
• getMessageToSign
• getMessageToVerifySignature
• getSenderAddress
• getSenderPublicKey
• getUpfrontCost
• hash
• isSigned
• raw
• serialize
• sign
• supports
• toCreationAddress
• toJSON
• validate
• verifySignature

Constructors

publicconstructor

• new BaseTransaction<TransactionObject>(txData: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData, opts: TxOptions): BaseTransaction<TransactionObject>

• Type parameters

  • TransactionObject

  Parameters

  • txData: TxData | AccessListEIP2930TxData | FeeMarketEIP1559TxData

  • opts: TxOptions

  Returns BaseTransaction<TransactionObject>

Properties

publicreadonlycommon

common: Common

publicreadonlydata

data: Buffer

publicreadonlygasLimit

gasLimit: bigint

publicreadonlynonce

nonce: bigint

publicoptionalreadonlyr

r?: bigint

publicoptionalreadonlys

s?: bigint

publicoptionalreadonlyto

to?: Address

publicoptionalreadonlyv

v?: bigint

publicreadonlyvalue

value: bigint

Accessors

publictype

• get type(): number

• Returns the transaction type.

  Note: legacy txs will return tx type 0.

  ---

  Returns number

Methods

publicabstracterrorStr

• errorStr(): string

• Return a compact error string representation of the object

  ---

  Returns string

publicgetBaseFee

• getBaseFee(): bigint

• The minimum amount of gas the tx must have (DataFee + TxFee + Creation Fee)

  ---

  Returns bigint

publicgetDataFee

• getDataFee(): bigint

• The amount of gas paid for the data in this tx

  ---

  Returns bigint

publicabstractgetMessageToSign

• getMessageToSign(hashMessage: false): Buffer | Buffer[]
• getMessageToSign(hashMessage?: true): Buffer

• Parameters

  • hashMessage: false

  Returns Buffer | Buffer[]

publicabstractgetMessageToVerifySignature

• getMessageToVerifySignature(): Buffer

• Returns Buffer

publicgetSenderAddress

• getSenderAddress(): Address

• Returns the sender’s address

  ---

  Returns Address

publicabstractgetSenderPublicKey

• getSenderPublicKey(): Buffer

• Returns the public key of the sender

  ---

  Returns Buffer

publicabstractgetUpfrontCost

• getUpfrontCost(): bigint

• The up front amount that an account must have for this transaction to be valid

  ---

  Returns bigint

publicabstracthash

• hash(): Buffer

• Returns Buffer

publicisSigned

• isSigned(): boolean

• Returns boolean

publicabstractraw

• raw(): TxValuesArray | AccessListEIP2930ValuesArray | FeeMarketEIP1559ValuesArray

• Returns a Buffer Array of the raw Buffers of this transaction, in order.

  Use BaseTransaction.serialize to add a transaction to a block with Block.fromValuesArray.

  For an unsigned tx this method uses the empty Buffer values for the signature parameters v, r and s for encoding. For an EIP-155 compliant representation for external signing use BaseTransaction.getMessageToSign.

  ---

  Returns TxValuesArray | AccessListEIP2930ValuesArray | FeeMarketEIP1559ValuesArray

publicabstractserialize

• serialize(): Buffer

• Returns the encoding of the transaction.

  ---

  Returns Buffer

publicsign

• sign(privateKey: Buffer): TransactionObject

• Signs a transaction.

  Note that the signed tx is returned as a new object, use as follows:

  const signedTx = tx.sign(privateKey)

  ---

  Parameters

  • privateKey: Buffer

  Returns TransactionObject

publicsupports

• supports(capability: Capability): boolean

• Checks if a tx type defining capability is active on a tx, for example the EIP-1559 fee market mechanism or the EIP-2930 access list feature.

  Note that this is different from the tx type itself, so EIP-2930 access lists can very well be active on an EIP-1559 tx for example.

  This method can be useful for feature checks if the tx type is unknown (e.g. when instantiated with the tx factory).

  See Capabilites in the types module for a reference on all supported capabilities.

  ---

  Parameters

  • capability: Capability

  Returns boolean

publictoCreationAddress

• toCreationAddress(): boolean

• If the tx’s to is to the creation address

  ---

  Returns boolean

publicabstracttoJSON

• toJSON(): JsonTx

• Returns an object with the JSON representation of the transaction

  ---

  Returns JsonTx

publicvalidate

• validate(): boolean
• validate(stringError: false): boolean
• validate(stringError: true): string[]

• Checks if the transaction has the minimum amount of gas required (DataFee + TxFee + Creation Fee).

  ---

  Returns boolean

publicverifySignature

• verifySignature(): boolean

• Determines if the signature is valid

  ---

  Returns boolean