TransactionResponse

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:719

A TransactionResponse includes all properties about a transaction that was sent to the network, which may or may not be included in a block.

The [[TransactionResponse-isMined]] can be used to check if the transaction has been mined as well as type guard that the otherwise possibly null properties are defined.

Extended by

Implements

TransactionLike<string>
TransactionResponseParams

Constructors

Constructor

new TransactionResponse(tx, provider): TransactionResponse;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:842

@_ignore:

Parameters

Parameter	Type
`tx`	`TransactionResponseParams`
`provider`	`Provider`

Returns

TransactionResponse

Properties

accessList

readonly accessList: null | AccessList;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:830

The [[link-eip-2930]] access list for transaction types that support it, otherwise null.

Implementation of

TransactionResponseParams.accessList

authorizationList

readonly authorizationList:
  | null
  | Authorization[];

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:838

The [[link-eip-7702]] authorizations (if any).

Implementation of

TransactionResponseParams.authorizationList

blobVersionedHashes

readonly blobVersionedHashes: null | string[];

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:834

The [[link-eip-4844]] BLOb versioned hashes.

Implementation of

TransactionResponseParams.blobVersionedHashes

blockHash

readonly blockHash: null | string;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:737

The blockHash of the block that this transaction was included in.

This is null for pending transactions.

Implementation of

TransactionResponseParams.blockHash

blockNumber

readonly blockNumber: null | number;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:731

The block number of the block that this transaction was included in.

This is null for pending transactions.

Implementation of

TransactionResponseParams.blockNumber

chainId

readonly chainId: bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:821

The chain ID.

Implementation of

TransactionResponseParams.chainId

data

readonly data: string;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:812

The data.

Implementation of

TransactionResponseParams.data

from

readonly from: string;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:765

The sender of this transaction. It is implicitly computed from the transaction pre-image hash (as the digest) and the [[signature]] using ecrecover.

Implementation of

TransactionResponseParams.from

gasLimit

readonly gasLimit: bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:780

The maximum units of gas this transaction can consume. If execution exceeds this, the entries transaction is reverted and the sender is charged for the full amount, despite not state changes being made.

Implementation of

TransactionResponseParams.gasLimit

gasPrice

readonly gasPrice: bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:793

The gas price can have various values, depending on the network.

In modern networks, for transactions that are included this is the //effective gas price// (the fee per gas that was actually charged), while for transactions that have not been included yet is the [[maxFeePerGas]].

For legacy transactions, or transactions on legacy networks, this is the fee that will be charged per unit of gas the transaction consumes.

Implementation of

TransactionResponseParams.gasPrice

hash

readonly hash: string;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:745

The transaction hash.

Implementation of

TransactionResponseParams.hash

index

readonly index: number;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:741

The index within the block that this transaction resides at.

Implementation of

TransactionResponseParams.index

maxFeePerBlobGas

readonly maxFeePerBlobGas: null | bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:808

The [[link-eip-4844]] max fee per BLOb gas.

Implementation of

TransactionResponseParams.maxFeePerBlobGas

maxFeePerGas

readonly maxFeePerGas: null | bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:804

The maximum fee (per unit of gas) to allow this transaction to charge the sender.

Implementation of

TransactionResponseParams.maxFeePerGas

maxPriorityFeePerGas

readonly maxPriorityFeePerGas: null | bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:799

The maximum priority fee (per unit of gas) to allow a validator to charge the sender. This is inclusive of the [[maxFeeFeePerGas]].

Implementation of

TransactionResponseParams.maxPriorityFeePerGas

nonce

readonly nonce: number;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:774

The nonce, which is used to prevent replay attacks and offer a method to ensure transactions from a given sender are explicitly ordered.

When sending a transaction, this must be equal to the number of transactions ever sent by [[from]].

Implementation of

TransactionResponseParams.nonce

provider

readonly provider: Provider;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:725

The provider this is connected to, which will influence how its methods will resolve its async inspection methods.

signature

readonly signature: Signature;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:825

The signature.

Implementation of

TransactionResponseParams.signature

to

readonly to: null | string;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:759

The receiver of this transaction.

If null, then the transaction is an initcode transaction. This means the result of executing the [[data]] will be deployed as a new contract on chain (assuming it does not revert) and the address may be computed using [[getCreateAddress]].

Implementation of

TransactionResponseParams.to

type

readonly type: number;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:750

The [[link-eip-2718]] transaction envelope type. This is 0 for legacy transactions types.

