ethereumjs-monorepo

@ethereumjs/tx

@ethereumjs/tx / LegacyTx

Class: LegacyTx

Defined in: legacy/tx.ts:82

An Ethereum non-typed (legacy) transaction

Implements

TransactionInterface<typeof Legacy>

Constructors

Constructor

new LegacyTx(txData, opts): LegacyTx

Defined in: legacy/tx.ts:123

This constructor takes the values, validates them, assigns them and freezes the object.

It is not recommended to use this constructor directly. Instead use the static factory methods to assist in creating a Transaction object from varying data types.

Parameters

txData

LegacyTxData

opts

TxOptions = {}

Returns

LegacyTx

Properties

cache

readonly cache: TransactionCache = {}

Defined in: legacy/tx.ts:107

Implementation of

TransactionInterface.cache

common

readonly common: Common

Defined in: legacy/tx.ts:102

Implementation of

TransactionInterface.common

data

readonly data: Uint8Array

Defined in: legacy/tx.ts:91

Implementation of

TransactionInterface.data

gasLimit

readonly gasLimit: bigint

Defined in: legacy/tx.ts:89

Implementation of

TransactionInterface.gasLimit

gasPrice

readonly gasPrice: bigint

Defined in: legacy/tx.ts:87

nonce

readonly nonce: bigint

Defined in: legacy/tx.ts:88

Implementation of

TransactionInterface.nonce

r?

readonly optional r: bigint

Defined in: legacy/tx.ts:96

Implementation of

TransactionInterface.r

s?

readonly optional s: bigint

Defined in: legacy/tx.ts:97

Implementation of

TransactionInterface.s

to?

readonly optional to: Address

Defined in: legacy/tx.ts:92

Implementation of

TransactionInterface.to

txOptions

readonly txOptions: TxOptions

Defined in: legacy/tx.ts:105

Implementation of

TransactionInterface.txOptions

type

type: 0 = TransactionType.Legacy

Defined in: legacy/tx.ts:84

Implementation of

TransactionInterface.type

v?

readonly optional v: bigint

Defined in: legacy/tx.ts:95

Implementation of

TransactionInterface.v

value

readonly value: bigint

Defined in: legacy/tx.ts:90

Implementation of

TransactionInterface.value

Methods

addSignature()

addSignature(v, r, s, convertV): LegacyTx

Defined in: legacy/tx.ts:335

Parameters

v

bigint

r

bigint Uint8Array<ArrayBufferLike>

s

bigint Uint8Array<ArrayBufferLike>

convertV

boolean = false

Returns

LegacyTx

Implementation of

TransactionInterface.addSignature

errorStr()

errorStr(): string

Defined in: legacy/tx.ts:407

Return a compact error string representation of the object

Returns

string

Implementation of

TransactionInterface.errorStr

getDataGas()

getDataGas(): bigint

Defined in: legacy/tx.ts:279

The amount of gas paid for the data in this tx

Returns

bigint

Implementation of

TransactionInterface.getDataGas

getEffectivePriorityFee()

getEffectivePriorityFee(baseFee?): bigint

Defined in: legacy/tx.ts:191

Parameters

baseFee?

bigint

Returns

bigint

getHashedMessageToSign()

getHashedMessageToSign(): Uint8Array<ArrayBufferLike>

Defined in: legacy/tx.ts:271

Returns the hashed serialized unsigned tx, which can be used to sign the transaction (e.g. for sending to a hardware wallet).

Returns

Uint8Array<ArrayBufferLike>

Implementation of

TransactionInterface.getHashedMessageToSign

getIntrinsicGas()

getIntrinsicGas(): bigint

Defined in: legacy/tx.ts:297

The minimum gas limit which the tx to have to be valid. This covers costs as the standard fee (21000 gas), the data fee (paid for each calldata byte), the optional creation fee (if the transaction creates a contract), and if relevant the gas to be paid for access lists (EIP-2930) and authority lists (EIP-7702).

Returns

bigint

Implementation of

TransactionInterface.getIntrinsicGas

getMessageToSign()

getMessageToSign(): Uint8Array<ArrayBufferLike>[]

Defined in: legacy/tx.ts:248

Returns the raw unsigned tx, which can be used to sign the transaction (e.g. for sending to a hardware wallet).

Note: the raw message message format for the legacy tx is not RLP encoded and you might need to do yourself with:

import { RLP } from '@ethereumjs/rlp'
const message = tx.getMessageToSign()
const serializedMessage = RLP.encode(message)) // use this for the HW wallet input

Returns

Uint8Array<ArrayBufferLike>[]

Implementation of

TransactionInterface.getMessageToSign

getMessageToVerifySignature()

getMessageToVerifySignature(): Uint8Array<ArrayBufferLike>

Defined in: legacy/tx.ts:320

Computes a sha3-256 hash which can be used to verify the signature

Returns

Uint8Array<ArrayBufferLike>

Implementation of

TransactionInterface.getMessageToVerifySignature

getSenderAddress()

getSenderAddress(): Address

Defined in: legacy/tx.ts:396

Returns

Address

Implementation of

TransactionInterface.getSenderAddress

getSenderPublicKey()

getSenderPublicKey(): Uint8Array

Defined in: legacy/tx.ts:331

Returns the public key of the sender

Returns

Uint8Array

Implementation of

TransactionInterface.getSenderPublicKey

getUpfrontCost()

getUpfrontCost(): bigint

Defined in: legacy/tx.ts:303

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

Returns

bigint

Implementation of

TransactionInterface.getUpfrontCost

getValidationErrors()

getValidationErrors(): string[]

Defined in: legacy/tx.ts:384

Returns

string[]

Implementation of

TransactionInterface.getValidationErrors

hash()

hash(): Uint8Array

Defined in: legacy/tx.ts:313

Computes a sha3-256 hash of the serialized tx.

This method can only be used for signed txs (it throws otherwise). Use Transaction.getMessageToSign to get a tx hash for the purpose of signing.

Returns

Uint8Array

Implementation of

TransactionInterface.hash

isSigned()

isSigned(): boolean

Defined in: legacy/tx.ts:187

Returns

boolean

Implementation of

TransactionInterface.isSigned

isValid()

isValid(): boolean

Defined in: legacy/tx.ts:388

Returns

boolean

Implementation of

TransactionInterface.isValid

raw()

raw(): LegacyTxValuesArray

Defined in: legacy/tx.ts:208

Returns a Uint8Array Array of the raw Bytes of the legacy transaction, in order.

Format: [nonce, gasPrice, gasLimit, to, value, data, v, r, s]

For legacy txs this is also the correct format to add transactions to a block with createBlockFromBytesArray (use the serialize() method for typed txs).

For an unsigned tx this method returns the empty Bytes values for the signature parameters v, r and s. For an EIP-155 compliant representation have a look at Transaction.getMessageToSign.

Returns

LegacyTxValuesArray

Implementation of

TransactionInterface.raw

serialize()

serialize(): Uint8Array

Defined in: legacy/tx.ts:231

Returns the serialized encoding of the legacy transaction.

Format: rlp([nonce, gasPrice, gasLimit, to, value, data, v, r, s])

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