viem
Version:
33 lines • 1.46 kB
TypeScript
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 { RequestErrorType } from '../../utils/buildRequest.js';
export type SetIntervalMiningParameters = {
/** The mining interval. */
interval: number;
};
export type SetIntervalMiningErrorType = RequestErrorType | ErrorType;
/**
* Sets the automatic mining interval (in seconds) of blocks. Setting the interval to 0 will disable automatic mining.
*
* - Docs: https://viem.sh/docs/actions/test/setIntervalMining
*
* @param client - Client to use
* @param parameters – {@link SetIntervalMiningParameters}
*
* @example
* import { createTestClient, http } from 'viem'
* import { foundry } from 'viem/chains'
* import { setIntervalMining } from 'viem/test'
*
* const client = createTestClient({
* mode: 'anvil',
* chain: 'foundry',
* transport: http(),
* })
* await setIntervalMining(client, { interval: 5 })
*/
export declare function setIntervalMining<chain extends Chain | undefined, account extends Account | undefined>(client: TestClient<TestClientMode, Transport, chain, account, false>, { interval }: SetIntervalMiningParameters): Promise<void>;
//# sourceMappingURL=setIntervalMining.d.ts.map