Implementation of

TransactionResponseParams.type

value

readonly value: bigint;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:817

The value, in wei. Use [[formatEther]] to format this value as ether.

Implementation of

TransactionResponseParams.value

Methods

confirmations()

confirmations(): Promise<number>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:862

Resolve to the number of confirmations this transaction has.

Returns

Promise<number>

getBlock()

getBlock(): Promise<null | Block>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:852

Resolves to the Block that this transaction was included in.

This will return null if the transaction has not been included yet.

Returns

Promise<null | Block>

getTransaction()

getTransaction(): Promise<null | TransactionResponse>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:858

Resolves to this transaction being re-requested from the provider. This can be used if you have an unmined transaction and wish to get an up-to-date populated instance.

Returns

Promise<null | TransactionResponse>

isBerlin()

isBerlin(): this is TransactionResponse & { accessList: AccessList; maxFeePerGas: null; maxPriorityFeePerGas: null };

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:904

Returns true if the transaction is a Berlin (i.e. type == 1) transaction. See [[link-eip-2070]].

This provides a Type Guard that this transaction will have the null-ness for hardfork-specific properties set correctly.

Returns

this is TransactionResponse & { accessList: AccessList; maxFeePerGas: null; maxPriorityFeePerGas: null }

isCancun()

isCancun(): this is TransactionResponse & { accessList: AccessList; blobVersionedHashes: string[]; maxFeePerBlobGas: bigint; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint };

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:925

Returns true if hte transaction is a Cancun (i.e. type == 3) transaction. See [[link-eip-4844]].

Returns

this is TransactionResponse & { accessList: AccessList; blobVersionedHashes: string[]; maxFeePerBlobGas: bigint; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint }

isLegacy()

isLegacy(): this is TransactionResponse & { accessList: null; maxFeePerGas: null; maxPriorityFeePerGas: null };

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:892

Returns true if the transaction is a legacy (i.e. type == 0) transaction.

This provides a Type Guard that this transaction will have the null-ness for hardfork-specific properties set correctly.

Returns

this is TransactionResponse & { accessList: null; maxFeePerGas: null; maxPriorityFeePerGas: null }

isLondon()

isLondon(): this is TransactionResponse & { accessList: AccessList; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint };

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:916

Returns true if the transaction is a London (i.e. type == 2) transaction. See [[link-eip-1559]].

This provides a Type Guard that this transaction will have the null-ness for hardfork-specific properties set correctly.

Returns

this is TransactionResponse & { accessList: AccessList; maxFeePerGas: bigint; maxPriorityFeePerGas: bigint }

isMined()

isMined(): this is MinedTransactionResponse;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:884

Returns true if this transaction has been included.

This is effective only as of the time the TransactionResponse was instantiated. To get up-to-date information, use [[getTransaction]].

This provides a Type Guard that this transaction will have non-null property values for properties that are null for unmined transactions.

Returns

this is MinedTransactionResponse

removedEvent()

removedEvent(): OrphanFilter;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:936

Returns a filter which can be used to listen for orphan events that evict this transaction.

Returns

OrphanFilter

reorderedEvent()

reorderedEvent(other?): OrphanFilter;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:941

Returns a filter which can be used to listen for orphan events that re-order this event against %%other%%.

Parameters

Parameter	Type
`other?`	`TransactionResponse`

Returns

OrphanFilter

replaceableTransaction()

replaceableTransaction(startBlock): TransactionResponse;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:951

Returns a new TransactionResponse instance which has the ability to detect (and throw an error) if the transaction is replaced, which will begin scanning at %%startBlock%%.

This should generally not be used by developers and is intended primarily for internal use. Setting an incorrect %%startBlock%% can have devastating performance consequences if used incorrectly.

Parameters

Parameter	Type
`startBlock`	`number`

Returns

TransactionResponse

toJSON()

toJSON(): any;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:846

Returns a JSON-compatible representation of this transaction.

Returns

any

wait()

wait(_confirms?, _timeout?): Promise<
  | null
| TransactionReceipt>;

Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/providers/provider.d.ts:872

Resolves once this transaction has been mined and has %%confirms%% blocks including it (default: 1) with an optional %%timeout%%.

This can resolve to null only if %%confirms%% is 0 and the transaction has not been mined, otherwise this will wait until enough confirmations have completed.

Parameters

Parameter	Type
`_confirms?`	`number`
`_timeout?`	`number`

Returns

Promise< | null | TransactionReceipt>