Michael Freno
7c684a42cc
- Consolidated duplicate UndoManagers to single instance - Fixed connection promise to only resolve on 'connected' status - Fixed WebSocketProvider import (WebsocketProvider) - Added proper doc.destroy() cleanup - Renamed isPresenceInitialized property to avoid conflict Co-Authored-By: Paperclip <noreply@paperclip.ing>
80 lines
2.9 KiB
TypeScript
80 lines
2.9 KiB
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 { getAction } from '../../utils/getAction.js'
|
|
|
|
import {
|
|
type GetBlockNumberErrorType,
|
|
getBlockNumber,
|
|
} from './getBlockNumber.js'
|
|
import {
|
|
type GetTransactionErrorType,
|
|
getTransaction,
|
|
} 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 async function getTransactionConfirmations<
|
|
chain extends Chain | undefined,
|
|
>(
|
|
client: Client<Transport, chain>,
|
|
{ hash, transactionReceipt }: GetTransactionConfirmationsParameters<chain>,
|
|
): Promise<GetTransactionConfirmationsReturnType> {
|
|
const [blockNumber, transaction] = await Promise.all([
|
|
getAction(client, getBlockNumber, 'getBlockNumber')({}),
|
|
hash
|
|
? getAction(client, getTransaction, 'getTransaction')({ hash })
|
|
: undefined,
|
|
])
|
|
const transactionBlockNumber =
|
|
transactionReceipt?.blockNumber || transaction?.blockNumber
|
|
if (!transactionBlockNumber) return 0n
|
|
return blockNumber - transactionBlockNumber! + 1n
|
|
}
|