viem
Version:
71 lines • 3.22 kB
TypeScript
import type { Client } from '../../clients/createClient.js';
import type { Transport } from '../../clients/transports/createTransport.js';
import { type TransactionNotFoundErrorType } from '../../errors/transaction.js';
import type { ErrorType } from '../../errors/utils.js';
import type { BlockTag } from '../../types/block.js';
import type { Chain } from '../../types/chain.js';
import type { Hash } from '../../types/misc.js';
import type { Prettify } from '../../types/utils.js';
import type { RequestErrorType } from '../../utils/buildRequest.js';
import { type NumberToHexErrorType } from '../../utils/encoding/toHex.js';
import { type FormattedTransaction } from '../../utils/formatters/transaction.js';
export type GetTransactionParameters<blockTag extends BlockTag = 'latest'> = {
/** The block hash */
blockHash: Hash;
blockNumber?: undefined;
blockTag?: undefined;
hash?: undefined;
/** The index of the transaction on the block. */
index: number;
} | {
blockHash?: undefined;
/** The block number */
blockNumber: bigint;
blockTag?: undefined;
hash?: undefined;
/** The index of the transaction on the block. */
index: number;
} | {
blockHash?: undefined;
blockNumber?: undefined;
/** The block tag. */
blockTag: blockTag | BlockTag;
hash?: undefined;
/** The index of the transaction on the block. */
index: number;
} | {
blockHash?: undefined;
blockNumber?: undefined;
blockTag?: undefined;
/** The hash of the transaction. */
hash: Hash;
index?: number | undefined;
};
export type GetTransactionReturnType<chain extends Chain | undefined = undefined, blockTag extends BlockTag = 'latest'> = Prettify<FormattedTransaction<chain, blockTag>>;
export type GetTransactionErrorType = TransactionNotFoundErrorType | NumberToHexErrorType | RequestErrorType | ErrorType;
/**
* Returns information about a [Transaction](https://viem.sh/docs/glossary/terms#transaction) given a hash or block identifier.
*
* - Docs: https://viem.sh/docs/actions/public/getTransaction
* - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions_fetching-transactions
* - JSON-RPC Methods: [`eth_getTransactionByHash`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionByHash)
*
* @param client - Client to use
* @param parameters - {@link GetTransactionParameters}
* @returns The transaction information. {@link GetTransactionReturnType}
*
* @example
* import { createPublicClient, http } from 'viem'
* import { mainnet } from 'viem/chains'
* import { getTransaction } from 'viem/public'
*
* const client = createPublicClient({
* chain: mainnet,
* transport: http(),
* })
* const transaction = await getTransaction(client, {
* hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
* })
*/
export declare function getTransaction<chain extends Chain | undefined, blockTag extends BlockTag = 'latest'>(client: Client<Transport, chain>, { blockHash, blockNumber, blockTag: blockTag_, hash, index, }: GetTransactionParameters<blockTag>): Promise<GetTransactionReturnType<chain, blockTag>>;
//# sourceMappingURL=getTransaction.d.ts.map