You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
1.5 KiB
53 lines
1.5 KiB
import type {
|
|
TestClient,
|
|
TestClientMode,
|
|
} from '../../clients/createTestClient.js'
|
|
import type { Transport } from '../../clients/transports/createTransport.js'
|
|
import type { ErrorType } from '../../errors/utils.js'
|
|
import type { Account } from '../../types/account.js'
|
|
import type { Chain } from '../../types/chain.js'
|
|
import type { Hash } from '../../types/misc.js'
|
|
import type { RequestErrorType } from '../../utils/buildRequest.js'
|
|
|
|
export type DropTransactionParameters = {
|
|
/** The hash of the transaction to drop. */
|
|
hash: Hash
|
|
}
|
|
|
|
export type DropTransactionErrorType = RequestErrorType | ErrorType
|
|
|
|
/**
|
|
* Removes a transaction from the mempool.
|
|
*
|
|
* - Docs: https://viem.sh/docs/actions/test/dropTransaction
|
|
*
|
|
* @param client - Client to use
|
|
* @param parameters - {@link DropTransactionParameters}
|
|
*
|
|
* @example
|
|
* import { createTestClient, http } from 'viem'
|
|
* import { foundry } from 'viem/chains'
|
|
* import { dropTransaction } from 'viem/test'
|
|
*
|
|
* const client = createTestClient({
|
|
* mode: 'anvil',
|
|
* chain: 'foundry',
|
|
* transport: http(),
|
|
* })
|
|
* await dropTransaction(client, {
|
|
* hash: '0xe58dceb6b20b03965bb678e27d141e151d7d4efc2334c2d6a49b9fac523f7364'
|
|
* })
|
|
*/
|
|
export async function dropTransaction<
|
|
chain extends Chain | undefined,
|
|
account extends Account | undefined,
|
|
>(
|
|
client: TestClient<TestClientMode, Transport, chain, account, false>,
|
|
{ hash }: DropTransactionParameters,
|
|
) {
|
|
await client.request({
|
|
method: `${client.mode}_dropTransaction`,
|
|
params: [hash],
|
|
})
|
|
}
|