test-pkg-ngn/dist/keeper/calculateKP3RNetProfitV1.d.ts

A library containing helper functions that facilitate scripting for keepers of the Keep3r Network

import { BigNumber, Contract, providers } from 'ethers';
/**
 * @notice Calculates the net profit in KP3R a keeper would get for working a job registered in Keep3rV1.
 *
 * @dev This function should only be used for mainnet jobs that pay in KP3R or bonded KP3R. The main use of this
 * 		function is to use it after a simulation and before sending the bundles to gauge whether working would be
 * 		profitable or not with that priority fee.
 *
 * @param txHash 			 Hash of the transaction in which the keeper worked the job.
 * @param keep3rHelper       Instance of the keep3rHelper contract.
 * @param provider	         The provider to use to make a call to the keep3rHelper contract.
 *
 * @return The net profit for working a job denominated in KP3R.
 */
export declare const calculateKP3RNetProfitV1: (txHash: string, keep3rHelper: Contract, provider: providers.BaseProvider) => Promise<BigNumber | void>;