viem
Version:
37 lines • 1.75 kB
TypeScript
import type { Address } from 'abitype';
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 { RpcTransaction } from '../../types/rpc.js';
import type { RequestErrorType } from '../../utils/buildRequest.js';
export type GetTxpoolContentReturnType = {
/** Pending transactions in the pool */
pending: Record<Address, Record<string, RpcTransaction>>;
/** Queued transactions in the pool */
queued: Record<Address, Record<string, RpcTransaction>>;
};
export type GetTxpoolContentErrorType = RequestErrorType | ErrorType;
/**
* Returns the details of all transactions currently pending for inclusion in the next block(s), as well as the ones that are being scheduled for future execution only.
*
* - Docs: https://viem.sh/docs/actions/test/getTxpoolContent
*
* @param client - Client to use
* @returns Transaction pool content. {@link GetTxpoolContentReturnType}
*
* @example
* import { createTestClient, http } from 'viem'
* import { foundry } from 'viem/chains'
* import { getTxpoolContent } from 'viem/test'
*
* const client = createTestClient({
* mode: 'anvil',
* chain: 'foundry',
* transport: http(),
* })
* const content = await getTxpoolContent(client)
*/
export declare function getTxpoolContent<chain extends Chain | undefined, account extends Account | undefined>(client: TestClient<TestClientMode, Transport, chain, account, false>): Promise<GetTxpoolContentReturnType>;
//# sourceMappingURL=getTxpoolContent.d.ts.map