Returns the transaction receipt for hash or null if the transaction has not been mined.
Don’t have an API key?
Start using this method in your app today.
Description
Returns the transaction receipt for hash or null if the transaction has not been mined.
Parameters
| Name | Type | Description |
|---|---|---|
transactionHash | string | 32 Bytes - Hash of a transaction. |
Response
| Property | Type | Description |
|---|---|---|
Promise<TransactionReceipt | null> | object | A transaction receipt object, or null when no receipt was found |
TransactionReceipt response object parameters
TransactionReceipt response object parameters| Parameter | Type | Description |
|---|---|---|
to | string | 20 Bytes - address of the receiver. null when its a contract creation transaction |
from | string | 20 Bytes - address of the sender |
contractAddress | string | null | 20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null |
transactionIndex | number | The integer of the transactions index position log was created from. null when it's pending log. |
root? | string | 32 bytes of post-transaction stateroot (pre Byzantium) |
gasUsed | object | The amount of gas used by this specific transaction alone. It returns the type: BigNumber , and the hexadecimal representation of the gas used in the hex property. |
logsBloom | string | 256 Bytes - Bloom filter for light clients to quickly retrieve related logs |
transactionHash | string | 32 Bytes - hash of the transaction |
logs | array | Array of log objects, which this transaction generated |
blockNumber | number | The block number where this log was in. null when its pending. null when its pending log. |
confirmations | number | The number of confirmations for the transaction. |
type | number | type. |
status | integer | Either 1 (success) or 0 (failure) |
cummulativeGasUsed | object | A cumulative amount of gas used for the transaction. It returns the type: BigNumber , and the hexadecimal representation of the cumulative gas used in the hex property. |
effectiveGasPrice | number | The gas price. It returns the type: BigNumber , and the hexadecimal representation of the effective gas in the hex property. |
byzantium | boolean | Returns true/false. |
Example Request and Response
Prerequisite: You will need to install the Alchemy SDK before making requests with it.
The commands for installing it using npm or yarn are given below:
npm install alchemy-sdk@latest
yarn add alchemy-sdk@latest
Request
Here is an example of how to make a getTransactionReceipt request using the Alchemy SDK:
// Imports the Alchemy SDK
const { Alchemy, Network } = require("alchemy-sdk");
// Configures the Alchemy SDK
const config = {
apiKey: "alchemy-replit", // Replace with your API key
network: Network.ETH_MAINNET, // Replace with your network
};
// Creates an Alchemy object instance with the config to use for making requests
const alchemy = new Alchemy(config);
const main = async () => {
//Initialize variables for the parameters
const tx = "0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b"
//Call the method to fetch the transaction receipt of the tx
let response = await alchemy.core.getTransactionReceipt(tx)
//Logging the response to the console
console.log(response)
};
main();
Response
{
"to": "0xF02c1c8e6114b1Dbe8937a39260b5b0a374432bB",
"from": "0xa7d9ddBE1f17865597fBD27EC712455208B6B76d",
"contractAddress": null,
"transactionIndex": 65,
"gasUsed": {
"type": "BigNumber",
"hex": "0x53a0"
},
"logsBloom": "0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
"blockHash": "0x1d59ff54b1eb26b013ce3cb5fc9dab3705b415a67127a003c3e61eb445bb8df2",
"transactionHash": "0x88df016429689c079f3b2f6ad39fa052532c56795b733da78a91ebe6a713944b",
"logs": [],
"blockNumber": 6139707,
"confirmations": 11809387,
"cumulativeGasUsed": {
"type": "BigNumber",
"hex": "0x20ec2d"
},
"effectiveGasPrice": {
"type": "BigNumber",
"hex": "0x04a817c800"
},
"status": 1,
"type": 0,
"byzantium": true
}
Code Sandbox
You can test out the getTransactionReceipt method using the code sandbox below:
Use Cases
Here are some potential use cases for the getTransactionReceipt method:
-
Confirming transaction execution: When a transaction is sent on the Ethereum blockchain, it may take some time to process and confirm it. The
getTransactionReceiptmethod can confirm that a transaction has been processed and its status (success or failure). -
Verifying smart contract execution: Smart contracts are self-executing programs that run on the Ethereum blockchain. They can execute transactions and perform various operations on the blockchain. The
getTransactionReceiptmethod can be used to verify that a smart contract has been executed as intended and to check its output. -
Tracking token transactions: Tokens are a type of digital asset that can be traded on the Ethereum blockchain. The
getTransactionReceiptmethod can be used to track token transactions and to verify that they have been executed correctly. -
Auditing blockchain transactions: The transparency and immutability of blockchain transactions make them an ideal platform for auditing purposes. The
getTransactionReceiptmethod can be used to audit transactions and to ensure that they have been executed correctly and securely.
Related Methods
Here are the methods related to getTransactionReceipt:
- getTransactionReceipts: Gets all transaction receipts for a given block by number or block hash.