viem
Version:
45 lines • 2.48 kB
TypeScript
import type { Client } from '../../clients/createClient.js';
import type { Transport } from '../../clients/transports/createTransport.js';
import type { ErrorType } from '../../errors/utils.js';
import type { Chain } from '../../types/chain.js';
import type { Hash } from '../../types/misc.js';
import type { FormattedTransactionReceipt } from '../../utils/formatters/transactionReceipt.js';
import { type GetBlockNumberErrorType } from './getBlockNumber.js';
import { type GetTransactionErrorType } from './getTransaction.js';
export type GetTransactionConfirmationsParameters<chain extends Chain | undefined = Chain> = {
/** The transaction hash. */
hash: Hash;
transactionReceipt?: undefined;
} | {
hash?: undefined;
/** The transaction receipt. */
transactionReceipt: FormattedTransactionReceipt<chain>;
};
export type GetTransactionConfirmationsReturnType = bigint;
export type GetTransactionConfirmationsErrorType = GetBlockNumberErrorType | GetTransactionErrorType | ErrorType;
/**
* Returns the number of blocks passed (confirmations) since the transaction was processed on a block.
*
* - Docs: https://viem.sh/docs/actions/public/getTransactionConfirmations
* - Example: https://stackblitz.com/github/wevm/viem/tree/main/examples/transactions_fetching-transactions
* - JSON-RPC Methods: [`eth_getTransactionConfirmations`](https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_getTransactionConfirmations)
*
* @param client - Client to use
* @param parameters - {@link GetTransactionConfirmationsParameters}
* @returns The number of blocks passed since the transaction was processed. If confirmations is 0, then the Transaction has not been confirmed & processed yet. {@link GetTransactionConfirmationsReturnType}
*
* @example
* import { createPublicClient, http } from 'viem'
* import { mainnet } from 'viem/chains'
* import { getTransactionConfirmations } from 'viem/public'
*
* const client = createPublicClient({
* chain: mainnet,
* transport: http(),
* })
* const confirmations = await getTransactionConfirmations(client, {
* hash: '0x4ca7ee652d57678f26e887c149ab0735f41de37bcad58c9f6d3ed5824f15b74d',
* })
*/
export declare function getTransactionConfirmations<chain extends Chain | undefined>(client: Client<Transport, chain>, { hash, transactionReceipt }: GetTransactionConfirmationsParameters<chain>): Promise<GetTransactionConfirmationsReturnType>;
//# sourceMappingURL=getTransactionConfirmations.d.ts.map