TransactionReceipt

A TransactionReceipt includes additional information about a transaction that is only available after it has been mined.

Extended by

ContractTransactionReceipt

Implements

TransactionReceiptParams
Iterable<Log>

Properties

Property	Modifier	Type	Description
`#logs`	`private`	readonly `Log`[]	The root hash of this transaction. This is no present and was only included in pre-byzantium blocks, but could be used to validate certain parts of the receipt.
`blockHash`	`readonly`	`string`	The block hash of the Block this transaction was included in.
`blockNumber`	`readonly`	`number`	The block number of the Block this transaction was included in.
`contractAddress`	`readonly`	`null` \| `string`	The address of the contract if the transaction was directly responsible for deploying one. This is non-null only if the `to` is empty and the `data` was successfully executed as initcode.
`cumulativeGasUsed`	`readonly`	`bigint`	The amount of gas used by all transactions within the block for this and all transactions with a lower `index`. This is generally not useful for developers but can be used to validate certain aspects of execution.
`from`	`readonly`	`string`	The sender of the transaction.
`gasPrice`	`readonly`	`bigint`	The actual gas price used during execution. Due to the complexity of EIP-1559 this value can only be caluclated after the transaction has been mined, snce the base fee is protocol-enforced.
`gasUsed`	`readonly`	`bigint`	The actual amount of gas used by this transaction. When creating a transaction, the amount of gas that will be used can only be approximated, but the sender must pay the gas fee for the entire gas limit. After the transaction, the difference is refunded.
`hash`	`readonly`	`string`	The transaction hash.
`index`	`readonly`	`number`	The index of this transaction within the block transactions.
`logsBloom`	`readonly`	`string`	The bloom filter bytes that represent all logs that occurred within this transaction. This is generally not useful for most developers, but can be used to validate the included logs.
`provider`	`readonly`	`Provider`	The provider connected to the log used to fetch additional details if necessary.
`status`	`readonly`	`null` \| `number`	The status of this transaction, indicating success (i.e. `1`) or a revert (i.e. `0`). This is available in post-byzantium blocks, but some backends may backfill this value.
`to`	`readonly`	`null` \| `string`	The address the transaction was sent to.
`type`	`readonly`	`number`	The EIP-2718 transaction type.

Accessors

fee

get fee(): bigint

The total fee for this transaction, in wei.

Returns

bigint

Source

providers/provider.ts:1375

logs

get logs(): readonly Log[]

The logs for this transaction.

Returns

readonly Log[]

Source

providers/provider.ts:1312

Methods

confirmations()

confirmations(): Promise<number>

Resolves to the number of confirmations this transaction has.

Returns

Promise<number> A promise resolving to the number of confirmations.

Throws

If the block is not found.

Source

providers/provider.ts:1426

getBlock()

getBlock(shard): Promise<Block>

Resolves to the block this transaction occurred in.

Parameters

Parameter	Type	Description
`shard`	`Shard`	The shard to fetch the block from.

Returns

Promise<Block> A promise resolving to the block.

Throws

If the block is not found.

Source

providers/provider.ts:1386

getResult()

getResult(): Promise<string>

Resolves to the return value of the execution of this transaction. Support for this feature is limited, as it requires an archive node with the debug_ or trace_ API enabled.

Returns

Promise<string> A promise resolving to the return value of the transaction.

Throws

If the transaction is not found.

Source

providers/provider.ts:1416

getTransaction()

getTransaction(): Promise<TransactionResponse | ExternalTransactionResponse>

Resolves to the transaction this transaction occurred in.

Returns

Promise<TransactionResponse | ExternalTransactionResponse> A promise resolving to the transaction.

Throws

If the transaction is not found.

Source

providers/provider.ts:1400

toJSON()

toJSON(): any

Returns a JSON-compatible representation.

Returns

any

Source

providers/provider.ts:1319

Getting Started

Fundamentals

Reference

Extended by

Implements

Properties

Accessors

fee

Returns

Source

logs

Returns

Source

Methods

confirmations()

Returns

Throws

Source

getBlock()

Parameters

Returns

Throws

Source

getResult()

Returns

Throws

Source

getTransaction()

Returns

Throws

Source

toJSON()

Returns

Source

​Extended by

​Implements

​Properties

​Accessors

​fee

​Returns

​Source

​logs

​Returns

​Source

​Methods

​confirmations()

​Returns

​Throws

​Source

​getBlock()

​Parameters

​Returns

​Throws

​Source

​getResult()

​Returns

​Throws

​Source

​getTransaction()

​Returns

​Throws

​Source

​toJSON()

​Returns

​Source

Extended by

Implements

Properties

Accessors

fee

Returns

Source

logs

Returns

Source

Methods

confirmations()

Returns

Throws

Source

getBlock()

Parameters

Returns

Throws

Source

getResult()

Returns

Throws

Source

getTransaction()

Returns

Throws

Source

toJSON()

Returns

Source